Transformation functions — data quality, selection & control flow

This page is the generated field list for the data quality, selection & control flow transformation functions — smoothing/filtering a series, tidal review, picking specific values out of a series (peaks, lows, extremes, a time slice), summarizing discrete events, resampling at fixed points, combining multiple sources into one series, branching on a condition, and correcting values against a reference. Part of the transformation function catalogue; see that page for the shared <transformationModule>/<transformation> mechanics these all sit inside.

At a glance

Covers : filter (low-pass, Gaussian smoothing), review (tidal balance review, historical-error resampling), selection (peaks/lows/extremes, ensemble member selection, grid-to-scalar extraction — ~15 variants), events (discharge volume/duration/maximum per discrete event), sample (equidistant/day/Julian-day/single-time-step resampling), merge (~12 strategies to combine multiple input series into one — simple priority, weighted, gap-fallback, toggle, relations, synoptic, and more), conditional (critical-condition lookup), adjust (correct a computed discharge/stage against an observed reference).

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

Minimal example

Config/ModuleConfigFiles/MergePrimaryBackup 1.00 default.xml

<?xml version="1.0" encoding="UTF-8"?>
<transformationModule xmlns="http://www.wldelft.nl/fews" version="1.0">
  <transformation id="MergeGaugeSources">
    <merge>
      <simple>
        <inputVariable>
          <timeSeriesSet>
            <moduleInstanceId>ImportPrimarySensor</moduleInstanceId>
            <valueType>scalar</valueType>
            <parameterId>H.obs</parameterId>
            <locationId>Gauge01</locationId>
            <timeSeriesType>external historical</timeSeriesType>
            <timeStep unit="hour" multiplier="1"/>
            <readWriteMode>read only</readWriteMode>
          </timeSeriesSet>
        </inputVariable>
        <inputVariable>
          <timeSeriesSet>
            <moduleInstanceId>ImportBackupSensor</moduleInstanceId>
            <valueType>scalar</valueType>
            <parameterId>H.obs</parameterId>
            <locationId>Gauge01</locationId>
            <timeSeriesType>external historical</timeSeriesType>
            <timeStep unit="hour" multiplier="1"/>
            <readWriteMode>read only</readWriteMode>
          </timeSeriesSet>
        </inputVariable>
        <outputVariable>
          <timeSeriesSet>
            <moduleInstanceId>MergePrimaryBackup</moduleInstanceId>
            <valueType>scalar</valueType>
            <parameterId>H.obs</parameterId>
            <locationId>Gauge01</locationId>
            <timeSeriesType>simulated historical</timeSeriesType>
            <timeStep unit="hour" multiplier="1"/>
            <readWriteMode>add originals</readWriteMode>
          </timeSeriesSet>
        </outputVariable>
        <coefficientSet>
          <reverseOrderInputTimeSeries>false</reverseOrderInputTimeSeries>
        </coefficientSet>
      </simple>
    </merge>
  </transformation>
</transformationModule>

Field reference

Note

merge and selection together account for most of this page’s size — merge has ~12 strategies (this page’s simple, shown above, is the one most systems reach for first: earlier inputVariable entries take priority, later ones fill gaps) and selection has ~15 (peaks, lows, extremes, ensemble-member and grid-to-scalar variants). Skim the type names for your use case rather than reading top to bottom.

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

Function <filter>

Element	Type	Cardinality	Description
lowPass	FilterLowPassComplexType	required	Low pass filter for discrete functions (e.g. time series). This transformation calculates the following difference equation. y(t) = b0*x(t) + b1*x(t-1) + ... + bM*x(t-M) + a1*y(t-1) + ... + aN*y(t-N). Here x is the input, y is the output, t denotes time, b0 to bM are the feedforward coefficients and a1 to aN are the feedback coefficients.
gaussian	FilterGaussianComplexType	required	Smoothing transformation based on a gaussian function.

Function <review>

Element	Type	Cardinality	Description
tidalCorrectionByMatchingAstronomicalNumber	TidalCorrectionByAstronomicalNumberComplexType	required	This transformation corrects the events in a time series based on corrections from another time series. The events are matched by astronical number
stageReview	AdjustStageRevComplexType	required	Divides the stage into equal ranges and calculates the difference between the forecast and the measured data for each range
tidalBalanceReview	TidalBalanceReviewComplexType	required	Calculates the balance between observed and forecasted tides, creates estimates for future tides.
historicalErrorResampler	HistoricalErrorResamplerComplexType	required	Resamples error for a forecast based on historical forecasts and observations.
tidalPeakCorrection	TidalPeakCorrectionComplexType	required	Resamples error for a forecast based on historical forecasts and observations.

Function <selection>

Element	Type	Cardinality	Description
independentLows	SelectionIndependentLowsComplexType	required	Finds the low values of the input time series and writes this to the output time series.
lows	SelectionLowsComplexType	required	Finds the low values of the input time series and writes this to the output time series.
maximum	SelectionMaximumComplexType	required	Finds the maximum value of the input time series and writes this to the output time series. The maximum value will be written at the same time as in the input time series. Ignores unreliable values. If multiple values are equal to the maximum, then the latest value is used.
minimum	SelectionMinimumComplexType	required	Finds the minimum value of the input time series and writes this to the output time series. The minimum value will be written at the same time as in the input time series. Ignores unreliable values. If multiple values are equal to the minimum, then the latest value is used.
independentPeaks	SelectionIndependentPeaksComplexType	required	Finds the peak values of the input time series and writes this to the output time series.
peaks	SelectionPeaksComplexType	required	Finds the peak values of the input time series and writes this to the output time series.
timeToSelection	TimeToSelectionComplexType	required	Calculates for each timestep in the output time series the time (in minutes) to/from the nearest data point in the input time series, which typically is the result of any one of the other selection transformations.
maximumAroundPeak	MaximumAroundPeakComplexType	required	Finds for each peak time from inputPeaksVariable a maximum value from inputVariable. The maximum value is searched in a period configured with a time window
valuesAfterChangeWithTimeWindow	SelectionValuesAfterChangeWithTimeWindowComplexType	required	Since 2013.01. FEWS-8585. Copies values from the inputVariable to the outputVariable under certain conditions. The specified conditionVariable is searched for changes during the run period of the transfomation. When the conditionVariable value changes, then a time window is created. This time window starts at the time of the change. The length of the time window (in seconds) is determined by evaluating the specified timeWindowLengthExpression at the time of the change. For each change in the conditionVariable a new time window is created (time windows can overlap). If the specified selectionType is select_inside_time_window, then all inputVariable values that are within at least one time window are copied to the outputVariable and all other inputVariable values are ignored. If selectionType is select_outside_time_window then all inputVariable values that are within at least one time window are ignored and all other inputVariable values are copied to the outputVariable. This can be used e.g. to filter out measurement values during periods where the measured system is not in a (quasi) steady state due to changes happening in the system. Produces missing output values at times where there is not enough reliable or doubtful data available in the condition and/or expression variables to determine if there is a change or to determine the length of a time window. Any such missing output values are truncated from the start and end of the run period of the transformation, to avoid overwriting data from previous runs with overlapping run periods.
astronomicalNumberForPeaksAndLows	AstronomicalNumberSelectedPeakComplexType	required	Since 2016.01. This transformation should be used in combination with a transformation to calculate the peak or low for a tidal time series. For each calculated peak or low the astronomical number will be calculated.
ensembleMemberByIndex	EnsembleMemberByIndexSelectionComplexType	required	Since 2019.01. Select value of the (ensemble) time series that matches with member index of input time series
gridEnsembleMemberByIndex	SelectionGridEnsembleMemberIndexComplexType	required	Since 2020.02. This transformation function is used to calculate an output value based on a lookup table. This function uses 3 input variables to perform the lookup. Linear interpolation only, no extrapolation.Data source is csv file.
selectionScalarTimeSeriesFromScalarMap	SelectionScalarTimeSeriesFromScalarMapComplexType	required	Since 2020.02. This transformation function extracts a scalar timesSeries from a scalar map series. If a range of domain values is defined instead of one value, the average of these values will be calculated as an output.
selectionScalarTimeSeriesLayersFromScalarMap	SelectionScalarTimeSeriesLayersFromScalarMapComplexType	required	Since 2020.02. This transformation function extracts a scalar timesSeries from a scalar map series. If a range of domain values is defined instead of one value, the average of these values will be calculated as an output.
selectNumberedTidalPeaks	SelectNumberedTidalPeaksComplexType	required	Since 2020.02. This transformation function selects actual tidal peaks based on a astrological tide input.
selectNumberedTidalLows	SelectNumberedTidalLowsComplexType	required	Since 2020.02. This transformation function selects actual tidal lows based on a astrological tide input.
topographicProminencePeaks	TopographicProminencePeaksComplexType	required	Since 2020.02. This transformation function selects actual tidal lows based on a astrological tide input.

Function <events>

