Skip to content

Transformation functions — statistics

This page is the generated field list for the statistics transformation functions — 9 categories that all compute the same kind of thing (mean, percentile, count, quartile, …) but differ in what gets grouped together to compute it: a rolling time window, one summary value, a climatological cycle, ensemble members, or locations related/grouped by a shared attribute. Part of the transformation function catalogue; see that page for the shared <transformationModule>/<transformation> mechanics these all sit inside.

Covers : statisticsSerial (per output time, stats over its own aggregation period), statisticsSummary (one summary value over a view period, stored at T0), statisticsPeriodic (climatological — e.g. mean January temperature over many years), statisticsEnsemble (across ensemble members at each time step), statisticsSameAttributeValue / statisticsChildrenLocations / statisticsRelatedLocations (across multiple locations, grouped by shared attribute, parent/child, or a location relation), statisticsValueProperties (over value properties attached to input series), statisticsVerticalLayers (across z/sigma grid layers, since 2021.01).

Used inside : A <transformation>, <periodTransformation>, or <rangeTransformation> in a transformationModule file.

Config/ModuleConfigFiles/PostProcessForecast 1.00 default.xml
<?xml version="1.0" encoding="UTF-8"?>
<transformationModule xmlns="http://www.wldelft.nl/fews" version="1.0">
<transformation id="DailyMeanFromHourly">
<statisticsSerial>
<mean>
<inputVariable>
<timeSeriesSet>
<moduleInstanceId>ImportObservations</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>T.obs</parameterId>
<locationId>WeatherStation_01</locationId>
<timeSeriesType>external historical</timeSeriesType>
<timeStep unit="hour" multiplier="1"/>
<readWriteMode>read only</readWriteMode>
</timeSeriesSet>
</inputVariable>
<outputVariable>
<timeSeriesSet>
<moduleInstanceId>PostProcessForecast</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>T.mean</parameterId>
<locationId>WeatherStation_01</locationId>
<timeSeriesType>simulated historical</timeSeriesType>
<timeStep unit="day" multiplier="1"/>
<readWriteMode>add originals</readWriteMode>
</timeSeriesSet>
</outputVariable>
</mean>
</statisticsSerial>
</transformation>
</transformationModule>

Auto-generated from transformationTypes.xsd. Descriptions are the schema's own annotations.

Function <statisticsSameAttributeValue>

ElementTypeCardinalityDescription
count StatisticsSameAttributeValueCountComplexType required
countThresholdCrossings StatisticsSameAttributeValueCountThresholdCrossingsComplexType required
kurtosis StatisticsSameAttributeValueComplexType required
max StatisticsSameAttributeValueComplexType required
mean StatisticsSameAttributeValueComplexType required
median StatisticsSameAttributeValueComplexType required
min StatisticsSameAttributeValueComplexType required
percentileExceedence StatisticsSameAttributeValuePercentileExceedenceComplexType required
percentileNonExceedence StatisticsSameAttributeValuePercentileNonExceedenceComplexType required
quartile StatisticsSameAttributeValueQuartileComplexType required
rootMeanSquareError StatisticsSameAttributeValueComplexType required
rsquared StatisticsSameAttributeValueComplexType required
skewness StatisticsSameAttributeValueComplexType required
standardDeviation StatisticsSameAttributeValueComplexType required
sum StatisticsSameAttributeValueComplexType required
variance StatisticsSameAttributeValueComplexType required

Function <statisticsChildrenLocations>

ElementTypeCardinalityDescription
count StatisticsChildLocationsCountComplexType required
kurtosis StatisticsChildLocationsComplexType required
max StatisticsChildLocationsComplexType required
mean StatisticsChildLocationsComplexType required
median StatisticsChildLocationsComplexType required
min StatisticsChildLocationsComplexType required
percentileExceedence StatisticsChildLocationsPercentileExceedenceComplexType required
percentileNonExceedence StatisticsChildLocationsPercentileNonExceedenceComplexType required
quartile StatisticsChildLocationsQuartileComplexType required
rootMeanSquareError StatisticsChildLocationsComplexType required
rsquared StatisticsChildLocationsComplexType required
skewness StatisticsChildLocationsComplexType required
standardDeviation StatisticsChildLocationsComplexType required
sum StatisticsChildLocationsComplexType required
variance StatisticsChildLocationsComplexType required

Function <statisticsRelatedLocations>

