Transformation functions — interpolation & spatial
This page is the generated field list for the interpolation & spatial
transformation functions — filling gaps along the time axis
(interpolationSerial), moving values across locations or onto a grid
(interpolationSpatial), elevation-based adjustments (altitude), vector
rotation between coordinate systems (rotation), and computing a value from
location attributes (multipleLocationAttributes). Part of the
transformation function catalogue;
see that page for the shared <transformationModule>/<transformation>
mechanics these all sit inside.
At a glance
Section titled “At a glance”Covers
: interpolationSerial (gap-fill/extrapolate one series in time),
interpolationSpatial (20 methods — average, inverse distance, kriging,
Thiessen polygon, triangulation, and more — moving values across locations or
onto/off a grid), altitude (elevation lapse, zero-degree altitude, dry-cell
removal), rotation (rotate u/v vectors between a rotated-pole grid and
WGS 1984), multipleLocationAttributes (regression/threshold calculations
driven by location attributes).
Used inside
: A <transformation>, <periodTransformation>, or <rangeTransformation>
in a transformationModule file.
Related
: Transformations task guide’s worked example uses
interpolationSerial → linear.
Minimal example
Section titled “Minimal example”<?xml version="1.0" encoding="UTF-8"?><transformationModule xmlns="http://www.wldelft.nl/fews" version="1.0"> <transformation id="FillGapsQobs"> <interpolationSerial> <linear> <inputVariable> <timeSeriesSet> <moduleInstanceId>ImportObservations</moduleInstanceId> <valueType>scalar</valueType> <parameterId>Q.obs</parameterId> <locationId>RiverGauge_01</locationId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="hour" multiplier="1"/> <readWriteMode>read only</readWriteMode> </timeSeriesSet> </inputVariable> <maxGapLength>6</maxGapLength> <outputVariable> <timeSeriesSet> <moduleInstanceId>PreProcessObservations</moduleInstanceId> <valueType>scalar</valueType> <parameterId>Q.obs</parameterId> <locationId>RiverGauge_01</locationId> <timeSeriesType>simulated historical</timeSeriesType> <timeStep unit="hour" multiplier="1"/> <readWriteMode>add originals</readWriteMode> </timeSeriesSet> </outputVariable> </linear> </interpolationSerial> </transformation></transformationModule>This is the same example worked through in the Transformations task guide — this page is its field-level companion.
Field reference
Section titled “Field reference”Auto-generated from transformationTypes.xsd. Descriptions are the schema's own annotations.
Function <interpolationSerial>
| Element | Type | Cardinality | Description |
|---|---|---|---|
block | InterpolationSerialBlockComplexType | required | Fills gaps in a time series. Each gap is filled with data values that are equal to the last data value before the gap. |
default | InterpolationSerialDefaultComplexType | required | Fills gaps in a time series with a default value |
directionLinear | InterpolationSerialDirectionLinearComplexType | required | Fills gaps in a time series that contains direction data values (e.g. wind direction), using linear interpolation. The direction values are interpolated over the smallest angle, e.g. halfway between directions 0 degrees and 350 degrees the interpolated value would be 355 degrees. For a gap between two directions that are completely opposite (e.g. 90 and 270 degrees) the interpolated values will be equal to the last known direction. |
extrapolateBase | InterpolationSerialExtrapolateBaseComplexType | required | Extrapolates by adding future values that start at the last data value and linearly approach a given base value. |
extrapolateConstant | InterpolationSerialExtrapolateConstantComplexType | required | Extrapolates by filling the gap between the start of the input time series and the first data value or by filling the gap between the last data value and the end of the input time series or by filling both of these gaps. |
extrapolateExponential | InterpolationSerialExtrapolateExponentialComplexType | required | Extrapolates by adding future values that start at the last data value and exponentially approach a given base value. |
extrapolatePatternWithSmoothing | InterpolationSerialExtrapolatePatternWithSmoothingComplexType | required | Extrapolates by repeating the values in the matching period. The matching period ends at the last non-missing value in the view period. The values in the matching period are referred to as the pattern. This pattern is repeated for the length of the view period. Smoothing is applied on each repetition of the pattern by adding (part of) the difference between the first and last value of the pattern. This linearly declines to zero for the length of the smoothingPeriod. Example: matchingPeriod = 8, Pattern = [4,5,5,5,8,6,7,8], smoothingPeriod = 4 would result in [8,8,7,6,8,6,7,8] |
linear | InterpolationSerialLinearComplexType | required | Fills gaps in a time series with linearly interpolated data values. |
longitudinalProfileToTrack | InterpolationSerialLongitudinalProfileToTrackComplexType | required | Since 2017.02. Extracts scalar time series for a track layer from a longitudinal profile using lat, long scalar input series. |
trackToGrid | InterpolationSerialTrackToGridComplexType | required | Since 2017.02. Extract grid time series from a track layer (given by scalar lat, lon and value input series). |
persistenceTrend | PersistenceTrendComplexType | required | Available since 2019.01 |
Function <interpolationSpatial>
| Element | Type | Cardinality | Description |
|---|---|---|---|
average | InterpolationSpatialAverageComplexType | required | calculates the average for each area in the output geometry |
bilinear | InterpolationSpatialBilinearComplexType | required | calculates the output value by using bilinear interpolation from a rectangular grid to any other grid, profile or scalars. Can be used to rescale or reproject a grid |
closestDistance | InterpolationSpatialClosestDistanceComplexType | required | interpolates by searching the closest location |
gridToPolygons | InterpolationSpatialGridToPolygonsComplexType | required | Converts a regular grid to contour polygons. |
containingPolygon | InterpolationSpatialContainingPolygonComplexType | required | For each input polygon this transformation copies the value of the input polygon to all output points that are inside the input polygon. If an output point is not contained in any input polygon, then the output is a missing value. |
inputAverageTimesOutputArea | InterpolationSpatialInputAverageTimesOutputAreaComplexType | required | Calculates the weighted average of input variables and multiplies the output with the output area |
inverseDistance | InterpolationSpatialInverseDistanceComplexType | required | With this interpolation option a new value will be computed out of existing values of neighbouring points using the power of inverse distance procedure. |
polygonRelatedLocations | InterpolationSpatialPolygonRelatedLocationsComplexType | required | A intermediate polygon and a location relation is used to find the locations in the input variable. An output location is first mapped to an intermediate polygon. A location relation is used to map the intermediate polygon to one or more locations in the input variable. An inverse distance is applied to all related locations |
kriging | InterpolationSpatialKrigingComplexType | required | With this interpolation option a new value will be computed out of existing values of neighbouring points using the normal Kriging procedure. |
max | InterpolationSpatialMaximumComplexType | required | calculates the maximum for each area in the output geometry |
min | InterpolationSpatialMinimumComplexType | required | calculates the minimum for each area in the output geometry |
sum | InterpolationSpatialSumComplexType | required | calculates the sum for each area in the output geometry |
count | InterpolationSpatialCountComplexType | required | Counts the number of stations/cell with a non missing value for each area in the output geometry. Optionally it is possible to skip cells/stations outside a specified value range |
percentile | InterpolationSpatialPercentileComplexType | required | Count the percentile for stations/cell with a non missing value for each area in the output geometry. Optionally it is possible to skip cells/stations outside a specified value range |
thiessenPolygon | InterpolationSpatialThiessenPolygonComplexType | required | First creates a Thiessen net from the input locations, then averages this over the region inside a polygon. |
triangulation | InterpolationSpatialTriangulationComplexType | required | Renka and Cline triangulation. |
verticalProfileClosestDistance | InterpolationSpatialVerticalProfileClosestDistanceComplexType | required | Converts 2d grids to vertical profiles. Input: one or more horizontal 2D grid time series (layers), that together form one 3D grid time series. Output: one or more vertical profile time series. For each output vertical profile time series the x,y coordinates of its configured location are used to slice the input 3D grid time series to create a vertical profile. For each output x,y coordinate the corresponding values in the input grids are found using closestDistance interpolation within the specified searchRadius (optional). The z-coordinates of the values in the output vertical profiles are the same as the z-coordinates of the input grid layers. |
weighted | InterpolationSpatialWeightedComplexType | required | Calculates the weighted average of the input values. The weights are re-scaled so that the total weight becomes 1. If for a given time an input variable has a missing value, then for that time that input variable is ignored and the weights of the other input variables are re-scaled so that the total weight becomes 1. |
linearChainage | InterpolationSpatialLinearChainageComplexType | required | With this method you can copy (a part of) a longitudinal profile to another profile also when the destination profile contains more or less points. For points that are not available in the input profile a linear chainage interpolation is used between the two closest point in the input profile that are available. |
snapTrackToLocations | InterpolationSpatialSnapTrackToLocationsComplexType | required | Converts a track to multiple scalar time series. A maximum snap distance can be configured. The closest track point within a time step of the output time series is used. |
riemannBoundary | InterpolationSpatialRiemannBoundaryComplexType | required | Since 2017.02. Performs the Riemann boundary calculation to convert scalar time series on coarse grid locations to scalar time series on boundary locations of a fine grid. |
Function <altitude>
| Element | Type | Cardinality | Description |
|---|---|---|---|
elevationLapse | AltitudeElevationLapseComplexType | required | Calculates the temperature at the output location, using the temperature at the input location, the difference in elevation between the input and output location and a temperature lapse rate. This transformation uses the following equation. outputTemperature = inputTemperature + (inputElevation - outputElevation) * temperatureLapseRate / 100. Here the temperatureLapseRate is in degrees per 100 meters of elevation (typically 0.6 degrees Celcius per 100 meters). |
zeroDegreeAltitude | AltitudeZeroDegreeAltitudeComplexType | required | Calculates the altitude where the temperature is zero degrees. Assumes that the temperature is lower at higher altitude. Uses the heights defined for the locations in the input time series. |
removeDryCells | RemoveDryCellsComplexType | required | Since 2017.01 Replace values with NaN where water level is not higher that Z |
Function <rotation>
| Element | Type | Cardinality | Description |
|---|---|---|---|
uvVectorsFromRotatedPoleToWgs1984 | RotationUVVectorsFromRotatedPoleToWgs1984ComplexType | required | Transformation to rotate u,v vectors (velocity data) to another coordinate system. This transforms each vector's u,v components in a rotated pole geoDatum to the corresponding u,v components in the Wgs1984 geoDatum (the vector itself is not changed). The input and output time series should have the same rotated pole geometry as grid definition (which is defined in the grids.xml configuration file). |
Function <multipleLocationAttributes>
| Element | Type | Cardinality | Description |
|---|---|---|---|
multipleIinearRegression | MultipleLinearRegressionComplexType | required | Since 2019.01 Calculate an output value by using multiple linear regression. The factors and constant are provided by location attributes |
multipleVariateThresholds | MultiVariateThresholdsComplexType | required | Since 2019.01 Calculate the threshold level by defining threshold boundaries by using location attributes |
inputLocationSetsBasedMultivariateThresholds | InputLocationSetsBasedMultivariateThresholdsComplexType | required | Since 2019.02 Calculate the threshold level by defining threshold lower boundaries based on location attributes of input locations within location sets |
multipleOutputLocationThresholds | MultipleOutputLocationThresholdsComplexType | required | Since 2023.01 Write a configured value to the output time series if any of the input time series has a treshold crossed for the output location |
InterpolationSerialBlockComplexType
Fills gaps in a time series with the last value before the start of the gap
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable. |
maxGapLength | positiveIntegerAttributeType | optional | Optional maximum length of gap in number of time steps. Gaps equal to or smaller than maxGapLength will be filled with interpolated values. Gaps larger than maxGapLength will not be filled. If maxGapLength is not defined, then all gaps will be filled with interpolated values. |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
outputComment | nonEmptyStringType | optional | Since 2015.01. Optional (optional since stable build 2015.01). If specified, this comment will be put in the output time series for the time steps for which this relation is used to determine the output value. |
InterpolationSerialDefaultComplexType
Fills gaps in a time series with linearly interpolated data values.
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable. |
maxGapLength | positiveIntegerAttributeType | optional | Optional maximum length of gap in number of time steps. Gaps equal to or smaller than maxGapLength will be filled with interpolated values. Gaps larger than maxGapLength will not be filled. If maxGapLength is not defined, then all gaps will be filled with interpolated values. |
extrapolateDirection | extrapolateDirectionEnumStringType | optional |
One of: none, start, end, both |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
outputComment | nonEmptyStringType | optional | Optional (optional since stable build 2015.01). If specified, this comment will be put in the output time series for the time steps for which this relation is used to determine the output value. |
defaultValue | floatStringType | required | Optional default value. If not defined, then uses 0 by default. |
defaultValueFunction | string | required | Optional location dependent default value function that contains location attribute ids, e.g. @DEFAULT_VALUE@. If an attribute is missing for a location, then the default value will be 0 by default for that location. |
InterpolationSerialDirectionLinearComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable. |
directionRange | InterpolationSerialDirectionLinearDirectionRangeComplexType | required | The range of the values in the input and output time series. For degrees this range could be e.g. 0 to 360 or e.g. -180 to 180. For radians this range could be e.g. 0 to 2*PI. Input values outside the specified range will be handled like missing values (gaps). |
maxGapLength | positiveIntegerAttributeType | optional | Optional maximum length of gap in number of time steps. Gaps equal to or smaller than maxGapLength will be filled with interpolated values. Gaps larger than maxGapLength will not be filled. If maxGapLength is not defined, then all gaps will be filled with interpolated values. |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
outputComment | nonEmptyStringType | optional | Since 2015.01. Optional (optional since stable build 2015.01). If specified, this comment will be put in the output time series for the time steps for which this relation is used to determine the output value. |
InterpolationSerialExtrapolateBaseComplexType
Extrapolates by adding future values that start at the last data value and linearly approach a given base value.
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable. |
maxGapLength | positiveInteger | optional | Optional maximum length of gap in number of time steps. Gaps equal to or smaller than maxGapLength will be filled with interpolated values. Gaps larger than maxGapLength will not be filled. If maxGapLength is not defined, then all gaps will be filled with interpolated values. |
baseValue | float | required | |
window | TimeSpanComplexType | required | |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
outputComment | nonEmptyStringType | optional | Since 2015.01. Optional (optional since stable build 2015.01). If specified, this comment will be put in the output time series for the time steps for which this relation is used to determine the output value. |
InterpolationSerialExtrapolateConstantComplexType
Extrapolates by filling the gap between the start of the input time series and the first data value or by filling the gap between the last data value and the end of the input time series or by filling both of these gaps.
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable. |
extrapolateDirection | interpolationSerialExtrapolateConstantDirectionEnumStringType | required | If direction is start, then fills only the gap between the start of the input time series and the first data value, with values that are equal to the first data value. If direction is end, then fills only the gap between the last data value and the end of the input time series, with values that are equal to the last data value. If direction is both, then fills both of these gaps.
One of: start, end, both |
maxGapLength | positiveIntegerAttributeType | optional | Optional maximum length of the gap at the start or end of the time series, in number of time steps. If the gap is larger than maxGapLength, then it will not be filled. If maxGapLength is not defined, then the gap will always be filled. |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
outputComment | nonEmptyStringType | optional | Since 2015.01. Optional (optional since stable build 2015.01). If specified, this comment will be put in the output time series for the time steps for which this relation is used to determine the output value. |
InterpolationSerialExtrapolateExponentialComplexType
Extrapolates by filling the gap between the start of the input time series and the first data value or by filling the gap between the last data value and the end of the input time series or by filling both of these gaps.
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable. |
extrapolateDirection | interpolationSerialExtrapolateConstantDirectionEnumStringType | required | If direction is start, then fills only the gap between the start of the input time series and the first data value, with values that are equal to the first data value. If direction is end, then fills only the gap between the last data value and the end of the input time series, with values that are equal to the last data value. If direction is both, then fills both of these gaps.
One of: start, end, both |
baseValue | float | required | |
recessionConstant | recessionConstantSimpleType | required | |
maxGapLength | positiveIntegerAttributeType | optional | Optional maximum length of gap in number of time steps. Gaps equal to or smaller than maxGapLength will be filled with interpolated values. Gaps larger than maxGapLength will not be filled. If maxGapLength is not defined, then all gaps will be filled with interpolated values. |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
outputComment | nonEmptyStringType | optional | Since 2015.01. Optional (optional since stable build 2015.01). If specified, this comment will be put in the output time series for the time steps for which this relation is used to determine the output value. |
InterpolationSerialExtrapolatePatternWithSmoothingComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable. |
matchingPeriod | TimeSpanComplexType | required | Period leading up to the last non-missing value. The values in the period are used for the pattern that is repeated. |
smoothingPeriod | TimeSpanComplexType | required | The length over which the smoothing is applied. In general, this period should be shorter then the matchingPeriod. |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
outputComment | nonEmptyStringType | optional | Since 2015.01. Optional (optional since stable build 2015.01). If specified, this comment will be put in the output time series for the time steps for which this relation is used to determine the output value. |
InterpolationSerialLinearComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable. |
maxGapLength | positiveIntegerAttributeType | optional | Optional maximum length of gap in number of time steps. Gaps equal to or smaller than maxGapLength will be filled with interpolated values. Gaps larger than maxGapLength will not be filled. If maxGapLength is not defined, then all gaps will be filled with interpolated values, however if the interpolateMissingGridCells option is enabled, a default value of 1 is applied to prevent the system from running out of memory on large time series. |
interpolateMissingGridCells | boolean | optional | For a timeseries of grid coverages, this option will allow missing grid cells in each coverage to be interpolated. (default is false) |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
outputComment | nonEmptyStringType | optional | Since 2015.01. Optional (optional since stable build 2015.01). If specified, this comment will be put in the output time series for the time steps for which this relation is used to determine the output value. |
outputCustomFlagSourceId | idStringType | optional | Since 2015.02. Optional. If specified, the customFlagSource will be put in the output time series for the time steps for which this relation is used. |
InterpolationSerialLongitudinalProfileToTrackComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputLongitudinalProfile | InputVariableComplexType | required | Input variable with single longitudinal profile time series. |
inputTrackX | InputVariableComplexType | required | Input variable with single scalar time series for the x coordinate |
inputTrackY | InputVariableComplexType | required | Input variable with single scalar time series for the y coordinate |
maxDistance | positiveDoubleStringType | optional | The maximum distance (in meter) allowed between points, if no longitudinal profile point is close enough, the output will be NaN. |
minMissingStepsForRecalibration | nonNegativeIntegerStringType | optional | If (one of) the track coordinates is missing (NaN) for at least this number of points in a row, the next non-missing point is compared with all of the longitudinal profile points to find the closest distance, instead of just comparing with the previously closest longitudinal profile point and its direct neighbours. By default this value is set to 1. Note that setting this value to 0 will cause FEWS to always compare the track point with all longitudinal profile points. |
outputVariable | OutputVariableComplexType | required | Output scalar time series, which will contain the values for the track. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSerialTrackToGridComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputTrackValue | InputVariableComplexType | required | Input variable with single scalar time series containing the track value. |
inputTrackX | InputVariableComplexType | required | Input variable with single scalar time series for the x coordinate of the track (WGS 1984). |
inputTrackY | InputVariableComplexType | required | Input variable with single scalar time series for the y coordinate of the track (WGS 1984). |
minTrackValues | positiveIntegerStringType | optional | The minimum number of track values that must be available for a grid cell and time step (BEFORE the percentileRange is applied if configured) for the result value to be non-missing. Default 1. |
percentileRange | percentileRangeComplexType | optional | From all track points that correspond to a certain grid cell and time step only this percentile range of values will be used to obtain the grid value. |
statisticalFunction | InterpolationSerialTrackToGridStatisticalFunctionType | required | The statistical function that will be applied to obtain a single value for the grid cell from all track values found for that grid cell.
One of: min, max |
outputVariable | OutputVariableComplexType | required | Output grid time series. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
PersistenceTrendComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputTimeSeries | InputVariableComplexType | required | a |
outputTimeSeries | OutputVariableComplexType | required | a |
outputHistoricTimeSeries | OutputVariableComplexType | optional | a |
availableObservedValues | float | required | |
consecutiveObservedValues | boolean | required | |
window | TimeSpanComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialAverageComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
minimumValue | float | optional | Minimum value allowed, if not used then -999.99 |
maximumValue | float | optional | Minimum value allowed, if not used then -999.99 |
inputVariable | InputVariableComplexType | required | |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
validationRule | ValidationRuleComplexType | optional · repeats | Since 2013.01. FEWS-8586 |
InterpolationSpatialBilinearComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input regular grid, Input variable should be different than output variable. |
outputGeometry | OutputGeometryComplexType | optional | Since 2017.02. Output grid which overrules the configured grid in the output variable |
overrulingXAttribute | string | optional | Since 2020.01. Id of the attribute which is to be used as the overruling x-coordinate for each location for both the input and output variables. When a location does not have this attribute, or does not have a value for this attribute, its x-coordinate is used as usual. |
overrulingYAttribute | string | optional | Since 2020.01. Id of the attribute which is to be used as the overruling y-coordinate for each location for both the input and output variables. When a location does not have this attribute, or does not have a value for this attribute, its y-coordinate is used as usual. |
outputVariable | OutputVariableComplexType | required | Output grid, longitudinal profile or scalars. Input variable should be different than output variable |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialClosestDistanceComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required · repeats | One or more input variables as input for the interpolation function |
minimumValue | float | optional | Minimum value allowed, if not used then -999.99 |
maximumValue | float | optional | Maximum value allowed, if not used then -999.99 |
searchRadius | doubleStringType | optional | meters. Default = Infinity. BEFORE 2012.02 this value was interpreted as kilometers by accident |
distanceGeoDatum | geoDatumStringType | optional | Geo datum used to calculate the distances in meters between the points. To calculate distances efficiently and to pre-sort the input points in a grid the earth's curved surface should be transformed to a flat two-dimensional surface. When the input geometry is not in meters calculation of distances will be very slow and a search all is required when there is no exact match. When there is no region/country specific coordinate system available choose a utm zone that best fits with your output region. http://en.wikipedia.org/wiki/File:Utm-zones.jpg. eg. UTM55S for Victoria state in Australia. Only use zone number and N for northern hemisphere and S for southern hemisphere. |
overrulingXAttribute | string | optional | Since 2017.02. Id of the attribute which is to be used as the overruling x-coordinate for each location for both the input and output variables. When a location does not have this attribute, or does not have a value for this attribute, its x-coordinate is used as ususal. |
overrulingYAttribute | string | optional | Since 2017.02. Id of the attribute which is to be used as the overruling y-coordinate for each location for both the input and output variables. When a location does not have this attribute, or does not have a value for this attribute, its y-coordinate is used as ususal. |
outputVariable | OutputVariableComplexType | required | output variable |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
validationRule | ValidationRuleComplexType | optional · repeats | Since 2013.01. FEWS-8586 |
InterpolationSpatialGridToPolygonsComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable with single rectangular grid. |
polygonValue | float | required · repeats | For every value a (multi-part) polygon is created.The values of the grid cells inside this polygon are equal or larger than the specified value. They are also smaller than the next polygonValue when configured |
areaOfInterestLocationId | idStringType | optional | Only generate polygons inside the area/polygon/catchment of the specified location |
minimumPolygonArea | nonNegativeDouble | optional | Since 2024.01. Optional. Minimum area (in square meters) of features in the output polygon. Polygons, or holes in polygons, that are smaller than the configured area are removed from the output polygon. |
outputVariable | OutputVariableComplexType | required | Output variable with polygon time series |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
localDatumCoverageTileArchiveFile | string | required · repeats | A FULL ABSOLUTE path to file (.cta). Multiple files can be specified. When the file is uploaded by the config manager split the cta file into multiple cta files of about 10MB. This can be specified when converting an asc grid to cta. The grid values are converted to local datums at pixel level using the DEM layer before calculating the polygons |
zoomLevel | zoomLevelStringType | required | The zoom level that should be used. The higher the zoom level memory the higher the memory that is required. 100km by 100km for the highest zoom level requires 20 GB of memory. For every higher zoom level the required memory is four times less. See https://wiki.openstreetmap.org/wiki/Zoom_levels |
InterpolationSpatialContainingPolygonComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable with data for polygons. |
outputVariable | OutputVariableComplexType | required | Output variable to store data for point locations. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialInputAverageTimesOutputAreaComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Define input variables with a weight for each input variable. |
minimumValue | float | optional | Minimum value allowed, if not used then -999.99 |
maximumValue | float | optional | Maximum value allowed, if not used then -999.99 |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialInverseDistanceComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required · repeats | One or more input variables |
outputGeometry | OutputGeometryComplexType | optional | Since 2017.02. Output grid which overrules the configured grid in the output variable |
minimumValue | float | optional | Minimum value allowed, if not used then -999.99 |
maximumValue | float | optional | Maximum value allowed, if not used then -999.99 |
searchRadius | doubleStringType | required | Meters. Default = Infinity. Specifying the search radius increases the performance since it limits the candidate points to be evaluated. Otherwise all possible points are considered. The searchRadius criterion is applied before the normalization with xMultiplier, yMultiplier and zMultiplier. BEFORE 2012.02 this value was interpreted as kilometers for WGS 84 by accident |
distanceGeoDatum | geoDatumStringType | optional | Geo Datum used to calculate the distances in meters between the points. When the input geometry is not in meters calculation of distances will be very slow and a search all is required when there is no exact match |
inverseDistancePower | float | required | |
xMultiplier | double | optional | since 2012.02. |
yMultiplier | double | optional | since 2012.02. |
zMultiplier | double | optional | since 2012.02. |
excludePointOfOrigin | boolean | optional | Optional element allows to exclude the point of origin in the inverse-distance spatial interpolation transformation. Available since 2018.02 |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
includeMissingValues | boolean | required | If true, then a missing value in one of the input variables for a given time step will result in a missing value in the output variable. If false, then if a value in one of the input variables is missing for a given time step, then only the remaining input variables will be used and the weights will be rescaled to unity. |
validationRule | ValidationRuleComplexType | optional · repeats | Since 2013.01. FEWS-8586 |
numberOfPoints | int | required | Number of points used in interpolation computation. When distance function is used the closest number of points is used. Default is 8 points. |
numberOfBackupPoints | int | optional | since 2012.02. Extra stations that are further away and are used in case of one or more missings in the base points. For every missing support point an other next nearest backup point is used |
numberOfPointsPerQuadrant | int | required | since 2012.02. Number of points used in interpolation computation. When distance function is used the closest number of points is used.. |
numberOfBackupPointsPerQuadrant | int | optional | since 2012.02. Extra stations that are further away and are used in case of one or more missings in the base points. For every missing support point an other next nearest backup point is used |
InterpolationSpatialPolygonRelatedLocationsComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required · repeats | Scalar |
polygonLocationSetId | idStringType | required | Polygons to find the input locations. Input locations are the related locations of the polygon that contains the output location |
polygonLocationRelationId | idStringType | required | Location relation to find the input locations. Input locations are the related locations of the polygon that contains the output location. The relation is used to find the polygon id to the location ids in the input variable |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
includeMissingValues | boolean | required | If true, then a missing value in one of the input variables for a given time step will result in a missing value in the output variable. If false, then if a value in one of the input variables is missing for a given time step, then only the remaining input variables will be used and the weights will be rescaled to unity. |
validationRule | ValidationRuleComplexType | optional · repeats | Since 2013.01. FEWS-8586 |
InterpolationSpatialKrigingComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable |
interpolationType | interpolationEnumStringType | required | Option to choose between the filling of missing values or the generation of new series.
One of: seriesfilling, seriesgeneration |
valueOption | valuesEnumStringType | required |
One of: normal, residuals, splitwithelevation |
variogram | VariogramComplexType | required | Variogram information |
numberOfPoints | int | optional | Number of points used in interpolation computation. When distance function is used the closest number of points is used. If not specified then 8 points are used. Default is 8 points. |
regressionElevation | float | optional | Elevation above which regression is required |
minimumValue | float | optional | Minimum value allowed, if not used then -999.99 |
distanceParameters | DistanceGeographicComplexType | optional | Coefficients G1 to G4 of function DistanceGeographic. Defaults to (1,1,0,0) |
debug | DebugComplexType | optional | Debug information for interpolation model |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialMaximumComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
validationRule | ValidationRuleComplexType | optional · repeats | Since 2013.01. FEWS-8586 |
InterpolationSpatialMinimumComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
validationRule | ValidationRuleComplexType | optional · repeats | Since 2013.01. FEWS-8586 |
InterpolationSpatialSumComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | One or more input variables |
minimumValue | float | optional | Minimum value allowed, if not used then -999.99 |
maximumValue | float | optional | Minimum value allowed, if not used then -999.99 |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
validationRule | ValidationRuleComplexType | optional · repeats | Since 2013.01. FEWS-8586 |
InterpolationSpatialCountComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | One or more input variables |
minimumInputValue | float | optional | Skip all input values that are below this value |
maximumInputValue | float | optional | Skip all input values that are above this value |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialPercentileComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | One or more input variables |
percentile | percentageType | required | between 1 and 99 |
minimumInputValue | float | optional | Skip all input values that are below this value |
maximumInputValue | float | optional | Skip all input values that are above this value |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialThiessenPolygonComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable with data for point locations. |
distanceGeoDatum | geoDatumStringType | optional | Geo datum used to calculate the distances in meters between the points. To calculate distances efficiently and to pre-sort the input points in a grid the earth's curved surface should be transformed to a flat two-dimensional surface. When the input geometry is not in meters calculation of distances will be very slow and a search all is required when there is no exact match. When there is no region/country specific coordinate system available choose a utm zone that best fits with your output region. http://en.wikipedia.org/wiki/File:Utm-zones.jpg. eg. UTM55S for Victoria state in Australia. Only use zone number and N for northern hemisphere and S for southern hemisphere |
outputVariable | OutputVariableComplexType | required | Output variable to store data for polygons. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialTriangulationComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable |
interpolationType | interpolationEnumStringType | required | Option to choose between the filling of missing values or the generation of new series.
One of: seriesfilling, seriesgeneration |
numberOfPoints | int | required | Number of points used in interpolation computation. When distance function is used the closest number of points is used. If not specified then 8 points are used. Default is 8 points. |
minimumValue | float | optional | Minimum value allowed, if not used then -999.99 |
debug | DebugComplexType | optional | Debug information for interpolation model |
extrapolationOption | spatialExtrapolationOptionEnumStringType | required |
One of: disabled, use splines, nearest neighbour |
coordinateScalingFactor | float | required | The coordinates are multiplied by the scaling factor before they are passed to a interpolation routine. This is especially useful for for the renka and cline triangulation in combination with splines. To calculate the splines correctly the z values should have the same scale as the x, y values. |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialVerticalProfileClosestDistanceComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | One or more horizontal 2D grid time series (layers) (in a locationSet), that together form one 3D grid time series. All input grid time series must have the same grid geometry. |
searchRadius | doubleStringType | optional | Optional search radius in meters for closest distance interpolation. Default is infinity. |
distanceGeoDatum | geoDatumStringType | optional | Geo datum used to calculate the distances in meters between the points. To calculate distances efficiently and to pre-sort the input points in a grid the earth's curved surface should be transformed to a flat two-dimensional surface. When the input geometry is not in meters calculation of distances will be very slow and a search all is required when there is no exact match. When there is no region/country specific coordinate system available choose a utm zone that best fits with your output region. http://en.wikipedia.org/wiki/File:Utm-zones.jpg. eg. UTM55S for Victoria state in Australia. Only use zone number and N for northern hemisphere and S for southern hemisphere. |
outputVariable | OutputVariableComplexType | required | One or more vertical profile time series (in a locationSet). The output must have a single domain parameter that indicates the height along the vertical profile. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialWeightedComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
minInputValuesRequired | positiveInteger | optional | This is the minimum number of input variables that should have a non-missing value for the calculation. If for a given time the number of input variables that have a non-missing value is less than the configured minimum, then for that time the output value will be a missing value. This can be used e.g. to avoid getting output values of calculations for which very few input variables are available, because such calculations would be inaccurate. If not specified, then this will be set to 1. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
weightedInputVariable | InterpolationSpatialWeightedInputVariableComplexType | required · repeats | One or more input variables with weights. Must be used in combination with an outputVariable element (not an attributedOutputVariable element). |
inputVariable | InputVariableComplexType | required | Since 2017.02. A single input variable containing all time series that may be used to obtain the weighted average for an output location. Must be used in combination with an attributedOutputVariable element. |
outputVariable | OutputVariableComplexType | required | Weighted average. Must be used in combination with one or more weightedInputVariable elements. |
attributedOutputVariable | InterpolationSpatialAttributedOutputVariableComplexType | required | Since 2017.02. An output variable containing two multi-value attributed containing the locationIds and weights for the inputs to be used. Must be used in combination with a single inputVariable element (not a weightedInputVariable element). |
InterpolationSpatialLinearChainageComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input profile. |
outputVariable | OutputVariableComplexType | required | Output profile |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialSnapTrackToLocationsComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
x | InputVariableComplexType | required | Input variable with single scalar time series for the x coordinate |
y | InputVariableComplexType | required | Input variable with single scalar time series for the y coordinate |
value | InputVariableComplexType | required | Input variable with single scalar time series for the values. |
geoDatum | geoDatumStringType | required | geo datum of the x and y coordinate in the time series |
maximumSnapDistance | doubleStringType | required | meters, Maximum distance between output location and track point to allow snap. BEFORE 2012.02 this value was interpreted as kilometers by accident |
minimumTimeInterval | TimeSpanComplexType | required | Tack point closest to output point within time interval is used in output time series |
outputVariable | OutputVariableComplexType | required | Output time series. Every output time series should have an unique location |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InterpolationSpatialRiemannBoundaryComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
waterHeight | InputVariableComplexType | required | The water height input variable, scalar time series for a location set consisting of locations in a coarse grid. Note that all locations named vai coarseGridLocationAttributeId (and uCoarseGridLocationAttributeId and vCoarseGridLocationAttributeId in case of a staggered grid) for the output locations, must be present in the input locations. |
uSpeed | InputVariableComplexType | required | The u speed input variable, scalar time series for a location set consisting of locations in a coarse grid. Note that all locations named via coarseGridLocationAttributeId (and uCoarseGridLocationAttributeId and vCoarseGridLocationAttributeId in case of a staggered grid) for the output locations, must be present in the input locations. |
vSpeed | InputVariableComplexType | required | The v speed input variable, scalar time series for a location set consisting of locations in a coarse grid. Note that all locations named via coarseGridLocationAttributeId (and uCoarseGridLocationAttributeId and vCoarseGridLocationAttributeId in case of a staggered grid) for the output locations, must be present in the input locations. |
bathymetry | InputVariableComplexType | required | The bathymetry of the output locations, scalar time series for the output location set. |
borderAttributeId | string | required | The id of the attribute of the output location set which contains the border (UP, DOWN, LEFT or RIGHT) of the fine grid the boundary location is located on. |
angleAttributeId | string | required | The id of the attribute of the output location set which contains the angle (in degrees) to be used for the calculation. |
coarseGridLocationAttributeId | string | required | The id of the attribute of the output location set which contains multiple text values representing the location ids of the input locations to be used to calculate the values for this output location. |
weightAttributeId | string | required | The id of the attribute of the output location set which contains multiple number values representing the weights to be used to calculate the values for this output location. |
outputVariable | OutputVariableComplexType | required | The output variable, scalar time series containing the Riemann boundary constants for a location set consisting of boundary locations of a fine grid. Note that all attributes (borderAttributeId, angleAttributeId, coarseGridLocationAttributeId, etc.), must exist for the location set of the input. Attribute files can be generated for a given coarse grid, fine grid and boundary location set via F12 -> convert -> Riemann boundary calculation constants. The output will also include a csv file which can be used to define an input location set which contains exactly those coarse grid locations needed. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
uCoarseGridLocationAttributeId | string | required | The id of the attribute of the output location set which contains multiple text values representing the location ids of the input locations to be used to calculate the u-speed values for this output location in case of a staggered coarse grid. |
uWeightAttributeId | string | required | The id of the attribute of the output location set which contains multiple number values representing the weights to be used to calculate the u-speed values for this output location in case of a staggered coarse grid. |
vCoarseGridLocationAttributeId | string | required | The id of the attribute of the output location set which contains multiple text values representing the location ids of the input locations to be used to calculate the v-speed values for this output location in case of a staggered coarse grid. |
vWeightAttributeId | string | required | The id of the attribute of the output location set which contains multiple number values representing the weights to be used to calculate the v-speed values for this output location in case of a staggered coarse grid. |
AltitudeElevationLapseComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
limitVariable | InputVariableComplexType | optional | Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable. |
inputTemperature | InputVariableComplexType | required | Input temperature. |
outputTemperature | OutputVariableComplexType | required | Output temperature. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
coefficientSet | AltitudeElevationLapseCoefficientSetComplexType | required · repeats | One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap. |
coefficientSetId | idStringType | required | Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory. |
coefficientSetFile | fileStringType | required | Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory. |
AltitudeZeroDegreeAltitudeComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
limitVariable | InputVariableComplexType | optional | Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable. |
temperature | InputVariableComplexType | required | Input variable. |
altitude | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
coefficientSet | AltitudeZeroDegreeAltitudeCoefficientSetComplexType | required · repeats | One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap. |
coefficientSetId | idStringType | required | Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory. |
coefficientSetFile | fileStringType | required | Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory. |
RemoveDryCellsComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | |
minimumLocalWaterLevel | double | optional | Optional element to define the minimum water level in meters at a cell to not be considered dry. When the value at a cell is lower than the elevation (Z) + the minimum water level, it will be set to NaN in the output. |
outputVariable | OutputVariableComplexType | required | |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
RotationUVVectorsFromRotatedPoleToWgs1984ComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputU | InputVariableComplexType | required | Input variable that contains the u component values of the velocity vectors in the rotated pole geoDatum. |
inputV | InputVariableComplexType | required | Input variable that contains the v component values of the velocity vectors in the rotated pole geoDatum. |
outputU | OutputVariableComplexType | required | Output variable to store the u component values of the velocity vectors in the Wgs1984 geoDatum. |
outputV | OutputVariableComplexType | required | Output variable to store the v component values of the velocity vectors in the Wgs1984 geoDatum. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
MultipleLinearRegressionComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
constantAttributeId | idStringType | required | The attribute which defines the constant value |
variableAttributeId | idStringType | required | The attribute which defines the variable |
inputLocationAttributeId | idStringType | required | The attribute which defines the input location |
factorAttributeId | idStringType | required | The attribute which defines the factor |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
MultiVariateThresholdsComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
ruleAttributeId | idStringType | required | The attribute id which defines the rule id |
directionalParameters | DirectionalParametersComplexType | optional | The variables for which the values are always between 0-360 |
inputVariableAttributeId | idStringType | required | The attribute id which defines the variable |
inputLocationAttributeId | idStringType | required | The attribute id which defines the input location |
lowerBoundAttributeId | idStringType | required | The attribute id which defines the lower bound |
lowerBoundInclusiveAttributeId | idStringType | optional | The attribute id which defines if the lower bound is inclusive or not. If this attribute is not defined the lower bound will not be inclusive |
upperBoundAttributeId | idStringType | required | The attribute id which defines if the upper bound |
upperBoundInclusiveAttributeId | idStringType | optional | The attribute which defines if the upper bound is inclusive or not. If this attribute is not defined the upper bound is inclusive |
ruleOutcomeAttributeId | idStringType | required | The attribute which defines the value which will be written to the output time series |
ruleOutcomeValueToSelect | ruleOutcomeValueToSelectEnumStringType | optional | When multiple rules apply, this element specifies which the preference based on the value of the rule outcome. By default the rule with highest outcome has preference
One of: lowest, highest |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
InputLocationSetsBasedMultivariateThresholdsComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
ruleAttributeId | idStringType | required | The attribute id which defines the rule id |
inputVariableAttributeId | idStringType | required | The attribute id which defines the variable of the transformation |
inputLocationSetIdAttributeId | idStringType | required | The attribute id which defines the input location set containing the locations from the input variable that need to be used. |
numberOfTimeSeriesWithinBoundariesAttributeId | idStringType | optional | The attribute which defines the number of time series within the input time series set that need to be within boundaries. If this attribute is not defined all time series need to be within boundaries for this rule to apply |
ruleOutcomeAttributeId | idStringType | required | The attribute which defines the value which will be written to the output time series |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
lowerBoundAttributeId | idStringType | required | The attribute id which defines the lower bound which needs to be crossed in order for the rule to apply |
inputLocationLowerBoundReferringAttributeId | idStringType | required | The id of an attribute which value is another attribute id which will be used to look up the input location specific lower bound value |
MultipleOutputLocationThresholdsComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
period | TransformationRunPeriodComplexType | optional | This element can be used to configure the run period of the transformation. |
trimOutput | trimOutputEnumStringType | optional | When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings.
One of: true, false, startOnly, endOnly |
inputVariable | InputVariableComplexType | required | Input variable. |
thresholdValueAttributeId | idStringType | required | The attribute which defines the threshold value |
crossingDirection | crossingDirectionEnumStringType | optional | The direction of crossings that should be taken into account, default is up
One of: up, down, above, below |
filterAttribute | FilterAttributeComplexType | required | The attribute id and the corresponding value that should be included |
outputValue | float | required | The value which will be written to the output when a threshold is crossed |
outputLocationAttributeId | idStringType | required | The attribute which defines for which output location a value should be written |
outputVariable | OutputVariableComplexType | required | Output variable. |
className | nameStringType | optional | Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code. |
TransformationRunPeriodComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
relativePeriod | RelativePeriodComplexType | required | |
cardinalTimeStep | TimeStepComplexType | required | Aligns the start and end time of the run period of the transformation with this time step. |
extendStart | boolean | required | Determines whether the start of the run period of the transformation should be extended or cropped to match the cardinal time step |
extendEnd | boolean | required | Determines whether the end of the run period of the transformation should be extended or cropped to match the cardinal time step |
startMonthDay | monthDayType | required | |
endMonthDay | monthDayType | required |
InputVariableComplexType
Choose between a reference to a variable or an embedded definition of a variable.
| Element | Type | Cardinality | Description |
|---|---|---|---|
variableId | idStringType | required | Identifier of a variable to use. |
locationId | idStringType | optional | If the specified variable contains multiple locations, then specify the location to use here. |
timeSeriesSet | TimeSeriesSetComplexType | required | A time series set that can be used as input or as output for a transformation function. |
convertDatum | boolean | optional | If true, then this time series is converted from local to ordnance datum level before a transformation and back to local datum level after the transformation. Default is false. |
checkMissing | boolean | optional | Option to check this timeseries for missing values. This option works in combination with the Parameter flag 'allowMissing', which can be set for a parameter in the parameters.xml configuration file. If for a given parameter allowMissing is false and checkMissing is true, then the transformation throws an exception when there are missing values for this parameter. When omitted defaults to 'false'. For grid data this option only checks whether the entire grid contains missing values or not, i.e. individual cells can still have missing values as long as there are other cells with non-missing values in the grid for the same time step. |
OutputVariableComplexType
Choose between a reference to a variable or an embedded definition of a variable.
| Element | Type | Cardinality | Description |
|---|---|---|---|
variableId | idStringType | required | Identifier of a variable to use. |
locationId | idStringType | optional | If the specified variable contains multiple locations, then specify the location to use here. |
timeSeriesSet | TimeSeriesSetComplexType | required | A time series set that can be used as input or as output for a transformation function. |
convertDatum | boolean | optional | If true, then this time series is converted from local to ordnance datum level before a transformation and back to local datum level after the transformation. Default is false. |
checkMissing | boolean | optional | Option to check this timeseries for missing values. This option works in combination with the Parameter flag 'allowMissing', which can be set for a parameter in the parameters.xml configuration file. If for a given parameter allowMissing is false and checkMissing is true, then the transformation throws an exception when there are missing values for this parameter. When omitted defaults to 'false'. For grid data this option only checks whether the entire grid contains missing values or not, i.e. individual cells can still have missing values as long as there are other cells with non-missing values in the grid for the same time step. |
InterpolationSerialDirectionLinearDirectionRangeComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
lowerLimit | float | required | |
upperLimit | float | required |
TimeSpanComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
unit | required | |
divider | optional | |
multiplier | optional |
percentileRangeComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
min | percentageType | required | This percentage of the lowest values will be removed. Should be smaller than max, set to 0 to remove none of the lowest values. |
max | percentageType | required | (100% - this percentage) of the highest values will be removed. Should be greater than min, set to 100 to remove none of the largest values. |
ValidationRuleComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
minimumInputValuesCount | intStringAttributeType | optional | Only works for non-equidistant data. When there are less than the minimum number of input values available the validation rule is not considered valid. |
inputDoubtfulPercentage | floatStringAttributeType | optional | |
inputMissingPercentage | floatStringAttributeType | optional | |
outputValueFlag | validationRuleFlagEnumStringType | required |
One of: missing, doubtful, reliable |
outputCustomFlagSourceId | idStringType | optional |
OutputGeometryComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
xMin | doubleStringType | required | X coordinate of the upper left point of the grid |
yMin | doubleStringType | required | Y coordinate of the upper left point of the grid |
xMax | doubleStringType | required | X coordinate of the lower right point of the grid |
yMax | doubleStringType | required | Y coordinate of the lower right point of the grid |
xCellSize | doubleStringType | required | Width of the grid cells |
yCellSize | doubleStringType | required | Height of the grid cells |
VariogramComplexType
Variogram options
| Element | Type | Cardinality | Description |
|---|---|---|---|
type | variogramEnumStringType | required | Type of variogram
One of: spherical, exponential, gaussian, power, linear |
nugget | float | required | Nugget of variogram (C0) |
range | float | required | Range of variogram in meters (a) |
slope | float | required | Slope of variogram (C1) |
sill | float | required | Sill of variogram to be used in case of all variograms except Linear (C1) |
DistanceGeographicComplexType
The coefficients G1 to G4 of function DistanceGeographic. Defaults (1,1,0,0)
| Element | Type | Cardinality | Description |
|---|---|---|---|
g1 | float | required | |
g2 | float | required | |
g3 | float | required | |
g4 | float | required |
DebugComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
level | int | required | Number for setting the level of debug generation, 0 = no debug information, 1 = some information, 2 ..etc = more information |
file | fileStringType | required | Debug file |
InterpolationSpatialWeightedInputVariableComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
inputVariable | InputVariableComplexType | required | Input variable. |
weight | double | required | Weight corresponding to this variable. |
InterpolationSpatialAttributedOutputVariableComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
outputVariable | OutputVariableComplexType | required | |
locationIdAttribute | string | required | The id of the multi-value attribute containing the locationIds of the input time series to be used. |
weightAttribute | string | required | The id of the multi-value attribute containing the weights to be used. |
AltitudeElevationLapseCoefficientSetComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
lowerLimit | float | optional | Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit. |
upperLimit | float | optional | Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit. |
temperatureLapseRate | float | required | Temperature lapse rate in degrees per 100 meters of elevation (typically 0.6 degrees Celsius per 100 meters). |
inputElevation | float | optional | Optional. If present, then this number is used for the inputElevation. If not present, then the inputElevation is derived from the input location or the input grid geometry. |
outputElevation | float | optional | Optional. If present, then this number is used for the outputElevation. If not present, then the outputElevation is derived from the output location. |
AltitudeZeroDegreeAltitudeCoefficientSetComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
lowerLimit | float | optional | Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit. |
upperLimit | float | optional | Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit. |
minAltitude | float | optional | Optional minimum altitude. If zero degrees altitude is below all input locations, then returns this minAltitude value, if present. If in this case minAltitude is not present, then returns the altitude of the lowest input location. |
maxAltitude | float | optional | Optional maximum altitude. If zero degrees altitude is above all input locations, then returns this maxAltitude value, if present. If in this case maxAltitude is not present, then returns the altitude of the highest input location. |
DirectionalParametersComplexType
| Element | Type | Cardinality | Description |
|---|---|---|---|
parameterId | idStringType | required · repeats | the parameter id of a directional time series |
FilterAttributeComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | optional | |
value | optional |
RelativePeriodComplexType
Defines a moving period in time. The start and end time are relative time to a certain time.
Attributes
| Attribute | Use | Notes |
|---|---|---|
start | required | |
end | required | |
startOverrulable | optional | default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run. |
endOverrulable | optional | default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run. |
unit | required |
Elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
description | string | optional |
TimeStepComplexType
Time step, There are 5 valid combinations of attributes. id, unit+[multiplier]+[divider]+[timeZone], times+[timeZone] + monthDays+[timeZone] ([]=optional)
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | optional | Id of the time step. You can reference time steps defined in the regionConfig/timeSteps.xml. Only specify the id attribute when referring to a predefined time step. In the regionConfig/timeSteps.xml the time steps list both the id and the attributes that define the time step |
label | optional | Short name for the time step which is shown to the user when he can choose one from a list. |
unit | optional | |
divider | optional | |
multiplier | optional | |
times | optional | Defines the time step by a list of times without dates, e.g. "10:00 23:00" |
minutes | optional | Since 2017.02. Defines the time step by a list of minutes (with prefix 0 for single digits), e.g. "05 25" which results in times 0:05, 0:25, 1:05, etc. |
daysOfMonth | optional | Defines the time step by a list of days of month, use "01 11 21" for a decade time step |
monthDays | optional | Defines the time step by a list of dates, e.g. ""--03-01 --06-01 --09-01 --12-01" for the meteorological seasons |
timeZone | optional |
Elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
description | string | optional | Optional description of this timeStep. This is not used and is only present for convenience. |
TimeSeriesSetComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
id | optional | |
name | optional |
Elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
description | string | optional | |
valueType | timeSeriesValueTypeStringType | required | |
parameterId | idStringType | required | |
domainParameterId | idStringType | optional · repeats | For a spectrum specify the frequency / wave length parameter. For a directional spectrum specify first the frequency parameter and secondly the directional parameter |
qualifierId | idStringType | optional · repeats | Id that references an qualifier listed in the regionConfigFiles/Qualifiers.xsd |
timeSeriesType | timeSeriesTypeStringType | required | |
timeStep | TimeStepComplexType | required | |
aggregationPeriod | RelativePeriodComplexType | optional | The value at a time represents the aggregated value over the aggregation period e.g when the aggregation period is -6 to 0 hour the value at 13:00 represents an aggregation (e.g. moving average) from 7:00 till 13:00 (including) |
cycle | CalendarTimeSpanComplexType | optional | If cycle specified, then the data is repeated periodically with this cycle as the period length. There is original data for only one cycle. After that cycle the data will be repeated periodically. In other words, when cycle is defined, then a missing value is filled up with a value from the last available cycle before the missing value. |
externalForecastSearchTimeStep | TimeStepComplexType | optional | Since 2024.01. Only time series with an external forecast time that match this time step are visible while searching |
externalForecastTimeCardinalTimeStep | TimeStepComplexType | optional | When no external forecast exists in the data store younger that the specified age a new external forecast is returned with a minimum age that applies to the specified cardinal time step |
qualifierAggregation | qualifierAggregationStringType | optional | When specified all the time series that have ALL the specified qualifiers are aggregated to a single time series on read. Can not be specified when this time series set is meant for writing |
readWriteMode | timeSeriesReadWriteModeStringType | required | Note: this readWriteMode is only used in the TimeSeriesDisplay. Other modules ignore this readWriteMode. |
synchLevel | intStringType | optional | |
expiryTime | CalendarTimeSpanComplexType | optional | |
delay | TimeShiftComplexType | optional | |
multiplier | floatStringType | optional | |
divider | floatStringType | optional | |
incrementer | floatStringType | optional | |
ensembleId | idStringType | optional | Optional field for running ensembles. Ensemble id's in a time series set will override ensemble id's defined in the workflow. |
visibilityControllingFlagSourceColumnId | idStringType | optional | All values that not passed this validation step are removed on read. Set to missing for equidistant and removed for non-equidistant |
onlyReliableFlagSourceColumnId | idStringType | optional | Since 2022.02. All values that passed this validation step and are reliable will be included other will be set to missing for equidistant and removed for non-equidistant. This will work as an "or" operation together with "visibilityControllingFlagSourceColumnId", so data should either have passed "visibilityControllingFlagSourceColumnId" or "onlyReliableFlagSourceColumnId". |
locationRelationId | idStringType | required | Relation id to map the time series set locations to related locations. Instead of the time series set locations the related locations are used to read/write the time series. |
skipLocationsWithoutRelation | boolean | optional | Since 2020.01 When true locations that do not have a related location will be skipped, when false all location must have a related location. Default is false |
moduleInstanceId | idStringType | required · repeats | |
moduleInstanceSetId | idStringType | required | Query a single module instance in the data store that is available for this time series set |
filterModuleInstanceSetId | idStringType | required | Query all module instances in the data store that are available for this time series set |
locationId | idStringType | required · repeats | |
locationSetId | idStringType | required | |
chainageLocationSetId | idStringType | required | Id of location set which represents a chainage of locations. This can only be used in combination with readWriteMode readOnly |
relativeViewPeriod | TimeSeriesSetRelativePeriodComplexType | optional | Period relative the time 0 of the workflow or the system time of the fews explorer |
relativeForecastPeriod | TimeSeriesSetRelativePeriodComplexType | optional | Period relative to first time of a simulated or external forecast time series |
ensembleMemberId | nonEmptyStringType | required · repeats | Optional field used for reading or writing one or more particular ensemble member |
ensembleMemberIndex | nonNegativeIntegerStringType | required | Optional field used for reading or writing one particular ensemble member |
ensembleMemberIndexRange | EnsembleMemberIndexRangeComplexType | required | Optional field used for reading or writing one particular sub set of the ensemble |
relativeForecastSearchPeriod | TimeSeriesSetRelativePeriodComplexType | required | Since 2015.02. The latest available external forecast in this period will be read. By default the latest before time0 is returned |
externalForecastTimeId | idStringType | required | Since 2018.01. Forecast time reference id configured in the forecast length estimator config. Can only be used in workflows and only after the forecast length estimator. |
externalForecastMinAge | TimeSpanComplexType | optional | Since 2014.02. By default is there is no minimum age. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0 |
externalForecastMaxAge | TimeSpanComplexType | optional | By default is there is no maximum age so the returned external forecast can be very old when there is no recent forecast available. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0 |
CalendarTimeSpanComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
unit | required | |
divider | optional | |
multiplier | optional |
TimeShiftComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
unit | required | |
divider | optional | |
multiplier | optional |
TimeSeriesSetRelativePeriodComplexType
Defines a moving period in time. The start and end time are relative time to a certain time. When the start time is not specified it is determined by the start time of the state of the current run. When the start is overrulable the time is overruled by the start of search period or the start of cold state run when one of two is specified When the end is overrulable this time is overruled by the end of the forecast when specified
Attributes
| Attribute | Use | Notes |
|---|---|---|
unit | required | |
start | optional | e.g. -1 hour means one before time 0 |
end | required | e.g. 1 hour means one hour after time 0 |
startOverrulable | optional | default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run. |
endOverrulable | optional | default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run. |
Elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
description | string | optional |
EnsembleMemberIndexRangeComplexType
Attributes
| Attribute | Use | Notes |
|---|---|---|
start | required | |
end | optional |
Gotchas
Section titled “Gotchas”interpolationSerialfills gaps within one series (time axis only);interpolationSpatialmoves values across locations or to/from a grid (space axis) — they’re not interchangeable despite the similar names. Use serial to patch a gauge record, spatial to turn point rainfall into a gridded field (or vice versa).maxGapLengthbounds how large a gapinterpolationSerialmethods will bridge (in time steps) — omit it and an arbitrarily long stretch of missing data gets filled, rarely what you want. Same caution as on interpolation sets (the older, largely superseded file this function family effectively replaces).- Most
interpolationSpatialmethods needsearchRadius/numberOfPointstuned to your station density —inverseDistanceandkrigingdefault to unbounded search radius and 8 points; a sparse network with far-apart stations may need a largersearchRadiusor the result silently leans on distant, less-representative stations. altitude elevationLapseneeds acoefficientSet, referenced either inline (coefficientSet) or from a separate file (coefficientSetId/coefficientSetFile, inConfig/CoefficientSetsFiles/) — the lapse rate isn’t a single number on the function itself.rotation’s one method is narrowly scoped: it rotates u/v vector components from a rotated-pole grid geometry to WGS 1984 — it doesn’t reproject scalar grids. For scalar reprojection, look atinterpolationSpatialmethods instead (e.g.bilinear).
See also
Section titled “See also”- Reference: Transformation functions — basics · Temporal reshaping · Interpolation sets file (legacy, related concern)
- Task guide: Transformations
- Schema:
transformationTypes.xsd