Element	Type	Cardinality	Description
dischargeVolume	EventsDischargeVolumeComplexType	required	Calculates either the volume or the maximum volume of the discharge values (m3/s) during the output period depending on the configured eventSelection. The volume is registered only in the output where the event started. In case of missing values, missing values are put in the output.
dischargeMeanVolume	EventsDischargeMeanVolumeComplexType	required	Calculates the mean volume of discharge events (m3/s) that started in the output period. In case of missing values, missing values are put in the output.
duration	EventsDurationComplexType	required	Calculates the duration of the events that started in the output period. If the maxGapDuration is not set to zero, periods smaller than the maxGapDuration (default 24h) will be added to the duration. In case of missing values, missing values are put in the output.
durationPerEvent	EventsDurationPerEventComplexType	required	Calculates the length of each event found in the input time series.
maximum	EventsMaximumComplexType	required	Calculates the maximum input value for events that started in the output period. In case of missing values, missing values are put in the output.
numberOfEvents	EventsNumberOfEventsComplexType	required	Counts the events that initiated in the output period. In case of missing values, missing values are put in the output.

Function <sample>

Element	Type	Cardinality	Description
daySample	DaySampleComplexType	required	Samples the input timeseries to a dayly timeseries using the time of T0 to determine the sampling moment. Output variable should be a non-equidistant simulated timeseries to accommodate shifting sampling times.
dayMonthSample	DayMonthSampleComplexType	required	Samples the input timeseries to a day month output timeseries using the day-month of T0 to determine the sampling moment. Output variable should be a non-equidistant simulated timeseries to accommodate shifting sampling times.
julianDaySample	JulianDaySampleComplexType	required	Since 2013.01. FEWS-8576. samples the input time series to the output time series using the Julian Days.
equidistant	SampleEquidistantComplexType	required	Transform equidistant to another equidistant or to nonEquidistant time series.
historical	SampleHistoricalComplexType	required
nonEquidistant	SampleNonEquidistantComplexType	required	Transform nonEquidistant to equidistant time series.
nonEquidistantSingleValue	NonEquidistantSingleValueComplexType	required	For each time step in the reference time series a value is retrieved
sampleSingleTimeStep	SampleSingleTimeStepComplexType	required	For each time step in the reference time series a value is retrieved

Function <merge>

Element	Type	Cardinality	Description
interpolation	MergeInterpolationComplexType	required	Since 2017.02. Merges input time series with different grids to a single output grid by using a configured spatial interpolation.
mean	MergeMeanComplexType	required	Merges mean time series with different time steps to a merged mean time series
relations	MergeRelationsComplexType	required	Since 2013.01. FEWS-8619: Merges input data that is defined using one or more configured relations (expressions). Each relation contains a period for which it is valid and a free format expression that is used to determine the output value for that relation. If for a given time step the first relation produces a missing value, then the next relation is used. If that also produces a missing value, then the next relation is used, and so on, until a non-missing output value is found. The output time series contains for each time step the configured output comment (optional) of the relation that was used to determine the value for that time step. If all relations produce a missing value for a given time step, then the output for that time step is a missing value.
simple	MergeSimpleComplexType	required	Merges input time series.
oneToMany	MergeOneToManyComplexType	required	Merges input time series which are allowed to have one to many relations which can lead to multiple input series per input variable
synoptic	MergeSynopticComplexType	required	Merges synoptic time series (data values that are accumulations over overlapping periods of time) to a time series with hourly data values.
toggle	MergeToggleComplexType	required	Merges input time series. If input time series contains a gap larger than maxGapLength, then it will be replaced (toggled instead of merged) with the next input time series in the hierarchy.
gap	MergeGapComplexType	required	Merges input time series. If input time series contains a gap larger than maxGapLength, then it will be replaced with the next input time series in the hierarchy.
weighted	MergeWeightedComplexType	required	Merges two input time series with weights that are a function of time.
selectLocation	MergeSelectLocationComplexType	required	Selects an input time series based on the value of an attribute.
selectDataSource	MergeSelectDataSourceComplexType	required	Selects a data source based on the value of an attribute.
copy	MergeCopyComplexType	required	Since 2021.02, copies copyFlags and/or copyFlagSourceColumns.

Function <conditional>

Element	Type	Cardinality	Description
multiple	CriticalConditionalLookupTransformationComplexType	required	This function determines if one of the configured conditions is valid, if this is the case the ruleIndex which identifies this conditions is written to the output Time Series

Function <adjust>

Element	Type	Cardinality	Description
adjustQ	AdjustQComplexType	required	Adjusts the simulated discharge values by using instantaneous discharge values and/or mean daily discharge values. If both time series are available both time series will be used in the adjustment procedure.
adjustQUsingMeanDailyDischarge	AdjustQUsingMeanDailyDischargeComplexType	required	Adjusts the simulated discharge values by using mean daily discharge values.
adjustQUsingObservedInstantaneousDischarge	AdjustQUsingObservedInstantaneousDischargeComplexType	required	Adjusts the simulated discharge values by using instantaneous discharge values.
adjustStage	AdjustStageComplexType	required	adjust the forecast with the input from stagerev
adjustTide	AdjustTideComplexType	required	Adjusts the tidal time series by using the adjustments created by operation tideBalanceReview

FilterLowPassComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
inputVariable	InputVariableComplexType	required	Input variable (x). If one or more of the required (previous) input values for a calculation are NaN, then the output value will be NaN.
outputVariable	OutputVariableComplexType	required	Output variable (y). If one or more of the required previous output values for a calculation are NaN, then these will be ignored, effectively this means that it behaves as if all previous NaN output values would be 0.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	FilterLowPassCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	FilterLowPassCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

FilterGaussianComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
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.
coefficientSet	FilterGaussianCoefficientSetComplexType	required · repeats	CoefficientSet wich can be used to configure the bandwidth
coefficientSetFunctions	FilterGaussianCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

TidalCorrectionByAstronomicalNumberComplexType

Calculates the balance between observed and forecasted tides and creates estimates for future tides.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
modelCorrections	InputVariableComplexType	required
modelOutput	InputVariableComplexType	required
correctionTimeLocationAttribute	idStringType	optional	The calculated astronomical number can be corrected based on the value of the configured location attribute
correctedModelOutput	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.

AdjustStageRevComplexType

Divides the stage into equal ranges and calculates the difference between the forecast and the measurements for each range

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
observedStage	InputVariableComplexType	required	Input variable with the observed stage (water level) values.
forecastStage	InputVariableComplexType	required	Input variable with the computed stage (water level) values.
averageBalanceFirstSegment	OutputVariableComplexType	required	Balance for the first segment. The first segment is segment with the lowest stage ranges
averageBalanceSecondSegment	OutputVariableComplexType	required	Balance for the second segment
averageBalanceThirdSegment	OutputVariableComplexType	required	Balance for the third segment
averageBalanceFourthSegment	OutputVariableComplexType	required	Balance for the fourth segment
startFirstStageRange	OutputVariableComplexType	required	start of the first segment
startSecondStageRange	OutputVariableComplexType	required	end of the first segment and the start of the second segment
startThirdStageRange	OutputVariableComplexType	required	start of the third segment
startFourthStageRange	OutputVariableComplexType	required	start of the fourth segment
endFourthStageRange	OutputVariableComplexType	required	end of the fourth segment
maxDifference	float	optional	If the difference between the forecast stage and the observed stage is larger then the maxDifference this difference will not be used for the calculation of the average balance.
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.

TidalBalanceReviewComplexType

Calculates the balance between observed and forecasted tides and creates estimates for future tides.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
observedTidalStage	InputVariableComplexType	required
forecastTidalStage	InputVariableComplexType	required
tideBalance	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.

HistoricalErrorResamplerComplexType

Resamples error for a forecast based on historical forecasts and observations.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	The TimeSeries (forecast) to be resampled.
historicalSimulatedInputVariable	InputVariableComplexType	required	Used in combination with historicalObservedVariable to determine the error at the historical match.
historicalObservedInputVariable	InputVariableComplexType	required	Used in combination with historicalSimulatedVariable to determine the error at the historical match.
historicalStartDate	DateTimeComplexType	required	The start date and time for the period in which is searched for a historical match. This has effect on both the historicalSimulatedVariable and historicalObservedVariable, but also on all featureVectorHistoricalSimulatedVariable elements.
historicalEndDate	DateTimeComplexType	required	The end date and time for the period in which is searched for a historical match. This has effect on both the historicalSimulatedVariable and historicalObservedVariable, but also on all featureVectorHistoricalSimulatedVariable elements.
nearestNeighborPoolSize	nonNegativeInteger	required	When searching for the historical match, X closest neighbours are used of which one is randomly selected. X is the nearestNeighbourPoolSize.
resamplingTrigger	nonNegativeDouble	required	After the historical match has been determined, the feature vector distance between historical match and the forecast date is calculated. If the feature factor distance between the next forecast date (forecast date + X timesteps) and the historical match (hisorical match + X timesteps) is greater then the distance between the forecast date and historical match times the resampling trigger, a new historical match will be searched. Otherwise, the error at the histrical match will be used for the forecast date + X timeSteps.
attributeLocationId	idStringType	required	The locationId is used as a reference location for use with modifiers. All weights and timeshift are associated with this locationId.
outputVariable	OutputVariableComplexType	required	The input forecast with uncertainty added.
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.
featureVectorHistoricalSimulatedInputVariable	InputVariableComplexType	required	Variable used to compare to the forecast date to calculate the feature vector distance.
featureVectorForecastInputVariable	InputVariableComplexType	required	Variable used to compare to the historical dates (potential historical matches) to calculate the feature vector distance.
featureVectorWeight	floatStringAttributeType	required	The weight that is used for this dimension when calculating the direction and magnitude of the feature vector.
featureVectorTimeShift	intStringAttributeType	required	Shifts the time for both the historical simulated and forecast variable with X time steps for this feature vector dimension only.