ElementTypeCardinalityDescription
count StatisticsRelatedLocationsCountComplexType required
kurtosis StatisticsRelatedLocationsComplexType required
max StatisticsRelatedLocationsComplexType required
mean StatisticsRelatedLocationsComplexType required
median StatisticsRelatedLocationsComplexType required
min StatisticsRelatedLocationsComplexType required
percentileExceedence StatisticsRelatedLocationsPercentileExceedenceComplexType required
percentileNonExceedence StatisticsRelatedLocationsPercentileNonExceedenceComplexType required
quartile StatisticsRelatedLocationsQuartileComplexType required
rootMeanSquareError StatisticsRelatedLocationsComplexType required
rsquared StatisticsRelatedLocationsComplexType required
skewness StatisticsRelatedLocationsComplexType required
standardDeviation StatisticsRelatedLocationsComplexType required
sum StatisticsRelatedLocationsComplexType required
variance StatisticsRelatedLocationsComplexType required
large StatisticsRelatedLocationsLargeComplexType required
rank StatisticsRankComplexType required

Function <statisticsValueProperties>

ElementTypeCardinalityDescription
forecastPeak ForecastPeakComplexType required Calculates 3 statistics, how many peaks are predicted correctly, for how many peak the height is predicted incorrectly and how many peaks are missed. For the calculation input forecast time series with value properties are compared to observed time series
forecastPeakMatching ForecastPeakMatchingComplexType required Matches forecast peaks with observed peaks, writes the observed peak time and value in properties to the forecast output
forecastPeakEvaluation ForecastPeakEvaluationComplexType required Evaluates whether forecasts matched with peaks have been predicted correctly
thresholdExceedanceCount ThresholdExceedanceCountComplexType required Calculates 4 statistics, how many threshold exceedences are: forecast but not observed, observed but not forecast, forecast but not within an acceptable time range and for how many are correctly forecast. For the calculation input forecast time series with value properties are compared to observed time series
thresholdExceedanceMatching ThresholdExceedanceMatchingComplexType required Calculates 4 statistics, how many threshold exceedences are: forecast but not observed, observed but not forecast, forecast but not within an acceptable time range and for how many are correctly forecast. For the calculation input forecast time series with value properties are compared to observed time series
thresholdExceedanceEvaluation ThresholdExceedanceEvaluationComplexType required Matches forecast threshold exceedances with observed exceedances, when a match is found the time of threshold crossing is written in a property for the forecast with id "Prediction_Value_Exceed_Time"
forecastsOnTimeCount CountForecastsOnTimeComplexType required Count how many forecasts where issued on time. It uses date time properties that specify when the next forecast was supposed to be issued and when it is actually issued. Needs consecutive forecasts because one contains information about the next, so will always need 1 forecast extra before the forecast search period.
valueCount ValuePropertyCountComplexType required Count how many time steps there are in the input time series which contain all value properties with the exact values as configured

Function <statisticsEnsemble>

ElementTypeCardinalityDescription
count StatisticsEnsembleCountComplexType required
eventProbability StatisticsEnsembleEventProbabilityComplexType required
kurtosis StatisticsEnsembleComplexType required
max StatisticsEnsembleComplexType required
mean StatisticsEnsembleComplexType required
median StatisticsEnsembleComplexType required
memberIndexOfMax StatisticsEnsembleMemberIndexOfMaxComplexType required
rank StatisticsEnsembleMemberRankComplexType required
min StatisticsEnsembleComplexType required
percentileExceedence StatisticsEnsemblePercentileExceedenceComplexType required
percentileNonExceedence StatisticsEnsemblePercentileNonExceedenceComplexType required
quartile StatisticsEnsembleQuartileComplexType required
rootMeanSquareError StatisticsEnsembleComplexType required
rsquared StatisticsEnsembleComplexType required
skewness StatisticsEnsembleComplexType required
standardDeviation StatisticsEnsembleComplexType required
sum StatisticsEnsembleComplexType required
variance StatisticsEnsembleComplexType required

Function <statisticsPeriodic>

ElementTypeCardinalityDescription
count StatisticsPeriodicCountComplexType required
countFlags StatisticsPeriodicCountFlagsComplexType required Counts the number of input values that have the configured reliability (flag) and for which the reason for rejection is equal to the configured validation rule (flagSource).
kurtosis StatisticsPeriodicComplexType required
max StatisticsPeriodicComplexType required
mean StatisticsPeriodicComplexType required
median StatisticsPeriodicComplexType required
min StatisticsPeriodicComplexType required
percentileExceedence StatisticsPeriodicPercentileExceedenceComplexType required
percentileNonExceedence StatisticsPeriodicPercentileNonExceedenceComplexType required
quartile StatisticsPeriodicQuartileComplexType required
rootMeanSquareError StatisticsPeriodicComplexType required
rsquared StatisticsPeriodicComplexType required
skewness StatisticsPeriodicComplexType required
standardDeviation StatisticsPeriodicComplexType required
sum StatisticsPeriodicComplexType required
variance StatisticsPeriodicComplexType required

Function <statisticsSerial>

