...
Transformation module parameter modifiers
Blending steps modifier
The blending steps modifier is a modifier which can only be used in combination with the transformation <adjust><adjustQ>.
The adjustQ-transformation should also have a moduleparameterfile configured.
Below an example.
| Code Block | ||
|---|---|---|
| ||
<transformation id="BRGN6NVR">
<adjust>
<adjustQUsingObservedInstantaneousDischarge>
<observedDischarge>
<variableId>BRGN6_QIN_6</variableId>
</observedDischarge>
<simulatedInstantaneousDischarge>
<variableId>BRGN6TOT_SQIN_6</variableId>
</simulatedInstantaneousDischarge>
<moduleParameterFile>ADJUSTQ_BRGN6NVR_BRGN6NVR_UpdateStates</moduleParameterFile>
<adjustedForecastDischarge>
<variableId>BRGN6NVR_QINE_6</variableId>
</adjustedForecastDischarge>
</adjustQUsingObservedInstantaneousDischarge>
</adjust>
</transformation> |
This transformation uses observed discharges and simulated discharges to create an output timeseries.
One of the parameters of the adjustQ-transformation is the blending steps.
This parameter determines in how many steps the blend from the observed time series to the simulated time series is done.
The blending steps modifier is used to modify this parameter. The modifier doesn't have a start- and/or endtime and is always valid.
The last applied blending steps modifier is always applied. Only one blending steps modifier can be defined in a fews configuration.
An example of the blending steps modifier is the CHGBLEND-modifier. This modifier is used by the NWS to modify the blending steps of the
adjustQ-operation.
Below is an example of a blending steps modifier. The forecaster can enter the value in the text box and/or change it with the up and down arrows next to the text box.
Below an example of the configuration an adjustQModifier.
| Code Block |
|---|
<adjustQModifiers>
<blendingStepsModifier id="CHGBLEND" name="CHGBLEND"/>
</adjustQModifiers> |
The only thing the configurator has to configure is the id of the modifier and its name.
By doing this the configuration declares that it is allowed to use the blending steps modifier.
Sample years modifier
The transformation sample historic creates ensembles based on historic time series.
The sample years modifier can only be used in combination with this transformation.
...
Reverse order modifiers
This modifier can be used to reverse the data hierarchy of the merge simple transformation.
When this modifier is active on the transformation the data hierachy is reversed.
An example of the use of this modifier is the switchts-modifier of the NWS. With this modifier the forecasters temporarily favor one
timeseries above the other because the timeseries which normally is used as the primary timeseries is considered to be less reliable.
Display
Below an example of the display of a reverse order modifier. The display is empty. The forecaster can only set a start- and endtime of the modifier.
If configured it is also to enter a valid time for this modifier.
Configuration example
| Code Block | ||
|---|---|---|
| ||
<mergeSimpleModifiers>
<reverseOrderModifiers id="switchts" name="SWITCHTS">
<defaultStartTime>start run</defaultStartTime>
<defaultEndTime>time zero</defaultEndTime>
</reverseOrderModifiers>
</mergeSimpleModifiers> |
Below an example of the display of this modifier. This display is blank, the forecaster can only enter a period in which this modifier is active.
defaultStartTime
The default start time of the modifier. The available options are startrun and time zero. It corresponds to the same field in the modifier display.
defaultEndTime
The default end time of the modifier. The available options are time zero and end run. It corresponds to the same fields in the modifier display.
defaultValidTime
If this option is configured than a valid time can be choosen for this modifier. The valid time always default to time zero. It corresponds to the same fields in the modifier display.
Blending steps modifier
The blending steps modifier is a modifier which can only be used in combination with the transformation <adjust><adjustQ>.
The adjustQ-transformation should also have a moduleparameterfile configured.
Below an example.
| Code Block | ||
|---|---|---|
| ||
<transformation id="BRGN6NVR">
<adjust>
<adjustQUsingObservedInstantaneousDischarge>
<observedDischarge>
<variableId>BRGN6_QIN_6</variableId>
</observedDischarge>
<simulatedInstantaneousDischarge>
<variableId>BRGN6TOT_SQIN_6</variableId>
</simulatedInstantaneousDischarge>
<moduleParameterFile>ADJUSTQ_BRGN6NVR_BRGN6NVR_UpdateStates</moduleParameterFile>
<adjustedForecastDischarge>
<variableId>BRGN6NVR_QINE_6</variableId>
</adjustedForecastDischarge>
</adjustQUsingObservedInstantaneousDischarge>
</adjust>
</transformation> |
This transformation uses observed discharges and simulated discharges to create an output timeseries.
One of the parameters of the adjustQ-transformation is the blending steps.
This parameter determines in how many steps the blend from the observed time series to the simulated time series is done.
The blending steps modifier is used to modify this parameter. The modifier doesn't have a start- and/or endtime and is always valid.
The last applied blending steps modifier is always applied. Only one blending steps modifier can be defined in a fews configuration.
An example of the blending steps modifier is the CHGBLEND-modifier. This modifier is used by the NWS to modify the blending steps of the
adjustQ-operation.
Below is an example of a blending steps modifier. The forecaster can enter the value in the text box and/or change it with the up and down arrows next to the text box.
Below an example of the configuration an adjustQModifier.
| Code Block |
|---|
<adjustQModifiers>
<blendingStepsModifier id="CHGBLEND" name="CHGBLEND"/>
</adjustQModifiers> |
The only thing the configurator has to configure is the id of the modifier and its name.
By doing this the configuration declares that it is allowed to use the blending steps modifier.
Sample years modifier
The transformation sample historic creates ensembles based on historic time series.
The sample years modifier can only be used in combination with this transformation.
To be able to use this modifier the transformation sample historic should use a module parameter file to define its configuration options. Make sure all the following parameters are defined in the parameter file:
| Code Block |
|---|
<parameter id="startYear">
<intValue>1966</intValue>
</parameter>
<parameter id="firstEnsembleMemberIndex">
<intValue>1966</intValue>
</parameter>
<parameter id="ensembleMemberCount">
<intValue>44</intValue>
</parameter>
<parameter id="startWaterYear">
<stringValue>--10-01</stringValue>
</parameter> |
An example of the use of this modifier is the modifier HistoricWaterYears which is in use by NWS.
It is used by the forecasters to overrule the default sample years in the transformation.
Display
Below an example of the display of this modifier. 
The forecaster can modifiy the default sample years by changing the start year and end year in the display.
Configuration example
Below an example of the configuration of this modifier.
| Code Block |
|---|
<sampleHistoricalModifiers>
<sampleYearsModifier id="historicwateryears" name="historicwateryears">
</sampleYearsModifier> </sampleHistoricalModifiers> |
Disable adjustment modifier
The transformation adjustQ creates a simulated time series by combining observed time series and simulated time series.
When this modifier is applied the observed time series are ignored and the output will be equal to the simulated time series. This modifier can, like the blending steps modifier, only be used in combination with the
adjustQ transformation. The adjustQ-transformation should use a moduleparameterfile to define its parameters to be able to use this modifier.
The moduleparameterfile should define the parameter disableAdjustment.
Below an example
| Code Block |
|---|
<parameters xmlns="http://www. |
| Code Block |
|---|
<parameter id="startYear">
<intValue>1966</intValue>
</parameter>
<parameter id="firstEnsembleMemberIndex">
<intValue>1966</intValue>
</parameter>
<parameter id="ensembleMemberCount">
<intValue>44</intValue>
</parameter>
<parameter id="startWaterYear">
<stringValue>--10-01</stringValue>
</parameter> |
An example of the use of this modifier is the modifier HistoricWaterYears which is in use by NWS.
It is used by the forecasters to overrule the default sample years in the transformation.
Display
Below an example of the display of this modifier.
The forecaster can modifiy the default sample years by changing the start year and end year in the display.
Configuration example
Below an example of the configuration of this modifier.
| Code Block |
|---|
<sampleHistoricalModifiers>
<sampleYearsModifier id="historicwateryears" name="historicwateryears">
</sampleYearsModifier> </sampleHistoricalModifiers> |
Disable adjustment modifier
The transformation adjustQ creates a simulated time series by combining observed time series and simulated time series.
When this modifier is applied the observed time series are ignored and the output will be equal to the simulated time series. This modifier can, like the blending steps modifier, only be used in combination with the
adjustQ transformation. The adjustQ-transformation should use a moduleparameterfile to define its parameters to be able to use this modifier.
The moduleparameterfile should define the parameter disableAdjustment.
Below an example
| Code Block |
|---|
<parameters xmlns="http://www.wldelft.nl/fews/PI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.5" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://chps1/schemas/pi-schemas/pi_modelparameters.xsd">
<group id="default">
<parameter id="blendingSteps">
<intValue>1</intValue>
</parameter>
<parameter id="interpolationType">
<stringValue>difference</stringValue>
</parameter>
<parameter id="disableAdjustment"> <
<boolValue>false</boolValue>
</parameter>
</group>
</parameters> |
...
First the timeValueTimeSeries are defined. The parameterid of the defined timeseries will be used as an identifier
in radiobutton which can be used to select an option. When an option is selected which is defined as a timeValue-timeseries
than the user can also define a value.
booleanTimeSeries
This option allows the user to define option-types which can only be selected by used, but doesn't offer the possibility to
enter a additional value.
expiryTime
This option can be used to define an expiry time for this modifier which overrules the default expiry time. The expiryTime is not related to the modifier display (and is thus hidden from the user) and can be used to maximize the period a rating table modifier can be applied. This expiryTime is related to the period to which the modifier is applied, it does not indicate the period after which the rating table will be removed by the rollingBarrel. By using this option, you can overrule the default expiryTime.
Module parameter modifiers
Change ordinates modifier
...
The ordinates can be changed in the table or in the graph. When the user presses the apply button the ordinates are adjusted by using a volume-correction.
The volume correction will ensure that the volume without the modifier applied is the same as the volume of unit hydrograph after the modifier is applied.
Display
Below an example of the display of this modifier.
...
defaultStartTime
The default start time of the modifier. The available options are startrun and time zero. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
defaultEndTime
The default end time of the modifier. The available options are time zero and end run. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
offsetDefaultEndTime
The offset of the end time compared to the option defined in defaultEndTime. For example when the default end
time of the modifier is set to end run and an offset of 100 days is defined than the default end time of the modifier
will be set to end run plus 100 days. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
defaultValidTime
If this option is configured than a valid time can be choosen for this modifier. The valid time always default to time zero.
Configuration example
Below an example of the configuration of this modifier.
<unitHydrographModifiers> <changeOrdinatesModifier id="unithg" name="UNITHG"> <defaultStartTime>start run</defaultStartTime> <defaultEndTime>end run</defaultEndTime> <defaultValidTime/> </changeOrdinatesModifier> </unitHydrographModifiers>
Reverse order modifiers
...
are defined. The parameterid of the defined timeseries will be used as an identifier
in radiobutton which can be used to select an option. When an option is selected which is defined as a timeValue-timeseries
than the user can also define a value.
booleanTimeSeries
This option allows the user to define option-types which can only be selected by used, but doesn't offer the possibility to
enter a additional value.
expiryTime
This option can be used to define an expiry time for this modifier which overrules the default expiry time. The expiryTime is not related to the modifier display (and is thus hidden from the user) and can be used to maximize the period a rating table modifier can be applied. This expiryTime is related to the period to which the modifier is applied, it does not indicate the period after which the rating table will be removed by the rollingBarrel. By using this option, you can overrule the default expiryTime.
When this modifier is active on the transformation the data hierachy is reversed.
An example of the use of this modifier is the switchts-modifier of the NWS. With this modifier the forecasters temporarily favor one
timeseries above the other because the timeseries which normally is used as the primary timeseries is considered to be less reliable.
Display
Below an example of the display of a reverse order modifier. The display is empty. The forecaster can only set a start- and endtime of the modifier.
If configured it is also to enter a valid time for this modifier.
Schema
Below an example of the display of this modifier. This display is blank, the forecaster can only enter a period in which this modifier is active.
defaultStartTime
The default start time of the modifier. The available options are startrun and time zero. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
defaultEndTime
The default end time of the modifier. The available options are time zero and end run. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
offsetDefaultEndTime
The offset of the end time compared to the option defined in defaultEndTime. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
defaultValidTime
If this option is configured than a valid time can be choosen for this modifier. The valid time always default to time zero. It corresponds to the same fields in the modifier display. This is only a default value, which can be changed by the user.
Configuration example
Below a configuration example.
<mergeSimpleModifiers> <reverseOrderModifiers id="switchTs" name="SWITCHTS"> <defaultStartTime>start run</defaultStartTime> <defaultEndTime>time zero</defaultEndTime> </reverseOrderModifiers> </mergeSimpleModifiers>
Rating curve modifiers
Shift rating curve modifiers
...