TidalPeakCorrectionComplexType

Resamples error for a forecast based on historical forecasts and observations.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputObservedPeakVariable	InputVariableComplexType	required	Observed peaks
inputAstroVariable	InputVariableComplexType	required	Predicted astronomical
inputAstroPeakVariable	InputVariableComplexType	required	Predicted astronomical peaks
inputSurgeForecastVariable	InputVariableComplexType	required	Multiple forecast input variable
surgeSearchPeriod	RelativePeriodComplexType	required	Period for which the surge forecasts should have their forecast time within
peak	PeakCorrectionComplexType	required · repeats	Specifies which peaks should be included in the calculation.
correctionConstantAttributeId	idStringType	required	Id of location attribute which contains the constant value that needs to be added to the correction value.
inputPeakSelectionVariable	tidalPeakCorrectionInputSelectionEnumStringType	required	Variable that should be used to select the peaks, either observed or astro One of: observed, astro
inputTimeSelectionVariable	tidalPeakCorrectionInputSelectionEnumStringType	required	Variable that should be used to select the exact time of the peaks, either observed or astro One of: observed, astro
outputPeak	OutputPeakCorrectionComplexType	optional	Settings for output peak, like peakNumber which determines to which peak after T0 the correction should be applied
outputVariable	OutputVariableComplexType	required	Correction value suggested for the next peak prediction
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.

SelectionIndependentLowsComplexType

Finds the low values of the input time series and writes this to the output time series.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required
forecastLoopSearchPeriod	RelativePeriodComplexType	optional	Period in which forecasts should be searched to loop over
gapLengthInSec	nonNegativeInteger	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.
totalNumber	positiveInteger	required	total number of elements
totalNumberBeforeT0	nonNegativeInteger	required	total number of elements before time zero
totalNumberAfterT0	nonNegativeInteger	required	total number of elements after time zero
skipJustBeforeT0	nonNegativeInteger	optional	number of elements to skip just before time zero
skipJustAfterT0	nonNegativeInteger	optional	number of elements to skip just after time zero

SelectionLowsComplexType

Finds the low values of the input time series and writes this to the output time series.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required
outputVariable	OutputVariableComplexType	required
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
totalNumber	positiveInteger	required	total number of elements
totalNumberBeforeT0	nonNegativeInteger	required	total number of elements before time zero
totalNumberAfterT0	nonNegativeInteger	required	total number of elements after time zero
skipJustBeforeT0	nonNegativeInteger	optional	number of elements to skip just before time zero
skipJustAfterT0	nonNegativeInteger	optional	number of elements to skip just after time zero

SelectionMaximumComplexType

Finds the maximum value of the input time series and writes this to the output time series. The maximum value will be written at the same time as in the input time series. Ignores unreliable values. If multiple values are equal to the maximum, then the latest value is used.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required
selectNumberOfHighestMax	positiveInteger	optional	The number of highest maximum values to write to the output 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.

SelectionMinimumComplexType

Finds the minimum value of the input time series and writes this to the output time series. The minimum value will be written at the same time as in the input time series. Ignores unreliable values. If multiple values are equal to the minimum, then the latest value is used.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required
selectNumberOfLowestMin	positiveInteger	optional	The number of lowest minimum values to write to the output 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.

SelectionIndependentPeaksComplexType

Finds the peak values of the input time series and writes this to the output time series.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required
forecastLoopSearchPeriod	RelativePeriodComplexType	optional	Period in which forecasts should be searched to loop over
gapLengthInSec	nonNegativeIntegerStringType	required	gap length in seconds
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.
totalNumber	positiveInteger	required	total number of elements
totalNumberBeforeT0	nonNegativeInteger	required	total number of elements before time zero
totalNumberAfterT0	nonNegativeInteger	required	total number of elements after time zero
skipJustBeforeT0	nonNegativeInteger	optional	number of elements to skip just before time zero
skipJustAfterT0	nonNegativeInteger	optional	number of elements to skip just after time zero

SelectionPeaksComplexType

Finds the peak values of the input time series and writes this to the output time series.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required
outputVariable	OutputVariableComplexType	required
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
totalNumber	positiveInteger	required	total number of elements
totalNumberBeforeT0	nonNegativeInteger	required	total number of elements before time zero
totalNumberAfterT0	nonNegativeInteger	required	total number of elements after time zero
skipJustBeforeT0	nonNegativeInteger	optional	number of elements to skip just before time zero
skipJustAfterT0	nonNegativeInteger	optional	number of elements to skip just after time zero

TimeToSelectionComplexType

Calculates for each timestep in the output time series the time (in minutes) to/from the nearest data point in the input time series, which typically is the result of any one of the other selection transformations.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required
outputVariable	OutputVariableComplexType	required
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

MaximumAroundPeakComplexType

Finds for each peak time from inputPeaksVariable a maximum value from inputVariable. The maximum value is searched in a period configured with searchWindowInDays

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Series the maximum value should be searched in
inputPeaksVariable	InputVariableComplexType	required	Nonequidistant series with peaks
maximumAtActualTime	OutputVariableComplexType	required	Nonequidistant series with maximum values found. The maximum values are stored at actual time of the max value.
maximumAtPeakTime	OutputVariableComplexType	optional	Nonequidistant series with maximum values found. The maximum values are stored at peak times
valueDifference	OutputVariableComplexType	optional	Nonequidistant series with differences between the input peaks and the maximum found for the peaks. The value difference is stored at peak time.
timeDifference	OutputVariableComplexType	optional	Nonequidistant series with differences between the input peak times and the times of the found maximum. The time difference is stored at peak time. If 'timeWindow' is used, the values are stored in millis. If 'timeWindowInWholeDays' is use the values are stored in whole days.
className	nameStringType	optional
timeWindow	TimeSpanComplexType	required	The maximum will be searched in this period : 'time of the peak - timeWindow' up to and including 'time of the peak + timeWindow'
timeWindowInWholeDays	nonNegativeInteger	required	The maximum will be searched in this period : 'day of the peak - timeWindowInWholeDays' up to and including 'day of the peak + timeWindowInWholeDays'

SelectionValuesAfterChangeWithTimeWindowComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
variableDefinition	InputVariableExpressionBasedFunctionComplexType	optional · repeats	Definitions of variables that can be used as input in this transformation. A variable is always a time series. Alternatively variables can be defined at the start of this transformations file. The variables that are defined here can be used as inputVariable, as conditionVariable, as outputVariable and/or in the timeWindowLengthExpression.
inputVariable	InputVariableComplexType	required	Input variable. This contains the times and values that are copied to the output variable if they are selected by this transformation.
conditionVariable	InputVariableComplexType	required	This condition variable is searched for changes during the run period of the transfomation. If for a given timeStep this variable has a value that is different from the value for the previous timeStep, then that counts as a change for the given timeStep. This triggers the creation of a selection time window that starts at the given timeStep.
timeWindowLengthExpression	string	required	Free format expression that is evaluated at the time of a change in the condition variable to determine the length of the time window (in seconds) for that change. For instance "X1 + X2". In the expression reference input variables or coefficients using their id, e.g. "X1 + a" where "X1" is the variableId of a variable and "a" is the id of a coefficient. Variables can be defined in this transformation or at the start of this transformations file. If a variable definition in this transformation has the same id as a variable definition at the start of this transformations file, then the variable definition in this transformation is used. Coefficients can be defined in a coefficientSet.
selectionType	selectionValuesAfterChangeWithTimeWindowSelectionEnumStringType	required	If this is select_inside_time_window, then all inputVariable values that are within at least one time window are copied to the outputVariable and all other inputVariable values are ignored. If this is select_outside_time_window then all inputVariable values that are within at least one time window are ignored and all other inputVariable values are copied to the outputVariable. One of: select_inside_time_window, select_outside_time_window
outputVariable	OutputVariableComplexType	required	Output variable. Only the selected times and values are written in this outputVariable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	ExpressionCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	ExpressionCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