ElementTypeCardinalityDescription
count StatisticsSerialCountComplexType required
countFlags StatisticsSerialCountFlagsComplexType required Counts the number of input values that have the configured reliability (flag) and for which the reason for rejection is equal to the configured validation rule (flagSource).
kurtosis StatisticsSerialComplexType required
max StatisticsSerialComplexType required
mean StatisticsSerialComplexType required
median StatisticsSerialComplexType required
min StatisticsSerialComplexType required
percentileExceedence StatisticsSerialPercentileExceedenceComplexType required
percentileNonExceedence StatisticsSerialPercentileNonExceedenceComplexType required
quartile StatisticsSerialQuartileComplexType required
rootMeanSquareError StatisticsSerialComplexType required
rsquared StatisticsSerialComplexType required
skewness StatisticsSerialComplexType required
standardDeviation StatisticsSerialComplexType required
sum StatisticsSerialComplexType required
variance StatisticsSerialComplexType required
geometricMean StatisticsSerialComplexType required
periodVaryingMean PeriodVaryingMeanComplexType required

Function <statisticsSummary>

ElementTypeCardinalityDescription
count StatisticsSummaryCountComplexType required
countFlags StatisticsSummaryCountFlagsComplexType required Counts the number of input values that have the configured reliability (flag) and for which the reason for rejection is equal to the configured validation rule (flagSource).
kurtosis StatisticsSummaryComplexType required
max StatisticsSummaryComplexType required
mean StatisticsSummaryComplexType required
median StatisticsSummaryComplexType required
min StatisticsSummaryComplexType required
percentileExceedence StatisticsSummaryPercentileExceedenceComplexType required
percentileNonExceedence StatisticsSummaryPercentileNonExceedenceComplexType required
quartile StatisticsSummaryQuartileComplexType required
rootMeanSquareError StatisticsSummaryComplexType required
rsquared StatisticsSummaryComplexType required
skewness StatisticsSummaryComplexType required
standardDeviation StatisticsSummaryComplexType required
sum StatisticsSummaryComplexType required
variance StatisticsSummaryComplexType required

Function <statisticsVerticalLayers>

ElementTypeCardinalityDescription
averageScalarVerticalLayers StatisticsVerticalAverageScalarComplexType required
averageGridZLayers StatisticsVerticalAverageGridZLayerComplexType required
averageGridSigmaLayers StatisticsVerticalAverageGridSigmaLayerComplexType required

StatisticsSameAttributeValueCountComplexType

ElementTypeCardinalityDescription
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
attributeId idStringType required The id of the attribute which will be used in finding matching input time series
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.

StatisticsSameAttributeValueCountThresholdCrossingsComplexType

ElementTypeCardinalityDescription
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
input InputVariableComplexType required Input variable.
matchingAttributeId idStringType required The attribute id which determines which input time series should be used for the output time series
filterAttribute FilterAttributeComplexType optional · repeats Attribute with a specific value that determines if input time series should be included
thresholdValueAttributeId idStringType required The attribute id which defines the input location set containing the locations from the input variable that need to be used.
output 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.

StatisticsSameAttributeValueComplexType

ElementTypeCardinalityDescription
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
attributeId idStringType required The id of the attribute which will be used in finding matching input time series
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.

StatisticsSameAttributeValuePercentileExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
attributeId idStringType required The id of the attribute which will be used in finding matching input time series
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.

StatisticsSameAttributeValuePercentileNonExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
attributeId idStringType required The id of the attribute which will be used in finding matching input time series
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.

StatisticsSameAttributeValueQuartileComplexType

ElementTypeCardinalityDescription
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
value int required Quartile value, e.g. "3" for the third quartile.
attributeId idStringType required The id of the attribute which will be used in finding matching input time series
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.

StatisticsChildLocationsCountComplexType

ElementTypeCardinalityDescription
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
includeMissingValues boolean required If true, then missing values count towards the total number of values. If false missing values are ignored.
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.

StatisticsChildLocationsComplexType

ElementTypeCardinalityDescription
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
ignoreMissing boolean optional SINCE 2014.02 If true, then missing values are ignored. If false, then an output value will be missing if one or more of the corresponding input values are missing. Default is true.
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.

StatisticsChildLocationsPercentileExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
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.

StatisticsChildLocationsPercentileNonExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
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.

StatisticsChildLocationsQuartileComplexType

ElementTypeCardinalityDescription
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
value int required Quartile value, e.g. "3" for the third quartile.
ignoreMissing boolean optional If true, then missing values are ignored. If false, then output values will be set to missing values starting from the first missing input value in an interval until the end of that interval. Default is true.
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.

StatisticsRelatedLocationsCountComplexType