AstronomicalNumberSelectedPeakComplexType

Calculates the astronomical number for each selected peak or low

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
selectedPeaksAndLows	InputVariableComplexType	required	Input series with peaks and low
correctionTimeLocationAttribute	idStringType	optional	The calculated astronomical number can be corrected based on the value of the configured location attribute
astronomicalNumber	OutputVariableComplexType	optional	Output time series with the calculated astronomical number
className	nameStringType	optional

EnsembleMemberByIndexSelectionComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
memberIndex	InputVariableComplexType	required
ensemble	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.

SelectionGridEnsembleMemberIndexComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputEnsembleIndices	InputVariableComplexType	required
inputTimeSeriesGrids	InputVariableComplexType	required
output	OutputVariableComplexType	required
matchInputAndOutputGridTimes	boolean	optional	The time of the output time series is determined by the time of the ensemble member indices. It can happen that the input grids do not have data at the given time. If matchInputAndOutputGridTimes is set to false, and the exact time step is unavailable, the first available grid data of the given ensemble member will be filled in the output. If it is set to true, output will only be filled if the data is available for the exact time.
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.

SelectionScalarTimeSeriesFromScalarMapComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
input	InputVariableComplexType	required
output	OutputVariableComplexType	required
minDomainValue	float	required	The minimum domain vale to be included in the selection.
maxDomainValue	float	required	The maximum domain vale to be included in the selection.
minValueInclusive	boolean	optional
maxValueInclusive	boolean	optional
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.

SelectionScalarTimeSeriesLayersFromScalarMapComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
input	InputVariableComplexType	required
layerIndex	int	required	Layers are counted from the highest Z coordinate (water surface) towards to lowest (water bottom) starting with 1.
output	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.

SelectNumberedTidalPeaksComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
numberedTidalPeaks	InputVariableComplexType	required	: non-equidistant input series holding the tidal numbers
continuousLevelSeries	InputVariableComplexType	required	equidistant input series holding the water levels
highWaterLevelOutput	OutputVariableComplexType	required	non-equidistant output series holding the waterlevels at the peak
highWaterTideNumberOutput	OutputVariableComplexType	required	non-equidistant output series holding the associated tidal number of the peak
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.
minutesBeforeTidalExtreme	int	required	Search window before tidal extreme in minutes
minutesBeforeTidalExtremeAttributeId	idStringType	required	The id of the location attribute to be used as search window before tidal extreme. Value should be in minutes.
minutesAfterTidalExtreme	int	required	Search window after tidal extreme in minutes
minutesAfterTidalExtremeAttributeId	idStringType	required	The id of the location attribute to be used as search window after tidal extreme. Value should be in minutes.
regressionPeriodInMinutes	int	required	time span used to compute the average rate of waterlevel change. The extreme has been reached when the sign flips for the rate of change
regressionPeriodInMinutesAttributeId	idStringType	required	The id of the location attribute to be used as time span to compute the average rate of waterlevel change. The extreme has been reached when the sign flips for the rate of change
validDifferenceExceedence	float	required	Extreme is valid and selected when specified difference is exceeded by at least one value within the search window both before and after the extreme.
validDifferenceExceedenceAttributeId	idStringType	required	The id of the location attribute to be used as validDifferenceExceedence. Extreme is valid and selected when specified difference is exceeded by at least one value within the search window both before and after the extreme.

SelectNumberedTidalLowsComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
numberedTidalLows	InputVariableComplexType	required	Non-equidistant input series holding the tidal numbers.
continuousLevelSeries	InputVariableComplexType	required	Equidistant input series holding the water levels.
lowWaterLevelOutput	OutputVariableComplexType	required	Non-equidistant output series holding the waterlevels at the low.
lowWaterTideNumberOutput	OutputVariableComplexType	required	Non-equidistant output series holding the associated tidal number of the low.
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.
minutesBeforeTidalExtreme	int	required	Search window before tidal extreme in minutes
minutesBeforeTidalExtremeAttributeId	idStringType	required	The id of the location attribute to be used as search window before tidal extreme. Value should be in minutes.
minutesAfterTidalExtreme	int	required	Search window after tidal extreme in minutes
minutesAfterTidalExtremeAttributeId	idStringType	required	The id of the location attribute to be used as search window after tidal extreme. Value should be in minutes.
regressionPeriodInMinutes	int	required	time span used to compute the average rate of waterlevel change. The extreme has been reached when the sign flips for the rate of change
regressionPeriodInMinutesAttributeId	idStringType	required	The id of the location attribute to be used as time span to compute the average rate of waterlevel change. The extreme has been reached when the sign flips for the rate of change
validDifferenceExceedence	float	required	Extreme is valid and selected when specified difference is exceeded by at least one value within the search window both before and after the extreme.
validDifferenceExceedenceAttributeId	idStringType	required	The id of the location attribute to be used as validDifferenceExceedence. Extreme is valid and selected when specified difference is exceeded by at least one value within the search window both before and after the extreme.

TopographicProminencePeaksComplexType

Finds the peak values of the input time series based on topographic prominence and writes this to the output time series.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required
minimumPeakValueFunction	string	optional	Optional location dependent minimum peak value function that can containt location attribute ids, e.g. @DEFAULT_VALUE@. If an attribute is missing for a location, then the default value will be 0 for that location. When element is not defined also 0 will be used.
minimumProminenceFunction	string	required	Location dependent minimum prominence function that can contain location attribute ids, e.g. @DEFAULT_VALUE@. If an attribute is missing for a location, then the default value will be 0 for that location. Peaks with prominence lower than the minimum will be filtered out but the highest peak will always remain. For explanation on topographic prominence see https://en.wikipedia.org/wiki/Topographic_prominence
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.

EventsDischargeVolumeComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
discharge	InputVariableComplexType	required	Input variable with instanteous discharge flow values (m3/s).
eventSelection	eventsDischargeEventsVolumeEventSelectionEnumStringType	required	Selects either the total volume or the volume of the event with the largest volume. One of: all_events, largest_volume_event
maxGapDuration	TimeSpanComplexType	optional	If the timespan between consecutive events (input value below the threshold inbetween) is shorter than this value, these events will be dealt with as one event. If not specified, a maxGapDuration of 24 hours is used for this value as default.
threshold	float	optional	Threshold level above which values are considered to be part of an event.
volume	OutputVariableComplexType	required	Output variable with total volume or the volume of the event with the largest volume.
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.

EventsDischargeMeanVolumeComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
discharge	InputVariableComplexType	required	Input variable with instanteous discharge flow values (m3/s).
maxGapDuration	TimeSpanComplexType	optional	If the timespan between consecutive events (input value below the threshold inbetween) is shorter than this value, these events will be dealt with as one event. If not specified, a maxGapDuration of 24 hours is used for this value as default.
threshold	float	optional	Threshold level above which values are considered to be part of an event.
meanVolume	OutputVariableComplexType	required	Output variable containing the mean volume (m3) per event.
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.

EventsDurationComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
input	InputVariableComplexType	required	Input variable.
maxGapDuration	TimeSpanComplexType	optional	If the timespan between consecutive events (input value below the threshold inbetween) is shorter than this value, these events will be dealt with as one event. If not specified, a maxGapDuration of 24 hours is used for this value as default.
threshold	float	optional	Threshold level above which values are considered to be part of an event.
outputTimeUnit	timeUnitEnumStringType	optional	Time unit for the output (default day). One of: second, minute, hour, day, week
output	OutputVariableComplexType	required	Output variable containing the duration of the events, taking into account the maxGapDuration.
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.

EventsDurationPerEventComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
input	InputVariableComplexType	required	Input variable.
outputTime	eventsDurationPerEventOutputTimeEnumStringType	required	Determines if the length of the event is written to the output timeseries at the beginning of the event or at the end of the event. One of: startEvent, endEvent
outputUnit	eventsDurationPerEventOutputUnitEnumStringType	required	Time unit for the output values. One of: numberOfTimeSteps, seconds
maxGapDuration	TimeSpanComplexType	optional	If the timespan between consecutive events (input value above the threshold inbetween) is shorter than this value, these events will be dealt with as one event.
threshold	float	optional	Threshold level above which values are considered to be part of an event.
output	OutputVariableComplexType	required	Output variable containing the duration of the events.
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.

EventsMaximumComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
input	InputVariableComplexType	required	Input variable.
maxGapDuration	TimeSpanComplexType	optional	If the timespan between consecutive events (input value below the threshold inbetween) is shorter than this value, these events will be dealt with as one event. If not specified, a maxGapDuration of 24 hours is used for this value as default.
threshold	float	optional	Threshold level above which values are considered to be part of an event.
output	OutputVariableComplexType	required	Output variable containing the maximum value.
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.

EventsNumberOfEventsComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
input	InputVariableComplexType	required	Input variable.
maxGapDuration	TimeSpanComplexType	optional	If the timespan between consecutive events (input value below the threshold inbetween) is shorter than this value, these events will be dealt with as one event. If not specified, a maxGapDuration of 24 hours is used for this value as default.
threshold	float	optional	Threshold level above which values are considered to be part of an event.
output	OutputVariableComplexType	required	Output variable containing the number of events.
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.

DaySampleComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	input time series
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DayMonthSampleComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	input time series
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

JulianDaySampleComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	input time series
julianDayVariable	InputVariableComplexType	required	series with Julian Days
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	The sampling 'instruction' is provided as a series where the value refers to (historical) dates in JulianDay. These Julian Days are used to extract the associated data from the input timeseries and place it in the output timeseries using the corresponding timestamp.

SampleEquidistantComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
equidistantInputVariable	InputVariableComplexType	required	time series which will be transformed to a non-equidistant time series
timeReferenceInputVariable	InputVariableComplexType	required	This variable defines the time steps which will be written to the output time series
forecastLoopSearchPeriod	RelativePeriodComplexType	optional	Period in which forecasts should be searched to loop over
interpolationType	sampleEquidistantInterpolationTypeEnumStringType	required	One of: closest, closestForward, closestBackward, linear, missing
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 or unreliable. Default is true.
timeWindow	TimeSpanComplexType	optional	This optional variable defines a time window in which the closest times, found in the original series, should lie. This time window is related to the time in the outputseries we search the values for. E.g. for interpolationType 'closest' we search in the period from timeOut-timeWindow to timeOut+timeWindow, where the timeOut is a time in the output series.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

SampleHistoricalComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
moduleParameterFile	nameStringType	optional	reference to a module parameter file which can be modified in the mods-display
inputVariable	InputVariableComplexType	required	Input variable.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
moduleParameterFile	nameStringType	required	reference to a module parameter file which can be modified in the mods-display
startYear	gYear	required	Year to start ensemble sampling.
firstEnsembleMemberIndex	int	optional	First ensembleMemberIndex
ensembleMemberCount	int	optional	Number of ensemble members to generate. If this option is not configured, this number will be calculated. The user formula will be T0 - start year = number of ensemble members
startWaterYear	monthDayType	optional	First day of the water year. For example in the USA the water year start at the first of October. The start year is considered a water year when this option is used.

SampleNonEquidistantComplexType

Transform nonEquidistant to equidistant time series.

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
nonEquidistantInputVariable	InputVariableComplexType	required	Input variable.
interpolationType	sampleNonEquidistantInterpolationTypeEnumStringType	required	One of: block, linear, zero, missing, linearOrClosest, previousTimeStep, nextTimeStep, accumulate, timeWeightedAverage
searchPeriod	RelativePeriodComplexType	optional	Relative period in which the transformation will search for non equidistant values. Only implemented for linear or closest.
maxGapLength	TimeSpanComplexType	optional	Optional maximum length of gap. Gaps equal to or smaller than maxGapLength will be filled with sampled values. Gaps larger than maxGapLength will not be filled. If maxGapLength is not defined, then all gaps will be filled with sampled values. Only implemented for linear and block interpolation
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
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 or unreliable. Default is true.
validationRule	ValidationRuleComplexType	optional · repeats	Since 2013.01. FEWS-8586

NonEquidistantSingleValueComplexType

Transform nonEquidistant to equidistant time series. Each value in the input time series is copied only one time to the output

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable containing the values which will be copied to the output time series
timeReferenceInputVariable	InputVariableComplexType	required	Input variable containing the times for the output time series
outputVariable	OutputVariableComplexType	required	output variable
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

SampleSingleTimeStepComplexType

Copy the values (grid or scalar) from a source with only 1 time step to all the time steps in the output time series

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable containing the values which will be copied to the output time series
outputVariable	OutputVariableComplexType	required	output variable
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

MergeInterpolationComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
inputVariable	InputVariableComplexType	required · repeats	One or more input variables to merge.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
closestDistance	MergeInterpolationClosestDistanceComplexType	required
interpolationType	MergeInterpolationTypeEnumStringType	required	One of: bilinear, closestDistance

MergeMeanComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
input	InputVariableComplexType	required · repeats	Input time series with mean data
outputPreviousRun	InputVariableComplexType	required
missingValuesNotAllowed	MergeMeanMissingValuesNotAllowedComplexType	optional
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.

MergeRelationsComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
inputVariableDefinition	InputVariableExpressionBasedFunctionComplexType	optional · repeats	Definitions of variables that can be used as input in one or more relations in this transformation. A variable is always a time series. Alternatively variables can be defined at the start of this transformations file.
relation	MergeRelationsRelationComplexType	required · repeats	One or more relations (expressions). Each relation contains an optional period for which it is valid, a free format expression that is used to determine the output value for the relation and an optional output comment. If for a given time step the first relation produces a missing value, then the next relation is used. If that also produces a missing value, then the next relation is used, and so on, until a non-missing output value is found.
outputVariable	OutputVariableComplexType	required	Output variable for the merged output time series. The output time series contains for each time step the configured output comment of the relation that was used to determine the value for that time step.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	ExpressionCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variable. Ranges should not overlap.
coefficientSetFunctions	ExpressionCoefficientSetFunctionsComplexType	required	A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

MergeSimpleComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
inputVariable	MergeSimpleInputVariableComplexType	required · repeats	One or more input variables to merge.
fillGapConstant	float	optional	Optional constant to fill gaps containing unreliable or missing values that are still present after merge.
outputVariable	OutputVariableComplexType	required	Output variable.
indexUsedInputVariable	OutputVariableComplexType	optional	Output variable which stores the index of the used input time series.
copyCommentWhenMissing	boolean	optional	concatenates and copies comments to output variable only when output value is missing.
keepManualUnreliables	boolean	optional	If true, values that have manualy been set to unreliable are kept. If se to false manual unreliables are seen as missings.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
coefficientSet	MergeSimpleCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variables. Ranges should not overlap.
moduleParameterFile	nameStringType	required	reference to a module parameter file which can be modified in the mods-display
reverseOrderAttributeId	idStringType	required	Since 2018.02 Define a boolean attribute which can be used to revert the merge order.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

MergeOneToManyComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
inputVariable	MergeSimpleInputVariableComplexType	required	One or more input variables to merge.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

MergeSynopticComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
synopticPrecipitation	InputVariableComplexType	required · repeats	Input variables with synoptic rainfall data. The time interval of data values is defined by the timeStep or by the aggregationPeriod.
precipitationOneHour	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.

MergeToggleComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required · repeats	One or more input variables to merge.
maxGapLength	TimeSpanComplexType	required	If input time series contains a gap larger than maxGapLength, then it will be replaced (instead of merged) with the next input time series in the hierarchy.
fillGapConstant	float	optional	Optional constant to fill gaps containing unreliable or missing values that are still present after merge or toggle.
indexUsedInputTimeSeries	OutputVariableComplexType	required	Variable to store the index of the input time series that is used for the value in the output time series for each time step. 1 for the first, 2 for the second, etc. Requested in issue FEWS-320.
mergedTimeSeries	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.

MergeGapComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required · repeats	One or more input variables to merge.
minimumGapLength	TimeSpanComplexType	required	If input time series contains a gap larger than minimumGapLength, then it will be replaced (instead of merged) with the next input time series in the hierarchy.
fillGapConstant	float	optional	Optional constant to fill gaps containing unreliable or missing values that are still present after merge or toggle.
indexUsedInputTimeSeries	OutputVariableComplexType	required	Variable to store the index of the input time series that is used for the value in the output time series for each time step. 1 for the first, 2 for the second, etc. Requested in issue FEWS-320.
mergedTimeSeries	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.
fillEndGap	booleanStringType	optional	Optional element to allow the filling of gaps at the end of a series. Available since 2026.02.

MergeWeightedComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
inputVariable	InputVariableComplexType	required · repeats	Two input variables to merge.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
moduleParameterFile	nameStringType	required	reference to a module parameter file which can be modified in the mods-display
coefficientSet	MergeWeightedCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variables. Ranges should not overlap.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

MergeSelectLocationComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
input	InputVariableComplexType	required · repeats	the input
attributeFunctionId	idStringType	required
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.

MergeSelectDataSourceComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
input	InputVariableComplexType	required · repeats	the input
attributeFunctionId	idStringType	required	The attributeFunctionId will reference the value of the attribute for the current output location
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.

MergeCopyComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
input	InputVariableComplexType	required · repeats	the input
skipProperties	boolean	optional	skip copying the properties in the output - optional, by default properties are copied.
skipFlags	boolean	optional	skip copying the flags in the output - optional, by default flags are copied.
skipFlagsSourceColumns	boolean	optional	skip copying the flag source columns in the output - optional, by default flag source columns are copied.
skipFlagSources	boolean	optional	skip copying the flag sources in the output - optional, by default flag sources are copied.
skipComments	boolean	optional	skip copying the comments in the output - optional, by default comments are copied.
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.