ElementTypeCardinalityDescription
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
includeMissingValues boolean required If true, then missing values count towards the total number of values. If false missing values are ignored.
locationRelationId idStringType required Location relation available for the input or output locations. Relation points from input to output or from output to input. When the relation is available in both directions a config error is logged
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.

StatisticsRelatedLocationsComplexType

ElementTypeCardinalityDescription
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
locationRelationId idStringType required Location relation available for the input locations. Relation points from input to output
ignoreMissing boolean optional SINCE 2014.02 If true, then missing values are ignored. If false, then an output value will be missing if one or more of the corresponding input values are missing. Default is true.
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

StatisticsRelatedLocationsPercentileExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
locationRelationId idStringType required Location relation available for the input locations. Relation points from input to 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.

StatisticsRelatedLocationsPercentileNonExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
locationRelationId idStringType required Location relation available for the input locations. Relation points from input to 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.

StatisticsRelatedLocationsQuartileComplexType

ElementTypeCardinalityDescription
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
value int required Quartile value, e.g. "3" for the third quartile.
locationRelationId idStringType required Location relation available for the input locations. Relation points from input to output
ignoreMissing boolean optional If true, then missing values are ignored. If false, then output values will be set to missing values starting from the first missing input value in an interval until the end of that interval. Default is true.
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.

StatisticsRelatedLocationsLargeComplexType

ElementTypeCardinalityDescription
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
rank positiveInteger required
locationRelationId idStringType required Location relation available for the input locations. Relation points from input to output
ignoreMissing boolean optional SINCE 2014.02 If true, then missing values are ignored. If false, then an output value will be missing if one or more of the corresponding input values are missing. Default is true.
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

StatisticsRankComplexType

ElementTypeCardinalityDescription
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
value double 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.

ForecastPeakComplexType

ElementTypeCardinalityDescription
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
inputObservedVariable InputVariableComplexType required Variable that is used to see whether its observed values match the values and value properties of the forecast variable. This should only contain peak values.
inputForecastVariable InputVariableComplexType required Variable that is used to see its values and value properties match the values of the observed variable.
peakValueProperty ValuePropertyComplexType required Id and value of the property that determines whether a forecast predicted a peak
peakRangeAttributeId idStringType required Id of the attribute which specifies how much the forecast peak height can be above or below the observed value
peakSearchPeriodAttributeId idStringType required Id of the attribute which specifies the time window in hours around the observed peak can be to match with a forecast. Half of the time window will be before, half will be after
missedPeakMinimumValueAttributeId idStringType required Id of the attribute that specifies the minimum value of an observed peak to be counted as missed
rangeValueProperty ValuePropertyComplexType required Id and value of the property that determines whether a peak prediction has a specific range. If so, this overrules the peak range taken from the attribute
forecastSearchPeriod RelativePeriodComplexType required The inputVariable time series set will be used to find all input forecasts that have a forecastTime within this period (startTime and endTime are both inclusive). This period is relative to T0. Only approved forecasts and external forecasts will be found.
outputMissedPeakCountVariable OutputVariableComplexType required Variable that stores how many peaks are missed.
outputMissedHeightCountVariable OutputVariableComplexType required Variable that stores for how many peaks the height is predicted incorrectly
outputHitCountVariable OutputVariableComplexType required Variable that stores how many peaks are predicted correctly
outputMissedForecastCountVariable OutputVariableComplexType required Variable that stores how many forecast peaks do not have an observed peak within their time window
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.

ForecastPeakMatchingComplexType

ElementTypeCardinalityDescription
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
inputObservedVariable InputVariableComplexType required Variable that is used to see whether its observed values match the values and value properties of the forecast variable. This should only contain peak values.
inputForecastVariable InputVariableComplexType required Variable that is used to see its values and value properties match the values of the observed variable.
peakValueProperty ValuePropertyComplexType required Id and value of the property that determines whether a forecast predicted a peak
peakSearchPeriodAttributeId idStringType required Id of the attribute which specifies the time window in hours around the observed peak can be to match with a forecast. Half of the time window will be before, half will be after
forecastPeakMinimumValueAttributeId idStringType required Id of the attribute that specifies the minimum value of an forecast peak to be included in counting
forecastSearchPeriod RelativePeriodComplexType required The inputVariable time series set will be used to find all input forecasts that have a forecastTime within this period (startTime and endTime are both inclusive). This period is relative to T0. Only approved forecasts and external forecasts will be found.
outputForecastVariable OutputVariableComplexType required Variable that stores properties of matched observed peaks, Observed_Date for the observed peak time and Observed_Magnitude for the observed peak height.
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.

ForecastPeakEvaluationComplexType