CriticalConditionalLookupTransformationComplexType

if a default value cannot be found in the rules criteria, an output value is searched in the lookup table

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariableDefinition	InputVariableExpressionBasedFunctionComplexType	optional · repeats	Definitions of variables that can be used as input in this transformation. A variable is always a time series. Alternatively variables can be defined at the start of this transformations file.
criticalConditionLookup	CriticalConditionLookUpComplexType	required
defaultValue	RuleCriteriasComplexType	optional
outputVariable	OutputVariableComplexType	required
reportAllConditions	boolean	optional	Optional element to disable reporting of all conditions. Default is true. Set to false to disable warnings.
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.

AdjustQComplexType

adjusts the simulated discharge values with observed discharge data

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
correctNegativeFlowValuesToZero	boolean	optional
observedInstantaneousDischarge	InputVariableComplexType	required
observedMeanDailyDischarge	InputVariableComplexType	required
simulatedDischarge	InputVariableComplexType	required
adjustedSimulatedDischarge	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.
coefficientSet	AdjustQCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variables. Ranges should not overlap.
coefficientSetFunctions	AdjustQCoefficientSetFunctionsComplexType	required	Since 2014.01. A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
moduleParameterFile	nameStringType	required	reference to a module parameter file which can be modified in the mods-display
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

AdjustQUsingMeanDailyDischargeComplexType

Adjusts the simulated discharge values with a adjustment method which uses mean daily discharge values

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
observedMeanDailyDischarge	InputVariableComplexType	required
simulatedDischarge	InputVariableComplexType	required
adjustedSimulatedDischarge	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.
coefficientSet	AdjustQUsingMeanDailyDischargeCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variables. Ranges should not overlap.
coefficientSetFunctions	AdjustQUsingMeanDailyDischargeCoefficientSetFunctionsComplexType	required	Since 2014.01. A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

AdjustQUsingObservedInstantaneousDischargeComplexType

interpolates the missing values in the observed data with simulated data

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
correctNegativeFlowValuesToZero	boolean	optional
observedDischarge	InputVariableComplexType	required
simulatedInstantaneousDischarge	InputVariableComplexType	required
adjustedForecastDischarge	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.
coefficientSet	AdjustQUsingInstantaneousDischargeCoefficientSetComplexType	required · repeats	One or more coefficientSets that are valid for different ranges of the defined limit variables. Ranges should not overlap.
coefficientSetFunctions	AdjustQUsingInstantaneousDischargeCoefficientSetFunctionsComplexType	required	Since 2014.01. A coefficientSetFunctions object. This is similar to a coefficientSet object, only the value elements are replaced by function elements. A function is an expression, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated after replacing the tags by actual values. These values can be different for different locations and time periods.
moduleParameterFile	nameStringType	required	reference to a module parameter file which can be modified in the mods-display
coefficientSetId	idStringType	required	Identifier of a coefficientSet to use. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension. CoefficientSets are defined in a transformationCoefficientSets file in the CoefficientSetsFiles directory.

AdjustStageComplexType

Adjusts the computed stage values with the input from stage rev

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
forecastStage	InputVariableComplexType	required	Input variable with the computed stage (water level) values.
averageBalanceFirstSegment	InputVariableComplexType	required	Balance for the first segment. The first segment is segment with the lowest stage ranges
averageBalanceSecondSegment	InputVariableComplexType	required	Balance for the second segment
averageBalanceThirdSegment	InputVariableComplexType	required	Balance for the third segment
averageBalanceFourthSegment	InputVariableComplexType	required	Balance for the fourth segment
startFirstStageRange	InputVariableComplexType	required	start of the first segment
startSecondStageRange	InputVariableComplexType	required	end of the first segment and the start of the second segment
startThirdStageRange	InputVariableComplexType	required	start of the third segment
startFourthStageRange	InputVariableComplexType	required	start of the fourth segment
endFourthStageRange	InputVariableComplexType	required	end of the fourth segment
adjustedForecastStage	OutputVariableComplexType	required	end of the fourth segment
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.

AdjustTideComplexType

adjusts the tidal time series by using the output from tideBalanceReview

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
limitVariable	InputVariableComplexType	optional	Optional limit variable. For each time step the value of this variable is checked against the limiting ranges defined in coefficientSets to determine which coefficientSet is used for that time step. A limit variable has to be a scalar variable.
observedTidalStage	InputVariableComplexType	required
forecastTidalStage	InputVariableComplexType	required
tideBalance	InputVariableComplexType	required
adjustedTidalStage	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.

TransformationRunPeriodComplexType

Element	Type	Cardinality	Description
relativePeriod	RelativePeriodComplexType	required
cardinalTimeStep	TimeStepComplexType	required	Aligns the start and end time of the run period of the transformation with this time step.
extendStart	boolean	required	Determines whether the start of the run period of the transformation should be extended or cropped to match the cardinal time step
extendEnd	boolean	required	Determines whether the end of the run period of the transformation should be extended or cropped to match the cardinal time step
startMonthDay	monthDayType	required
endMonthDay	monthDayType	required

InputVariableComplexType

Choose between a reference to a variable or an embedded definition of a variable.

Element	Type	Cardinality	Description
variableId	idStringType	required	Identifier of a variable to use.
locationId	idStringType	optional	If the specified variable contains multiple locations, then specify the location to use here.
timeSeriesSet	TimeSeriesSetComplexType	required	A time series set that can be used as input or as output for a transformation function.
convertDatum	boolean	optional	If true, then this time series is converted from local to ordnance datum level before a transformation and back to local datum level after the transformation. Default is false.
checkMissing	boolean	optional	Option to check this timeseries for missing values. This option works in combination with the Parameter flag 'allowMissing', which can be set for a parameter in the parameters.xml configuration file. If for a given parameter allowMissing is false and checkMissing is true, then the transformation throws an exception when there are missing values for this parameter. When omitted defaults to 'false'. For grid data this option only checks whether the entire grid contains missing values or not, i.e. individual cells can still have missing values as long as there are other cells with non-missing values in the grid for the same time step.

OutputVariableComplexType

Choose between a reference to a variable or an embedded definition of a variable.

Element	Type	Cardinality	Description
variableId	idStringType	required	Identifier of a variable to use.
locationId	idStringType	optional	If the specified variable contains multiple locations, then specify the location to use here.
timeSeriesSet	TimeSeriesSetComplexType	required	A time series set that can be used as input or as output for a transformation function.
convertDatum	boolean	optional	If true, then this time series is converted from local to ordnance datum level before a transformation and back to local datum level after the transformation. Default is false.
checkMissing	boolean	optional	Option to check this timeseries for missing values. This option works in combination with the Parameter flag 'allowMissing', which can be set for a parameter in the parameters.xml configuration file. If for a given parameter allowMissing is false and checkMissing is true, then the transformation throws an exception when there are missing values for this parameter. When omitted defaults to 'false'. For grid data this option only checks whether the entire grid contains missing values or not, i.e. individual cells can still have missing values as long as there are other cells with non-missing values in the grid for the same time step.

FilterLowPassCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
a	float	required · repeats	One or more feedback coefficients (a1 to aN).
b	float	required · repeats	One or more feed forward coefficients (b0 to bM).

FilterLowPassCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
a	string	required · repeats	One or more feedback coefficients (a1 to aN).
b	string	required · repeats	One or more feed forward coefficients (b0 to bM).

FilterGaussianCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
bandWidth	float	required

FilterGaussianCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
bandWidth	string	required

DateTimeComplexType

Attributes

Attribute	Use	Notes
date	required
time	optional

RelativePeriodComplexType

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

Attributes

Attribute	Use	Notes
start	required
end	required
startOverrulable	optional	default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run.
endOverrulable	optional	default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run.
unit	required

Elements

Element	Type	Cardinality	Description
description	string	optional

PeakCorrectionComplexType

Element	Type	Cardinality	Description
peakNumber	int	required	Peak number since T0, first peak before T0 = -1, second peak before T0 == -2 etc
correctionMultiplicationAttributeId	idStringType	required	Id of location attribute which contains the value of which the difference in peak height must be multiplied with to determine its part of the whole correction value.

OutputPeakCorrectionComplexType

Element	Type	Cardinality	Description
peakNumber	int	required	Peak number since T0, first peak after T0 = 1, second peak after T0 == 2 etc, default is 1

TimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

InputVariableExpressionBasedFunctionComplexType

Element	Type	Cardinality	Description
variableId	idStringType	required	Identifier for this variable, as used in the expression.
locationId	idStringType	required	Filter location. If the template variable contains multiple locations, then specify a filter location here.
templateVariableId	idStringType	required	Variable having a time series set definition, which will be used as a template. The variable used in the expression uses the time series set from this template, after filtering for the filter location.
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.

ExpressionCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
coefficient	ExpressionCoefficientComplexType	required · repeats	Coefficients for a free format expression. To use these coefficients, define a free format expression and reference to the identifiers of these coefficients in the expression. Make sure that for all the coefficient identifiers in the free format expression the values are defined here.

ExpressionCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
coefficient	ExpressionCoefficientFunctionsComplexType	required · repeats	Coefficients for a free format expression. To use these coefficients, define a free format expression and reference to the identifiers of these coefficients in the expression. Make sure that for all the coefficient identifiers in the free format expression the values are defined here.

ValidationRuleComplexType

Element	Type	Cardinality	Description
minimumInputValuesCount	intStringAttributeType	optional	Only works for non-equidistant data. When there are less than the minimum number of input values available the validation rule is not considered valid.
inputDoubtfulPercentage	floatStringAttributeType	optional
inputMissingPercentage	floatStringAttributeType	optional
outputValueFlag	validationRuleFlagEnumStringType	required	One of: missing, doubtful, reliable
outputCustomFlagSourceId	idStringType	optional

MergeInterpolationClosestDistanceComplexType

Element	Type	Cardinality	Description
searchRadius	doubleStringType	optional	meters. Default = Infinity.
distanceGeoDatum	geoDatumStringType	optional	Geo datum used to calculate the distances in meters between the points. To calculate distances efficiently and to pre-sort the input points in a grid the earth's curved surface should be transformed to a flat two-dimensional surface. When the input geometry is not in meters calculation of distances will be very slow and a search all is required when there is no exact match. When there is no region/country specific coordinate system available choose a utm zone that best fits with your output region. http://en.wikipedia.org/wiki/File:Utm-zones.jpg. eg. UTM55S for Victoria state in Australia. Only use zone number and N for northern hemisphere and S for southern hemisphere.

MergeMeanMissingValuesNotAllowedComplexType

Element	Type	Cardinality	Description
interpolationType	mergeMeanInterpolationTypeEnumStringType	required	One of: block, linear
extrapolateDirection	interpolationSerialExtrapolateConstantDirectionEnumStringType	required	If direction is start, then fills only the gap between the start of the input time series and the first data value, with values that are equal to the first data value. If direction is end, then fills only the gap between the last data value and the end of the input time series, with values that are equal to the last data value. If direction is both, then fills both of these gaps. One of: start, end, both
baseValue	float	required
recessionConstant	recessionConstantSimpleType	required

MergeRelationsRelationComplexType

Element	Type	Cardinality	Description
validPeriod	PeriodConditionComplexType	optional	Optional period for which this relation is valid. If a relation is not valid for a given time step, then it is ignored for that time step. If no validPeriod specified, then this relation is always valid. For a period the start time is inclusive and the end time is exclusive.
expression	nonEmptyStringType	required	For instance "X1 + X2". In the expression reference input variables or coefficients using their id, e.g. "X1 + a" where "X1" is the variableId of a variable and "a" is the id of a coefficient. Variables can be defined in this transformation or at the start of this transformations file. If a variable definition in this transformation has the same id as a variable definition at the start of this transformations file, then the variable definition in this transformation is used. Coefficients can be defined in a coefficientSet.
outputFlag	mergeRelationOutputFlagEnumStringType	optional	Optional (optional since stable build 2014.02). If specified the flag specified in this element will be used as the flag for the output. One of: original, completed, corrected
outputComment	nonEmptyStringType	optional	Optional (optional since stable build 2014.01). If specified, this comment will be put in the output time series for the time steps for which this relation is used to determine the output value.

MergeSimpleInputVariableComplexType

Element	Type	Cardinality	Description
variableId	idStringType	required	Identifier of a variable to use.
locationId	idStringType	optional	If the specified variable contains multiple locations, then specify the location to use here.
timeSeriesSet	TimeSeriesSetComplexType	required	A time series set that can be used as input or as output for a transformation function.
convertDatum	boolean	optional	If true, then this time series is converted from local to ordnance datum level before a transformation and back to local datum level after the transformation. Default is false.
checkMissing	boolean	optional	Option to check this timeseries for missing values. This option works in combination with the Parameter flag 'allowMissing', which can be set for a parameter in the parameters.xml configuration file. If for a given parameter allowMissing is false and checkMissing is true, then the transformation throws an exception when there are missing values for this parameter. When omitted defaults to 'false'. For grid data this option only checks whether the entire grid contains missing values or not, i.e. individual cells can still have missing values as long as there are other cells with non-missing values in the grid for the same time step.
overrulingSourceFlag	mergeSimpleOverrulingSourceFlagEnumStringType	optional	Optional (since stable build 2014.02). If specified the flag specified in this element will be used as the source flag for the output. One of: original, completed, corrected
overrulingQualityFlag	mergeSimpleOverrulingQualityFlagEnumStringType	optional	Optional (since stable build 2014.02). If specified the flag specified in this element will be used as the quality flag for the output. One of: reliable, doubtful, unreliable

MergeSimpleCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
reverseOrderInputTimeSeries	boolean	required

MergeWeightedCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
weightTime	MergeWeightedWeightTimeComplexType	required · repeats	One or more points in time with weights. Each weight is used for the time for which it is defined. For the times in between, the weights are calculated using linear interpolation. The weight configured for the first point in time is also used for all times before that time. The weight configured for the last point in time is also used for all times after that time.

CriticalConditionLookUpComplexType

Attributes

Attribute	Use	Notes
id	optional

Elements

Element	Type	Cardinality	Description
criticalCondition	RuleCriteriasComplexType	required · repeats

RuleCriteriasComplexType

Attributes

Attribute	Use	Notes
rule	required	rule name or rule result e.g. RED, WARNING, INFO etc.
ruleIndex	required	rule index is a value which is written to timeseries arrays
rulePreferredColor	optional
valuetype	optional	default: float.
indextype	optional	default: long.

Elements

Element	Type	Cardinality	Description
ruleCriteria	RuleCriteriaComplexType	required
ruleCriteriaLogicalOperator	logicalOperatorEnumStringType	optional	One of: and, or

AdjustQCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
blendingSteps	positiveInteger	required
errorTolerance	float	required
maxNumberOfIterations	positiveInteger	required
interpolationType	adjustQUsingObservedInstantaneousDischargeInterpolationTypeEnumStringType	required	One of: ratio, difference
disableAdjustment	boolean	optional

AdjustQCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
blendingSteps	string	required
errorTolerance	string	required
maxNumberOfIterations	string	required
interpolationType	string	required
disableAdjustment	string	optional

AdjustQUsingMeanDailyDischargeCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
errorTolerance	float	required
maxNumberOfIterations	positiveInteger	required

AdjustQUsingMeanDailyDischargeCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
errorTolerance	string	required
maxNumberOfIterations	string	required

AdjustQUsingInstantaneousDischargeCoefficientSetComplexType

Element	Type	Cardinality	Description
lowerLimit	float	optional	Optional lower limit above which these coefficients are valid. Lower limit is inclusive. If no lower limit specified, then valid for all values below upper limit.
upperLimit	float	optional	Optional upper limit below which these coefficients are valid. Upper limit is exclusive. If no upper limit specified, then valid for all values above lower limit.
blendingSteps	positiveInteger	required
interpolationType	adjustQUsingObservedInstantaneousDischargeInterpolationTypeEnumStringType	required	One of: ratio, difference
disableAdjustment	boolean	optional

AdjustQUsingInstantaneousDischargeCoefficientSetFunctionsComplexType

Element	Type	Cardinality	Description
blendingSteps	string	required
interpolationType	string	required
disableAdjustment	string	optional

TimeStepComplexType

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

Attributes

Attribute	Use	Notes
id	optional	Id of the time step. You can reference time steps defined in the regionConfig/timeSteps.xml. Only specify the id attribute when referring to a predefined time step. In the regionConfig/timeSteps.xml the time steps list both the id and the attributes that define the time step
label	optional	Short name for the time step which is shown to the user when he can choose one from a list.
unit	optional
divider	optional
multiplier	optional
times	optional	Defines the time step by a list of times without dates, e.g. "10:00 23:00"
minutes	optional	Since 2017.02. Defines the time step by a list of minutes (with prefix 0 for single digits), e.g. "05 25" which results in times 0:05, 0:25, 1:05, etc.
daysOfMonth	optional	Defines the time step by a list of days of month, use "01 11 21" for a decade time step
monthDays	optional	Defines the time step by a list of dates, e.g. ""--03-01 --06-01 --09-01 --12-01" for the meteorological seasons
timeZone	optional

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description of this timeStep. This is not used and is only present for convenience.

TimeSeriesSetComplexType

Attributes

Attribute	Use	Notes
id	optional
name	optional

Elements