ElementTypeCardinalityDescription
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
inputObservedVariable InputVariableComplexType required Variable that is used to see whether its observed values match the values and value properties of the forecast variable. This should only contain peak values.
inputForecastVariable InputVariableComplexType required Variable that is used to see its values and value properties match the values of the observed variable.
peakValueProperty ValuePropertyComplexType required Id and value of the property that determines whether a forecast predicted a peak
peakRangeAttributeId idStringType required Id of the attribute which specifies how much the forecast peak height can be above or below the observed value
peakSearchPeriodAttributeId idStringType required Id of the attribute which specifies the time window in hours around the observed peak can be to match with a forecast. Half of the time window will be before, half will be after
missedPeakMinimumValueAttributeId idStringType required Id of the attribute that specifies the minimum value of an observed peak to be counted as missed
forecastPeakMinimumValueAttributeId idStringType required Id of the attribute that specifies the minimum value of an forecast peak to be included in counting
rangeValueProperty ValuePropertyComplexType required Id and value of the property that determines whether a peak prediction has a specific range. If so, this overrules the peak range taken from the attribute
forecastSearchPeriod RelativePeriodComplexType required The inputVariable time series set will be used to find all input forecasts that have a forecastTime within this period (startTime and endTime are both inclusive). This period is relative to T0. Only approved forecasts and external forecasts will be found.
outputMissedPeakCountVariable OutputVariableComplexType required Variable that stores how many peaks are missed.
outputMissedHeightCountVariable OutputVariableComplexType required Variable that stores for how many peaks the height is predicted incorrectly
outputHitCountVariable OutputVariableComplexType required Variable that stores how many peaks are predicted correctly
outputMissedForecastCountVariable OutputVariableComplexType required Variable that stores how many forecast peaks do not have an observed peak within their time window
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.

ThresholdExceedanceCountComplexType

ElementTypeCardinalityDescription
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
inputObservedVariable InputVariableComplexType required Variable that is used to see whether its observed values match the values and value properties of the forecast variable.
inputForecastVariable InputVariableComplexType required Variable that is used to see its values and value properties match the values of the observed variable.
inputForecastSequenceVariable InputVariableComplexType required Variable that is used to split the run period into separate periods to look for crossings
thresholdCrossing ThresholdCrossingAttributesComplexType required · repeats Id of the attributes that specify the threshold (value and lead time) that needs to be checked whether it is crossed in the observed input and predicted in the forecast input
forecastSearchPeriod RelativePeriodComplexType required The inputForecastVariable time series set will be used to find all input forecasts that have a forecastTime within this period (startTime and endTime are both inclusive). This period is relative to T0. Only approved forecasts and external forecasts will be found.
startSequenceValueProperty ValuePropertyComplexType required Id and value of the property that determines a start of a new sequence for which individual threshold crossings should be counted
endSequenceValueProperty ValuePropertyComplexType required Id and value of the property that determines the end of a new sequence for which individual threshold crossings should be counted
forecastSelectValueProperty ValuePropertyComplexType optional · repeats Id and value of the property that determines whether a forecast should be selected for counting or not. When none are configured all forecasts are included, otherwise only the configured ones.
outputFalseAlarmCountVariable OutputVariableComplexType required Variable that stores how many threshold exceedences are forecast but not observed
outputMissedCrossingsCountVariable OutputVariableComplexType required Variable that stores how many threshold exceedences are observed but not forecast
outputMissedTimeCountVariable OutputVariableComplexType required Variable that stores how many threshold exceedences are observed and forecast but not within an acceptable time range
outputHitCountVariable OutputVariableComplexType required Variable that stores how many threshold exceedences are observed and forecast within an acceptable time range
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.

ThresholdExceedanceMatchingComplexType

ElementTypeCardinalityDescription
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
inputObservedVariable InputVariableComplexType required Variable that is used to see whether its observed values match the values and value properties of the forecast variable.
inputForecastVariable InputVariableComplexType required Variable that is used to see its values and value properties match the values of the observed variable.
inputForecastSequenceVariable InputVariableComplexType required Variable that is used to split the run period into separate periods to look for crossings
thresholdCrossing ThresholdCrossingAttributesComplexType required · repeats Id of the attributes that specify the threshold (value and lead time) that needs to be checked whether it is crossed in the observed input and predicted in the forecast input
forecastSearchPeriod RelativePeriodComplexType required The inputForecastVariable time series set will be used to find all input forecasts that have a forecastTime within this period (startTime and endTime are both inclusive). This period is relative to T0. Only approved forecasts and external forecasts will be found.
startSequenceValueProperty ValuePropertyComplexType required Id and value of the property that determines a start of a new sequence for which individual threshold crossings should be counted
endSequenceValueProperty ValuePropertyComplexType required Id and value of the property that determines the end of a new sequence for which individual threshold crossings should be counted
forecastSelectValueProperty ValuePropertyComplexType optional · repeats Id and value of the property that determines whether a forecast should be selected for counting or not. When none are configured all forecasts are included, otherwise only the configured ones.
outputVariable OutputVariableComplexType required Variable to store the properties of crossings in.
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.