Element	Type	Cardinality	Description
description	string	optional
valueType	timeSeriesValueTypeStringType	required
parameterId	idStringType	required
domainParameterId	idStringType	optional · repeats	For a spectrum specify the frequency / wave length parameter. For a directional spectrum specify first the frequency parameter and secondly the directional parameter
qualifierId	idStringType	optional · repeats	Id that references an qualifier listed in the regionConfigFiles/Qualifiers.xsd
timeSeriesType	timeSeriesTypeStringType	required
timeStep	TimeStepComplexType	required
aggregationPeriod	RelativePeriodComplexType	optional	The value at a time represents the aggregated value over the aggregation period e.g when the aggregation period is -6 to 0 hour the value at 13:00 represents an aggregation (e.g. moving average) from 7:00 till 13:00 (including)
cycle	CalendarTimeSpanComplexType	optional	If cycle specified, then the data is repeated periodically with this cycle as the period length. There is original data for only one cycle. After that cycle the data will be repeated periodically. In other words, when cycle is defined, then a missing value is filled up with a value from the last available cycle before the missing value.
externalForecastSearchTimeStep	TimeStepComplexType	optional	Since 2024.01. Only time series with an external forecast time that match this time step are visible while searching
externalForecastTimeCardinalTimeStep	TimeStepComplexType	optional	When no external forecast exists in the data store younger that the specified age a new external forecast is returned with a minimum age that applies to the specified cardinal time step
qualifierAggregation	qualifierAggregationStringType	optional	When specified all the time series that have ALL the specified qualifiers are aggregated to a single time series on read. Can not be specified when this time series set is meant for writing
readWriteMode	timeSeriesReadWriteModeStringType	required	Note: this readWriteMode is only used in the TimeSeriesDisplay. Other modules ignore this readWriteMode.
synchLevel	intStringType	optional
expiryTime	CalendarTimeSpanComplexType	optional
delay	TimeShiftComplexType	optional
multiplier	floatStringType	optional
divider	floatStringType	optional
incrementer	floatStringType	optional
ensembleId	idStringType	optional	Optional field for running ensembles. Ensemble id's in a time series set will override ensemble id's defined in the workflow.
visibilityControllingFlagSourceColumnId	idStringType	optional	All values that not passed this validation step are removed on read. Set to missing for equidistant and removed for non-equidistant
onlyReliableFlagSourceColumnId	idStringType	optional	Since 2022.02. All values that passed this validation step and are reliable will be included other will be set to missing for equidistant and removed for non-equidistant. This will work as an "or" operation together with "visibilityControllingFlagSourceColumnId", so data should either have passed "visibilityControllingFlagSourceColumnId" or "onlyReliableFlagSourceColumnId".
locationRelationId	idStringType	required	Relation id to map the time series set locations to related locations. Instead of the time series set locations the related locations are used to read/write the time series.
skipLocationsWithoutRelation	boolean	optional	Since 2020.01 When true locations that do not have a related location will be skipped, when false all location must have a related location. Default is false
moduleInstanceId	idStringType	required · repeats
moduleInstanceSetId	idStringType	required	Query a single module instance in the data store that is available for this time series set
filterModuleInstanceSetId	idStringType	required	Query all module instances in the data store that are available for this time series set
locationId	idStringType	required · repeats
locationSetId	idStringType	required
chainageLocationSetId	idStringType	required	Id of location set which represents a chainage of locations. This can only be used in combination with readWriteMode readOnly
relativeViewPeriod	TimeSeriesSetRelativePeriodComplexType	optional	Period relative the time 0 of the workflow or the system time of the fews explorer
relativeForecastPeriod	TimeSeriesSetRelativePeriodComplexType	optional	Period relative to first time of a simulated or external forecast time series
ensembleMemberId	nonEmptyStringType	required · repeats	Optional field used for reading or writing one or more particular ensemble member
ensembleMemberIndex	nonNegativeIntegerStringType	required	Optional field used for reading or writing one particular ensemble member
ensembleMemberIndexRange	EnsembleMemberIndexRangeComplexType	required	Optional field used for reading or writing one particular sub set of the ensemble
relativeForecastSearchPeriod	TimeSeriesSetRelativePeriodComplexType	required	Since 2015.02. The latest available external forecast in this period will be read. By default the latest before time0 is returned
externalForecastTimeId	idStringType	required	Since 2018.01. Forecast time reference id configured in the forecast length estimator config. Can only be used in workflows and only after the forecast length estimator.
externalForecastMinAge	TimeSpanComplexType	optional	Since 2014.02. By default is there is no minimum age. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0
externalForecastMaxAge	TimeSpanComplexType	optional	By default is there is no maximum age so the returned external forecast can be very old when there is no recent forecast available. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0

ExpressionCoefficientComplexType

Definition of a coefficient.

Attributes

Attribute	Use	Notes
id	required	Identifier with which this coefficient is referenced in the free format expression.
value	required	The float value of this coefficient.

ExpressionCoefficientFunctionsComplexType

Attributes

Attribute	Use	Notes
id	required	Identifier with which this coefficient is referenced in the free format expression.
value	required	Location dependent function for the float value of this coefficient. This can contain location attribute ids, e.g. @COEFFICIENT_A@.

PeriodConditionComplexType

A period condition

Element	Type	Cardinality	Description
validBeforeDateTime	DateTimeComplexType	required	Valid for entire period prior to this date and time.
validAfterDateTime	DateTimeComplexType	required	Valid for entire period after this date and time.
season	SeasonConditionComplexType	required	A seasonal period that is repeated every year.
startDateTime	DateTimeComplexType	required	Start date and time for this period.
endDateTime	DateTimeComplexType	required	End date and time for this period.

MergeWeightedWeightTimeComplexType

Element	Type	Cardinality	Description
relativeTime	RelativeTimeComplexType	required	The relative time for which the corresponding weight is defined. This time is relative to T0.
weight	float	required	Weight for the first inputVariable for the specified time. The weight for the second inputVariable is calculated as follows. Weight for inputVariable2 = 1 - weight for inputVariable1.

RuleCriteriaComplexType

complex type to define rule criteria

Element	Type	Cardinality	Description
rule	ConditionComplexType	required
ruleGroup	ConditionGroupComplexType	required

CalendarTimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

TimeShiftComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

TimeSeriesSetRelativePeriodComplexType

Defines a moving period in time. The start and end time are relative time to a certain time. When the start time is not specified it is determined by the start time of the state of the current run. When the start is overrulable the time is overruled by the start of search period or the start of cold state run when one of two is specified When the end is overrulable this time is overruled by the end of the forecast when specified

Attributes

Attribute	Use	Notes
unit	required
start	optional	e.g. -1 hour means one before time 0
end	required	e.g. 1 hour means one hour after time 0
startOverrulable	optional	default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run.
endOverrulable	optional	default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run.

Elements

Element	Type	Cardinality	Description
description	string	optional

EnsembleMemberIndexRangeComplexType

Attributes

Attribute	Use	Notes
start	required
end	optional

SeasonConditionComplexType

Element	Type	Cardinality	Description
startMonthDay	monthDayType	required	Start month and day of this season.
endMonthDay	monthDayType	required	End month and day of this season.

RelativeTimeComplexType

Defines a time relative to T0.

Attributes

Attribute	Use	Notes
value	required
unit	required

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description with additional comments. This is never used in the code.

ConditionComplexType

Attributes

Attribute	Use	Notes
variable	required
operator	required
value	required
logical	optional

ConditionGroupComplexType

Element	Type	Cardinality	Description
rule	ConditionComplexType	required

Gotchas

• merge simple’s priority order is the inputVariable document order — the first one wins wherever it has data; later ones only fill gaps. reverseOrderInputTimeSeries (in the required coefficientSet) flips that, and reverseOrderAttributeId can flip it per-location from a location attribute. There’s no separate “priority” field to set — reorder the XML.
• merge simple requires a coefficientSet even with nothing to configure — the schema still requires at least one (with just reverseOrderInputTimeSeries set) even when you don’t need range-dependent behavior. Leaving it out is a config error, not a default-everything shortcut.
• merge toggle vs. merge gap: both replace the primary series with the next input once a gap exceeds maxGapLength, but toggle stays on the replacement once switched (until it toggles back), while gap only substitutes for the duration of the gap itself. Picking the wrong one either produces an unwanted permanent source-switch or an unwanted reversion mid-event.
• selection has near-identical *Peaks/*Lows pairs (peaks vs. independentLows, lows vs. independentPeaks, etc.) — the “independent” variants find peaks/lows without requiring a full rise-then-fall cycle between them, which matters for noisy or closely-spaced series. Check the schema annotation for the specific variant before assuming it behaves like the plain one.
• adjust corrects a computed series against an observed one (e.g. adjust a modeled discharge to match the latest observed gauge reading) — it’s not a general-purpose value editor; it needs both a computed input and a reference observed series configured.

See also

• Reference: Transformation functions — basics · Temporal reshaping · Interpolation & spatial · Statistics · Hydrology & physical process
• Task guide: Transformations
• Schema: transformationTypes.xsd