ThresholdExceedanceEvaluationComplexType

ElementTypeCardinalityDescription
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
inputObservedVariable InputVariableComplexType required Variable that is used to see whether its observed values match the values and value properties of the forecast variable.
inputForecastVariable InputVariableComplexType required Variable that is used to see its values and value properties match the values of the observed variable.
inputForecastSequenceVariable InputVariableComplexType required Variable that is used to split the run period into separate periods to look for crossings
thresholdCrossing ThresholdCrossingAttributesComplexType required · repeats Id of the attributes that specify the threshold (value and lead time) that needs to be checked whether it is crossed in the observed input and predicted in the forecast input
forecastSearchPeriod RelativePeriodComplexType required The inputForecastVariable time series set will be used to find all input forecasts that have a forecastTime within this period (startTime and endTime are both inclusive). This period is relative to T0. Only approved forecasts and external forecasts will be found.
startSequenceValueProperty ValuePropertyComplexType required Id and value of the property that determines a start of a new sequence for which individual threshold crossings should be counted
endSequenceValueProperty ValuePropertyComplexType required Id and value of the property that determines the end of a new sequence for which individual threshold crossings should be counted
forecastSelectValueProperty ValuePropertyComplexType optional · repeats Id and value of the property that determines whether a forecast should be selected for counting or not. When none are configured all forecasts are included, otherwise only the configured ones.
outputFalseAlarmCountVariable OutputVariableComplexType required Variable that stores how many threshold exceedences are forecast but not observed
outputMissedCrossingsCountVariable OutputVariableComplexType required Variable that stores how many threshold exceedences are observed but not forecast
outputMissedTimeCountVariable OutputVariableComplexType required Variable that stores how many threshold exceedences are observed and forecast but not within an acceptable time range
outputHitCountVariable OutputVariableComplexType required Variable that stores how many threshold exceedences are observed and forecast within an acceptable time range
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.

CountForecastsOnTimeComplexType

ElementTypeCardinalityDescription
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 time series containing the forecast time series
forecastIssueTimePropertyId idStringType required Id the date time property that specifies when the forecast was issued
forecastNextIssueTimePropertyId idStringType required Id the date time property that specifies when the next forecast was supposed to be issued
forecastSearchPeriod RelativePeriodComplexType required The inputVariable time series set will be used to find all input forecasts that have a forecastTime within this period (startTime and endTime are both inclusive). This period is relative to T0. Only approved forecasts and external forecasts will be found.
forecastSearchPeriodExtensionTimeSpan TimeSpanComplexType required Time span for which the search period should be extended at the start. This is necessary to find 1 forecast previous to the first one in the search period to determine its next issue time
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.

ValuePropertyCountComplexType

ElementTypeCardinalityDescription
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
valueProperty ValuePropertyComplexType optional · repeats Id and value of the property that should be counted, all time steps of all time series will be included in the count
forecastSearchPeriod RelativePeriodComplexType optional The inputVariable time series set will be used to find all input forecasts that have a forecastTime within this period (startTime and endTime are both inclusive). This period is relative to T0. Only approved forecasts and external forecasts will be found.
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.

StatisticsEnsembleCountComplexType

ElementTypeCardinalityDescription
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
includeMissingValues boolean required If true, then missing values count towards the total number of values. If false missing values are ignored.
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.

StatisticsEnsembleEventProbabilityComplexType

ElementTypeCardinalityDescription
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
includeMissingValues boolean required If true, then missing values count towards the total number of values. If false missing values are ignored.
event eventRangeComplexType 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.

StatisticsEnsembleComplexType

ElementTypeCardinalityDescription
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
ignoreMissing boolean optional If true, then missing values are ignored. If false, then an output value will be missing if one or more of the corresponding input values are missing. Default is true.
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.

StatisticsEnsembleMemberIndexOfMaxComplexType

ElementTypeCardinalityDescription
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.

StatisticsEnsembleMemberRankComplexType

ElementTypeCardinalityDescription
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
value InputVariableComplexType required
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.

StatisticsEnsemblePercentileExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
ignoreMissing boolean optional If true, then missing values are ignored. If false, then an output value will be missing if one or more of the corresponding input values are missing. Default is true.
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.

StatisticsEnsemblePercentileNonExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
ignoreMissing boolean optional If true, then missing values are ignored. If false, then an output value will be missing if one or more of the corresponding input values are missing. Default is true.
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.

StatisticsEnsembleQuartileComplexType

ElementTypeCardinalityDescription
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
value int required Quartile value, e.g. "3" for the third quartile.
ignoreMissing boolean optional If true, then missing values are ignored. If false, then an output value will be missing if one or more of the corresponding input values are missing. Default is true.
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.

StatisticsPeriodicCountComplexType

ElementTypeCardinalityDescription
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
includeMissingValues boolean required If true, then missing values count towards the total number of values. If false missing values are ignored.
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.

StatisticsPeriodicCountFlagsComplexType

ElementTypeCardinalityDescription
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
reliability statisticsSerialCountFlagsReliabilityEnumStringType required Only values with the specified reliability (flag) are counted. Choose "any" to count all values regardless of their reliability.
One of: any, reliable, doubtful, non_missing_unreliable, missing
validationRule statisticsSerialCountFlagsValidationRuleEnumStringType required Only values for which the reason of rejection is equal to the specified validation rule (flagSource) are counted. Choose "any" to count all values regardless of their reason for rejection.
One of: any, none, manual, imported, modifier, extreme_values_soft_min, extreme_values_hard_min, extreme_values_soft_max, extreme_values_hard_max, rate_of_change_rise, rate_of_change_fall, same_reading, temporary_shift, oscillation, series_comparison_check, flags_comparison_check, spatialhomogeneity_check, mann_kendall_check
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.

StatisticsPeriodicComplexType

ElementTypeCardinalityDescription
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.

StatisticsPeriodicPercentileExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
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.

StatisticsPeriodicPercentileNonExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
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.

StatisticsPeriodicQuartileComplexType

ElementTypeCardinalityDescription
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
value int required Quartile value, e.g. "3" for the third quartile.
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.

StatisticsSerialCountComplexType

ElementTypeCardinalityDescription
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
includeMissingValues boolean required If true, then missing values count towards the total number of values. If false missing values are ignored.
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.

StatisticsSerialCountFlagsComplexType

ElementTypeCardinalityDescription
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
reliability statisticsSerialCountFlagsReliabilityEnumStringType required Only values with the specified reliability (flag) are counted. Choose "any" to count all values regardless of their reliability.
One of: any, reliable, doubtful, non_missing_unreliable, missing
validationRule statisticsSerialCountFlagsValidationRuleEnumStringType required Only values for which the reason of rejection is equal to the specified validation rule (flagSource) are counted. Choose "any" to count all values regardless of their reason for rejection.
One of: any, none, manual, imported, modifier, extreme_values_soft_min, extreme_values_hard_min, extreme_values_soft_max, extreme_values_hard_max, rate_of_change_rise, rate_of_change_fall, same_reading, temporary_shift, oscillation, series_comparison_check, flags_comparison_check, spatialhomogeneity_check, mann_kendall_check
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.

StatisticsSerialComplexType

ElementTypeCardinalityDescription
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

StatisticsSerialPercentileExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageLocationAttributeStringType required Percentile value, e.q. "95" for the 95th percentile.
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.

StatisticsSerialPercentileNonExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageLocationAttributeStringType required Percentile value, e.q. "95" for the 95th percentile.
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.

StatisticsSerialQuartileComplexType

ElementTypeCardinalityDescription
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
value int required Quartile value, e.g. "3" for the third quartile.
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.

PeriodVaryingMeanComplexType

ElementTypeCardinalityDescription
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
inputPeriodVariable 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.

StatisticsSummaryCountComplexType

ElementTypeCardinalityDescription
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
includeMissingValues boolean required If true, then missing values count towards the total number of values. If false missing values are ignored.
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.

StatisticsSummaryCountFlagsComplexType

ElementTypeCardinalityDescription
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
reliability statisticsSerialCountFlagsReliabilityEnumStringType required Only values with the specified reliability (flag) are counted. Choose "any" to count all values regardless of their reliability.
One of: any, reliable, doubtful, non_missing_unreliable, missing
validationRule statisticsSerialCountFlagsValidationRuleEnumStringType required Only values for which the reason of rejection is equal to the specified validation rule (flagSource) are counted. Choose "any" to count all values regardless of their reason for rejection.
One of: any, none, manual, imported, modifier, extreme_values_soft_min, extreme_values_hard_min, extreme_values_soft_max, extreme_values_hard_max, rate_of_change_rise, rate_of_change_fall, same_reading, temporary_shift, oscillation, series_comparison_check, flags_comparison_check, spatialhomogeneity_check, mann_kendall_check
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.

StatisticsSummaryComplexType

ElementTypeCardinalityDescription
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.

StatisticsSummaryPercentileExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
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.

StatisticsSummaryPercentileNonExceedenceComplexType

ElementTypeCardinalityDescription
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
value floatPercentageStringType required Percentile value, e.q. "95" for the 95th percentile.
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.

StatisticsSummaryQuartileComplexType

ElementTypeCardinalityDescription
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
value int required Quartile value, e.g. "3" for the third quartile.
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.

StatisticsVerticalAverageScalarComplexType

ElementTypeCardinalityDescription
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
input InputVariableComplexType required
waterLevelReference InputVariableComplexType optional
startDepth floatStringAttributeType required doc
endDepth floatStringAttributeType required doc
startAndEndDepthIndependentOfWaterLevel boolean optional
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.

StatisticsVerticalAverageGridZLayerComplexType

ElementTypeCardinalityDescription
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
input InputVariableComplexType required
waterLevelReference InputVariableComplexType optional
startAndEndDepthIndependentOfWaterLevel boolean optional
ignoreWaterBedLevel boolean optional doc
zLayerBorder doubleStringType required · repeats
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.
startDepth floatStringType required The depth from witch the average should be calculated.
endDepth floatStringType required The depth until where the average should be calculated.

StatisticsVerticalAverageGridSigmaLayerComplexType

ElementTypeCardinalityDescription
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
input InputVariableComplexType required
totalWaterDepth 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.
startDepth floatStringType required The depth from witch the average should be calculated.
endDepth floatStringType required The depth until where the average should be calculated.

TransformationRunPeriodComplexType

ElementTypeCardinalityDescription
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.

ElementTypeCardinalityDescription
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.

ElementTypeCardinalityDescription
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.

FilterAttributeComplexType

Attributes

AttributeUseNotes
id optional
value optional

ValidationRuleComplexType

ElementTypeCardinalityDescription
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

ValuePropertyComplexType

Attributes

AttributeUseNotes
id optional
value optional

RelativePeriodComplexType

Defines a moving period in time. The start and end time are relative time to a certain time.

Attributes

AttributeUseNotes
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

ElementTypeCardinalityDescription
description string optional

ThresholdCrossingAttributesComplexType

Attributes

AttributeUseNotes
valueAttributeId optional Id the attribute that specifies the threshold value that needs to be checked whether it is crossed in the observed input and predicted in the forecast input
leadTimeAttributeId optional Id of the attribute that specifies the time window around the observed crossing in which a forecast crossing should be contained within

TimeSpanComplexType

Attributes

AttributeUseNotes
unit required
divider optional
multiplier optional

eventRangeComplexType

ElementTypeCardinalityDescription
lower eventBoundaryComplexType optional Lower boundary condition to satisfy to signal an event.
upper eventBoundaryComplexType optional Upper boundary condition to satisfy to signal an event.

TimeStepComplexType

Time step, There are 5 valid combinations of attributes. id, unit+[multiplier]+[divider]+[timeZone], times+[timeZone] + monthDays+[timeZone] ([]=optional)

Attributes

AttributeUseNotes
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

ElementTypeCardinalityDescription
description string optional Optional description of this timeStep. This is not used and is only present for convenience.

TimeSeriesSetComplexType

Attributes

AttributeUseNotes
id optional
name optional

Elements

ElementTypeCardinalityDescription
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

eventBoundaryComplexType

ElementTypeCardinalityDescription
value floatStringAttributeAndPropertyType required Constant value
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.
inclusive booleanStringAttributeAndPropertyType optional Set to true if bound is inclusive <= or >=. Default false

CalendarTimeSpanComplexType

Attributes

AttributeUseNotes
unit required
divider optional
multiplier optional

TimeShiftComplexType

Attributes

AttributeUseNotes
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

AttributeUseNotes
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

ElementTypeCardinalityDescription
description string optional

EnsembleMemberIndexRangeComplexType

Attributes

AttributeUseNotes
start required
end optional
  • Serial vs. summary is the recurring point of confusion. statisticsSerial produces a full output series — one value per output time, each from that time’s own aggregation period. statisticsSummary produces a single value at T0, over the output timeSeriesSet’s relativeViewPeriod. Reach for summary when you want one headline number (e.g. “peak flow expected this forecast”), serial when you want a resampled series.
  • statisticsPeriodic needs a cyclic output series, not just a coarser time step — the output variable must have a defined cycle period (e.g. one year), and FEWS repeats the aggregation period across every cycle in the input history to compute each output value. Configuring it like a plain aggregation (no cycle) won’t do what you expect.
  • The three location-grouped categories pick the grouping key differently: statisticsSameAttributeValue matches input/output by an equal attribute value; statisticsChildrenLocations requires output locations to have a configured parent (statistics roll up from children); statisticsRelatedLocations needs an explicit location relation, and the relation direction (input→output or output→input) must be configured on only one side — configuring both directions logs a config error.
  • statisticsEnsemble’s ignoreMissing controls whether one missing ensemble member spoils the whole output value for that time step (default: it does) — set it true deliberately if partial-ensemble statistics are acceptable for your use case.