...
The user can enter a value in the text box by entering a value and by clicking on the spinner box next to it.
The value can also be adjusted by the slider bar.
The date of the modifier can be selected in the area above which the forecaster can enter a value for the modifier.
The units of the modifier is shown at the right side of the slider bar.
schema
...
<complexType name="SingleValueModifierTypeComplexType">
<complexContent>
<extension base="fews:ModifierBaseComplexType">
<sequence>
<element name="timeSeries" type="fews:TimeSeriesFilterComplexType" maxOccurs="unbounded"/>
<element name="softLimits" type="fews:SoftLimitsComplexType"/>
<element name="hardLimits" type="fews:HardLimitsComplexType" minOccurs="0"/>
<element name="defaultTime" type="fews:DefaultStartTimeEnumStringType">
<annotation>
<documentation>Start of time period to which modifier is applied.
When omitted this value will default to the Year 1000 and will be disabled.
</documentation>
</annotation>
</element>
<choice>
<element name="defaultValue" type="float" minOccurs="0"/>
<element name="defaultValueTimeSeries" type="fews:TimeSeriesFilterComplexType" minOccurs="0"/>
<element name="statisticalFunctionDefaultValue" type="fews:statisticalFunctionEnumType" minOccurs="0" maxOccurs="unbounded"/>
</choice>
</sequence>
</extension>
</complexContent>
</complexType>
timeSeries
The tag timeseries is used to define to which timeseries this modifier can be applied.
softLimits
The slider in the display is bounded to the soft limits defined. However they can be overruled by entering a higher or lower value in the text box.
hardLimits
The values entered in the text box or the slider are bounded by the hard limits defined.
defaultTime
The default time of the modifier. Currently two options are available time zero and start run.
defaultValue
It is possible to assign a default value to a single value modifier.
The following options are available:
- default value
- derive a default value from a time series
- derive default value from a statistical function
When a default value is configured the modifier will always default to that value.
In case the second option is chosen than it is possible to define a timeseries-filter from which the default value should be derived.
The modifier will look for a value at the time for which the modifier is defined.
The last option allows the forecaster to configure a statistical function from which the value should be derived.
Currently only the principal component analysis-functions support this option.
When the principal component analysis is run in the plot display by selecting the principal component analysis-function the output value of this function will be default value for the modifier.
Configuration example
| Code Block | ||||
|---|---|---|---|---|
| ||||
<singleValueModifier id="wechng" name="WECHNG">
<timeSeries>
<parameterId>WECHNG</parameterId>
</timeSeries>
<softLimits>
<maximumValue>5</maximumValue>
<minimumValue>0</minimumValue>
</softLimits>
<hardLimits>
<minimumValue>0</minimumValue>
</hardLimits>
<defaultTime>start run</defaultTime>
<defaultValue>0</defaultValue>
</singleValueModifier>
|
First the id and name of the modifier is declared. In this case this instance of the singeValueModifier will be identified by wechng.
The timeSeries-part identifies that this modifier can be applied to any time series which have the parameter WECHNG.
The modifier has soft limits configured. These limits are used to limit the slider bar in the display.
In this example the slider bar will start at 0 and end at 5. But these soft limits can be overruled by
manually typing a value lower than zero or higher than 5.
The hardLimits identify the upper and lower limit of the mod and they can not be overruled.
This means that for this mod only the maximum value of the soft limit of 5 can be overruled because there
is a minimum value configured in the hard limits of 0. A single value modifier is only applied at one time step.
By default the time step is set to the start of the run in this modifier. The default value is set to 0.
Constant value modifiers
Constant value modifiers are very similar to single value modifiers. But instead of modifying a single value at a
particular point in time, they modify a time series over a period of time with a fixed value.
An example of the use of the constant value modifier is the MFC-modifier. This modifier adjusts the melt factor of the
snow17-model over the specified period of time with the specified value. It is (just as the WECHNG-modifier) applied to an
empty time series and used as an input time series to the snow17-model.
Display
Below the display of a constant value modifier is shown. Which is very similar to the display of single value modifier.
Note however that this modifier has a start and an end time. The constant value of the modifier can be specified in the
text box or with the slider. The period can be defined by using the start and end date boxes.
Schema
Below the schema of the constant value modifier. 
timeseries
The user can define a timeseries filter in this tag to define to which time series the modifier can be applied.
softLimits
The slider in the display is bounded to the soft limits defined. However they can be overruled by entering a higher or lower value in the text box.
hardLimits
The values entered in the text box or the slider are bounded by the hard limits defined.
defaultstarttime
The default start time of the modifier can be defined here.
Possible options are:
- startrun
- time zero
defaultendtime
The default end time of the modifier can be defined here.
Possible options are:
- time zero
- end run
defaultvalue
A default value can be defined here.
Configuration example
Below an example configuration of a constant value modifer is shown.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<constantValueModifier id="mfc" name="MFC">
<timeSeries>
<parameterId>MFC</parameterId>
</timeSeries>
<softLimits>
<maximumValue>10</maximumValue>
<minimumValue>0</minimumValue>
</softLimits>
<defaultStartTime>start run</defaultStartTime>
<defaultEndTime>end run</defaultEndTime>
<defaultValue>1</defaultValue>
</constantValueModifier>
|
This id of this instance of the constant value modifier is mfc and its name is MFC. It will only be applied to time series
which have the parameterid MFC because a timeseries-filter with parameterid MFC is defined.
No hardlimits are defined but the softLimits are set to a range of 0-10. The slider will have a range of 0 till 10.
But they can be overruled with entering a higher value in the text box.
Enumeration modifiers
Enumeration modifiers are modifiers in which the user can select an option from a dropdown-list. This is modifier is applied to an period
of time
timeSeries
The tag timeseries is used to define to which timeseries this modifier can be applied.
softLimits
The slider in the display is bounded to the soft limits defined. However they can be overruled by entering a higher or lower value in the text box.
hardLimits
The values entered in the text box or the slider are bounded by the hard limits defined.
defaultTime
The default time of the modifier. Currently two options are available time zero and start run.
defaultValue
It is possible to assign a default value to a single value modifier.
The following options are available:
- default value
- derive a default value from a time series
- derive default value from a statistical function
When a default value is configured the modifier will always default to that value.
In case the second option is chosen than it is possible to define a timeseries-filter from which the default value should be derived.
The modifier will look for a value at the time for which the modifier is defined.
The last option allows the forecaster to configure a statistical function from which the value should be derived.
Currently only the principal component analysis-functions support this option.
When the principal component analysis is run in the plot display by selecting the principal component analysis-function the output value of this function will be default value for the modifier.
Configuration example
...
<singleValueModifier id="wechng" name="WECHNG">
<timeSeries>
<parameterId>WECHNG</parameterId>
</timeSeries>
<softLimits>
<maximumValue>5</maximumValue>
<minimumValue>0</minimumValue>
</softLimits>
<hardLimits>
<minimumValue>0</minimumValue>
</hardLimits>
<defaultTime>start run</defaultTime>
<defaultValue>0</defaultValue>
</singleValueModifier>
First the id and name of the modifier is declared. In this case this instance of the singeValueModifier will be identified by wechng.
The timeSeries-part identifies that this modifier can be applied to any time series which have the parameter WECHNG.
The modifier has soft limits configured. These limits are used to limit the slider bar in the display.
In this example the slider bar will start at 0 and end at 5. But these soft limits can be overruled by
manually typing a value lower than zero or higher than 5.
The hardLimits identify the upper and lower limit of the mod and they can not be overruled.
This means that for this mod only the maximum value of the soft limit of 5 can be overruled because there
is a minimum value configured in the hard limits of 0. A single value modifier is only applied at one time step.
By default the time step is set to the start of the run in this modifier. The default value is set to 0.
Constant value modifiers
Constant value modifiers are very similar to single value modifiers. But instead of modifying a single value at a
particular point in time, they modify a time series over a period of time with a fixed value.
An example of the use of the constant value eneration modifier is the MFC-modifier. This modifier adjusts the melt factor of the
snow17-model over the specified period of time with the specified value. It is (just as the WECHNG-modifier) applied to an
rain snow modifier from the NWS. In this modifier the forecaster can determine
the precipitation in the snow17-model. Only two options are available rain and snow. If the forecaster chooses option rain than
a value of 1 is set into the timeseries, if an option snow is chosen than the value 2 is set into the timeseries at the specified time.
The modifier is applied to an empty time series and used as an input time series to the snow17-modelmodel. The model knows that if value 1 is set into the
timeseries that the user has chosen option rain and that if value is 2 that option snow was choosen.
Display
Below the display of a constant value modifier is shown. Which is very similar to the display of single value modifier.
Note however that this modifier has a start and an end time. The constant value of the modifier can be specified in the
text box or with the slider. The period can be defined by using the start and end date boxes.
Schema
Below the schema of the constant value modifier.
...
<complexType name="ConstantValueModifierComplexType">
<complexContent>
<extension base="fews:ModifierBaseComplexType">
<sequence>
<element name="timeSeries" type="fews:TimeSeriesFilterComplexType" maxOccurs="unbounded"/>
<element name="softLimits" type="fews:SoftLimitsComplexType"/>
<element name="hardLimits" type="fews:HardLimitsComplexType" minOccurs="0"/>
<element name="defaultStartTime" type="fews:DefaultStartTimeEnumStringType">
<annotation>
<documentation>Start of time period to which modifier is applied.
When omitted this value will default to the Year 1000 and will be disabled.
</documentation>
</annotation>
</element>
<element name="defaultEndTime" type="fews:DefaultEndTimeEnumStringType">
<annotation>
<documentation>End of time period to which modifier is applied.
When omitted this value will default to the Year 3000 and will be disabled.
</documentation>
</annotation>
</element>
<element name="defaultValue" type="float"/>
</sequence>
</extension>
</complexContent>
</complexType>
an example of the display for an enumeration modifier.
Schema 
timeseries
The user can define a timeseries filter in this tag.
descriptionEnumeration
Define the text value in the display which is shown before the dropdown list
enumeration
Define the list of options available in the dropdownlist and its associated value which will be placed into
the time series.
defaultstarttime
The default start time of the modifier can be defined here.
Possible options are:
- startrun
- time zero
defaultendtime
The default end time of the modifier can be defined here.
Possible options are:
- time zero
- end run
Configuration example
Below is an example of the configuration of an enumeration modifier.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<enumerationModifier id="rainsnow" name="RAINSNOW">
<timeSeries>
<parameterId>RAINSNOW</parameterId>
</timeSeries>
<descriptionEnumeration>choose precipitation:</descriptionEnumeration>
<enumeration>
<item text="rain" value="1"/>
<item text="snow" value="2"/>
</enumeration>
<defaultStartTime>start run</defaultStartTime>
<defaultEndTime>end run</defaultEndTime>
</enumerationModifier>
|
This modifier is applied to every time series which has parameter id RAINSNOW because a filter is defined with only the parameterId RAINSNOW.
The text of the label in front of the dropdownlist is configurable. The items in the dropdownlist are also configurable. For this modifier the forecaster can choose between options rain and snow. If snow is selected a value of 2 in set into the time series for the selected period.
If rain is selected a value of 1 is written into the time series.
The numbers are treated as flags by the model to which the time series is passed.
Time series modifier
The time series modifier is a modifier which allows the forecaster to edit a timeseries by selecting points in a graph or by
changing values in a modifier. In most applications of this modifier the forecaster is directly editing a time series which is used
by the models. For example it might be used to directly edit the precipitation. This is contrary to how for example the single value modifier
WECHNG is used. This modifier edits an empty time series which is than read by the snow17-model which modifies its state based on the input from
this modifier. A time series modifier always has a start- and enddate. Optionally (if configured) a valid time is available.
The forecaster can edit this time series by making changes in table or in the graph. The changes in the graph are made by clicking in the graph.
When the user clicks from left to right then the values between the points are interpolated.
When the user clicks from right to left only the newly added or changed points are adjusted but no interpolation will be done between
the last two points. When more than one time series is shown in the display it is possible to make a selection of which time series should edited when making changes by clicking in the graph.
The time series which should be changed can be selected by clicking on the legend of that example time series in the graph
Besides editing the time series by editing values in the graph or table another type can be selected by the dropdownbox.
Available options are:
- add
- substract
- mulitply
- divide
- replace
- missing
- ignore time series
- time series
When one of the options add, substract, mulitply, divide or replace is choosen than a text box in which a value can be entered appears next to the operation type-dropdownbox. 
The options add, substract, mulitply, divide or replace are self-explaining. They add,substract, multiply,divide or replace the timeseries with the specified value over the specified period of time.
The option missing replaces the values in the time series with missing values over the specified period of time, the ignore time series sets the value over the specified period of time to unreliable.
The last option time series is the default option which will selected after startup of this modifier and this option allows the forecaster to freely edit the timeseries
timeseries
The user can define a timeseries filter in this tag to define to which time series the modifier can be applied.
softLimits
The slider in the display is bounded to the soft limits defined. However they can be overruled by entering a higher or lower value in the text box.
hardLimits
The values entered in the text box or the slider are bounded by the hard limits defined.
defaultstarttime
The default start time of the modifier can be defined here.
Possible options are:
- startrun
- time zero
defaultendtime
The default end time of the modifier can be defined here.
Possible options are:
- time zero
- end run
defaultvalue
A default value can be defined here.
Configuration example
Below an example configuration of a constant value modifer is shown.
...
<constantValueModifier id="mfc" name="MFC">
<timeSeries>
<parameterId>MFC</parameterId>
</timeSeries>
<softLimits>
<maximumValue>10</maximumValue>
<minimumValue>0</minimumValue>
</softLimits>
<defaultStartTime>start run</defaultStartTime>
<defaultEndTime>end run</defaultEndTime>
<defaultValue>1</defaultValue>
</constantValueModifier>
This id of this instance of the constant value modifier is mfc and its name is MFC. It will only be applied to time series
which have the parameterid MFC because a timeseries-filter with parameterid MFC is defined.
No hardlimits are defined but the softLimits are set to a range of 0-10. The slider will have a range of 0 till 10.
But they can be overruled with entering a higher value in the text box.
Enumeration modifiers
Enumeration modifiers are modifiers in which the user can select an option from a dropdown-list. This is modifier is applied to an period
of time.
An example of the use of the eneration time series modifier is the rain snow modifier from the NWS. In this modifier the forecaster can determine
the precipitation in the snow17-model. Only two options are available rain and snow. If the forecaster chooses option rain than
a value of 1 is set into the timeseries, if an option snow is chosen than the value 2 is set into the timeseries at the specified time.
The modifier is applied to an empty time series and used an input to the model. The model knows that if value 1 is set into the
timeseries that the user has chosen option rain and that if value is 2 that option snow was choosen.
Display
Below an example of the display for an enumeration modifier.
...
Schema
...
<complexType name="EnumerationModifierComplexType">
<complexContent>
<extension base="fews:ModifierBaseComplexType">
<sequence>
<element name="timeSeries" type="fews:TimeSeriesFilterComplexType" maxOccurs="unbounded"/>
<element name="descriptionEnumeration" type="string"/>
<element name="enumeration" type="fews:EnumerationComplexType"/>
<element name="defaultStartTime" type="fews:DefaultStartTimeEnumStringType">
<annotation>
<documentation>Start of time period to which modifier is applied.
When omitted this value will default to the Year 1000 and will be disabled.
</documentation>
</annotation>
</element>
<element name="defaultEndTime" type="fews:DefaultEndTimeEnumStringType">
<annotation>
<documentation>End of time period to which modifier is applied.
When omitted this value will default to the Year 3000 and will be disabled.
</documentation>
</annotation>
</element>
</sequence>
</extension>
</complexContent>
</complexType>
ROCHNG-modifier which is used by NWS to modify the runoff time series.
Display
Below a screenshot of the timeseries modifier.
Schema
Below the schema of the timeseries modifier. 
timeSeries
This tag can be used to identify to which timeseries this modifier can be applied.
defaultStartTime
The default start time of the modifier. The available options are startrun and time zero.
offsetDefaultStartTime
The offset start time compared to the option defined in defaultStartTime. For example when an offset of 1 day is configured
in this option and the defaultStartTime is set to timezero than the default starttime of the modifier will be set to
time zero plus 1 day.
defaultEndTime
The default end time of the modifier. The available options are time zero and end run.
offsetDefaultEndTime
The offset of the end time compared to the option defined in defaultEndTime.
defaultValidTime
If this option is configured than a valid time can be choosen for this modifier. The valid time always default to time zero.
resolveInWorkflow
In the tag timeSeries is a filter defined which defines which timeseries can be modified with this timeseries. If the tag
resolveInWorkflow is set than the modifier can be applied to all timeseries in the current workflow to which the defined time
series filter applies. In an IFD-environment the current workflow is the workflow which is associated to the selected topology
node.
resolveInPlots
This tag can only be used in IFD-environments. If this tag is enabled than the timeseries-filter is also applied to all timseries
in the plots associated with the current selected topologynode.
editInPlots
It is possible to create a timeseries modifier in the plot displays. This can be done by selecting a timeseries by selecting a legend.
After selection the timeseries can be modified by graphicly editing the timeseries or by changing values in the graph. This feature can
be disabled by setting this option to false.
createContinousModifiers
If a modifier is created in the graph by default one modifier will be created. However if this option is disabled one modifier will
be created for every continious range of modifications made. For example if the forecaster changes a 6 hours timeseries at 00z and at 12z
but not a 0600z than by default this will result in creating a single modifier, but when this option is enabled two modifiers will be
created. One for each continious range of changes. In this case there is a change at 00z and one at 12z therefore two modifiers will
be created.
Configuration example
Below an example of how a time series modifier should be configured.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<timeSeriesModifier id="rochng" name="ROCHNG">
<timeSeries>
<moduleInstanceSetId>SACSMA_Forecast</moduleInstanceSetId>
<valueType>scalar</valueType>
<parameterId>INFW</parameterId>
<locationSetId>Gages_Catchments</locationSetId>
<timeSeriesType>simulated forecasting</timeSeriesType>
<timeStep unit="hour" multiplier="6"/>
<ensembleId>QPF</ensembleId>
</timeSeries> |
timeseries
The user can define a timeseries filter in this tag.
descriptionEnumeration
Define the text value in the display which is shown before the dropdown list
enumeration
Define the list of options available in the dropdownlist and its associated value which will be placed into
the time series.
defaultstarttime
The default start time of the modifier can be defined here.
Possible options are:
- startrun
- time zero
defaultendtime
The default end time of the modifier can be defined here.
Possible options are:
- time zero
- end run
Configuration example
Below is an example of the configuration of an enumeration modifier.
| Code Block | ||
|---|---|---|
| xml | xml | <enumerationModifier id="rainsnow" name="RAINSNOW"> <timeSeries> <parameterId>RAINSNOW</parameterId> </timeSeries> <descriptionEnumeration>choose precipitation:</descriptionEnumeration> <enumeration> <item text="rain" value="1"/> <item text="snow" value="2"/> </enumeration> <defaultStartTime>start run</defaultStartTime> <defaultEndTime>end run</defaultEndTime> <resolveInWorkflow>true</resolveInWorkflow> <resolveInPlots>false</resolveInPlots> </enumerationModifier>timeSeriesModifier> |
This modifier is can be applied to every time series which has parameter id RAINSNOW because a filter is defined with only the parameterId RAINSNOW.
The text of the label in front of the dropdownlist is configurable. The items in the dropdownlist are also configurable. For this modifier the forecaster can choose between options rain and snow. If snow is selected a value of 2 in set into the time series for the selected period.
If rain is selected a value of 1 is written into the time series.
The numbers are treated as flags by the model to which the time series is passed.
Time series modifier
The time series modifier is a modifier which allows the forecaster to edit a timeseries by selecting points in a graph or by
changing values in a modifier. In most applications of this modifier the forecaster is directly editing a time series which is used
by the models. For example it might be used to directly edit the precipitation. This is contrary to how for example the single value modifier
WECHNG is used. This modifier edits an empty time series which is than read by the snow17-model which modifies its state based on the input from
this modifier. A time series modifier always has a start- and enddate. Optionally (if configured) a valid time is available.
The forecaster can edit this time series by making changes in table or in the graph. The changes in the graph are made by clicking in the graph.
When the user clicks from left to right then the values between the points are interpolated.
When the user clicks from right to left only the newly added or changed points are adjusted but no interpolation will be done between
the last two points. When more than one time series is shown in the display it is possible to make a selection of which time series should edited when making changes by clicking in the graph.
The time series which should be changed can be selected by clicking on the legend of that example time series in the graph
Besides editing the time series by editing values in the graph or table another type can be selected by the dropdownbox.
Available options are:
- add
- substract
- mulitply
- divide
- replace
- missing
- ignore time series
- time series
When one of the options add, substract, mulitply, divide or replace is choosen than a text box in which a value can be entered appears next to the operation type-dropdownbox.
The options add, substract, mulitply, divide or replace are self-explaining. They add,substract, multiply,divide or replace the timeseries with the specified value over the specified period of time.
The option missing replaces the values in the time series with missing values over the specified period of time, the ignore time series sets the value over the specified period of time to unreliable.
The last option time series is the default option which will selected after startup of this modifier and this option allows the forecaster to freely edit the timeseries.
An example of the use of the time series modifier is the ROCHNG-modifier which is used by NWS to modify the runoff time series.
Display
Below a screenshot of the timeseries modifier.
Schema
Below the schema of the timeseries modifier.
...
<complexType name="TimeSeriesModifierComplexType">
<complexContent>
<extension base="fews:ModifierBaseComplexType">
<sequence>
<element name="timeSeries" type="fews:TimeSeriesFilterComplexType" minOccurs="0" maxOccurs="unbounded"/>
<element name="softLimits" type="fews:SoftLimitsComplexType" minOccurs="0"/>
<element name="hardLimits" type="fews:HardLimitsComplexType" minOccurs="0"/>
<element name="defaultStartTime" type="fews:DefaultStartTimeEnumStringType">
<annotation>
<documentation>Start of time period to which modifier is applied.
When omitted this value will default to the Year 1000 and will be disabled.
</documentation>
</annotation>
</element>
<element name="offsetDefaultStartTime" type="fews:TimeShiftComplexType" minOccurs="0"/>
<element name="defaultEndTime" type="fews:DefaultEndTimeEnumStringType">
<annotation>
<documentation>End of time period to which modifier is applied.
When omitted this value will default to the Year 3000 and will be disabled.
</documentation>
</annotation>
</element>
<element name="offsetDefaultEndTime" type="fews:TimeShiftComplexType" minOccurs="0"/>
<element name="defaultValidTime" type="fews:emptyElement" minOccurs="0">
<annotation>
<documentation>Forecast time after which the modifier is no longer valid.
When omitted this value will default to the Year 3000 and will be disabled.
</documentation>
</annotation>
</element>
<element name="resolveInWorkflow" type="boolean">
<annotation>
<documentation>search for timeseries in the currently selected workflow. In a IFD environment the selected topology node will provide the selected workflow</documentation>
</annotation>
</element>
<element name="resolveInPlots" type="boolean">
<annotation>
<documentation>search for timeseries in the plots of the currently selected topology node</documentation>
</annotation>
</element>
<element name="editInPlots" type="boolean" default="true" minOccurs="0">
<annotation>
<documentation>Allow to graphically create time series modifiers in the plot display. If this option is disabled, it is only allowed to create this modifier in the modifier display</documentation>
</annotation>
</element>
<element name="createContinousModifiers" type="boolean" default="true" minOccurs="0">
<annotation>
<documentation>if this option is disabled and a modifier is graphically created in the plot display, for each continous period of changes a modifier is created.
By default for each editting sequence a modifier will be created.</documentation>
</annotation>
</element>
</sequence>
</extension>
</complexContent>
</complexType>
the time series identified in tag timeseries.
The modifier will have a start time equal to the start of the run and will end at the end of the run.
The option resolveInWorkflow is set to true and the option resolveInPlots is set to false.
This means that the IFD will search for time series which might be modified in the workflow of the selected
node but it will not search in the time series which are displayed in the plots for this node.
Mark unreliable modifier
This modifier sets all the values in a time series to unreliable over a period so the data will not
be used in the models, but the original values will be displayed.
The display is very similar to the display used for the timeseries modifier however the dropdownbox is disabled
and the option ignore timeseries is enabled.
The forecaster can only edit the start and end dates of the period in which the time series will be set to invalid.
In the Modifiers Display table the unreliable values in the modified time series are marked yellow.
An example of the use of this modifier is the modifier IGNORETS. This modifier is used by the NWS
to arrange that the the model RESSNGL or the tranformation AdjustQ ingores certain types of data.
By setting the correct filter in configuration only certain input time series of ressngl or adjustQ
can be ignored by using the modifier.
Display
Below an example of the display of the mark unreliable modifier.
Schema 
timeSeries
This tag can be used to identify which timeseries this modifier can be applied.
defaultstarttime
The default start time of the modifier can be defined here.
Possible options are:
- startrun
- time zero
defaultendtime
The default end time of the modifier can be defined here.
Possible options are:
- time zero
- end run
Configuration example
Below an configuration example of this type of modifier
| Code Block | ||||
|---|---|---|---|---|
| ||||
<markUnreliableModifier id="ignorets" name="IGNORETS">
<timeSeries>
<moduleInstanceSetId>RESSNGL_Forecast</moduleInstanceSetId>
<valueType>scalar</valueType>
<parameterId>PELV</parameterId>
<locationSetId>Reservoirs</locationSetId>
<timeSeriesType>simulated forecasting</timeSeriesType>
<timeStep unit="hour" multiplier="1"/>
</timeSeries>
<defaultStartTime>start run</defaultStartTime>
<defaultEndTime>end run</defaultEndTime>
</markUnreliableModifier>
|
Compound modifier
The compound modifier can be used to modify a set of time series with slider bars. Each slider shows a reference
value in blue. If no modification is made the value of the slider will be equal to the reference value. If a modification
is made the slider will always be equal to the value of the modifier. Too indicate that a modification was made the text box
will be made yellow.
An example of the use of the compound modifier is the sacco-modifier. This modifier is used to modify the state of the Sacramento-model.
Each slider represents a stateparameter. In blue the current value is shown, the slider is equal to current value of the model or if the
stateparameter is changed it will be equal to the modification.
Display
Below an example of the display of this modifier.
Schema 
slider
For each slider the time series which holds the reference values should be configured, and the time series which should contain the modified value should be configured. Each slider also has maximum value. This maximum is retrieved from the module parameter file of the model. The tag maximumAllowedValueParameterId identifies which parameter should be used to identify the maximum.
current time series
This time series holds the current value of the model and will be used to determine the value of the blue reference value.
modified time series
If a parameter is changed the modifier will be applied to this time series
maximumAllowedParameterId
The maximum of the slider can be derived from the moduleparameterfile by identifying the parameterId which holds the value
of the maximum
hardLimits
It also possible to define the minimum and maximum of the modififications by hard coding them in the configuration.
defaultTime
Default of modifier date. Possible options are startrun and time zero.
Configuration example
Below an example of the configuration of a compound modifier. In this example a part of the sacco configuration is not shown but only the configuration of one of the five sliders is shown.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<compoundModifier id="sacco" name="SACCO">
<slider>
<currentTimeSeries>
<moduleInstanceSetId>SACSMA_Forecast</moduleInstanceSetId>
<valueType>scalar</valueType>
<parameterId>UZTWC</parameterId>
<locationSetId>Gages_Catchments</locationSetId>
<timeSeriesType>simulated forecasting</timeSeriesType>
<timeStep unit="hour" multiplier="6"/>
</currentTimeSeries>
<modifiedTimeSeries>
<moduleInstanceId>ExportMODS</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>UZTWC</parameterId>
<locationSetId>Gages_Catchments</locationSetId>
<timeSeriesType>external historical</timeSeriesType>
<timeStep unit="nonequidistant"/>
</modifiedTimeSeries>
<maximumAllowedValueParameterId>UZTWM</maximumAllowedValueParameterId>
</slider>
<defaultTime>start run</defaultTime>
</compoundModifier>
|
Missing value modifier
The missing value modifier can be used to set the values in a time series to missing over a period of time. The user can only define the period of time over which this modifier is active.
The panel which is used for this modifier is very similar to the panel of the time series modifier.
The dropdowbox however which is used to select an operation type is disabled and set to the type Missing.
An example of the use of this modifier is the SETMSNG-modifier which is used by the NWS. To set the value of certain time series
to missing this modifier is used.
Display
An example of the missing value modifier is shown below.
Schema
timeSeries
This tag can be used to identify to which timeseries this modifier can be applied.
defaultStartTime
The default start time of the modifier. The available options are startrun and time zero.
offsetDefaultStartTime
The offset start time compared to the option defined in defaultStartTime. For example when an offset of 1 day is configured
in this option and the defaultStartTime is set to timezero than the default starttime of the modifier will be set to
time zero plus 1 day.
defaultEndTime
The default end time of the modifier. The available options are time zero and end run.
offsetDefaultEndTime
The offset of the end time compared to the option defined in defaultEndTime.
defaultValidTime
If this option is configured than a valid time can be choosen for this modifier. The valid time always default to time zero.
resolveInWorkflow
In the tag timeSeries is a filter defined which defines which timeseries can be modified with this timeseries. If the tag
resolveInWorkflow is set than the modifier can be applied to all timeseries in the current workflow to which the defined time
series filter applies. In an IFD-environment the current workflow is the workflow which is associated to the selected topology
node.
resolveInPlots
This tag can only be used in IFD-environments. If this tag is enabled than the timeseries-filter is also applied to all timseries
in the plots associated with the current selected topologynode.
editInPlots
It is possible to create a timeseries modifier in the plot displays. This can be done by selecting a timeseries by selecting a legend.
After selection the timeseries can be modified by graphicly editing the timeseries or by changing values in the graph. This feature can
be disabled by setting this option to false.
createContinousModifiers
If a modifier is created in the graph by default one modifier will be created. However if this option is disabled one modifier will
be created for every continious range of modifications made. For example if the forecaster changes a 6 hours timeseries at 00z and at 12z
but not a 0600z than by default this will result in creating a single modifier, but when this option is enabled two modifiers will be
created. One for each continious range of changes. In this case there is a change at 00z and one at 12z therefore two modifiers will
be created.
Configuration example
Below an example of how a time series modifier should be configured.
...
<timeSeriesModifier id="rochng" name="ROCHNG">
<timeSeries>
<moduleInstanceSetId>SACSMA_Forecast</moduleInstanceSetId>
<valueType>scalar</valueType>
<parameterId>INFW</parameterId>
<locationSetId>Gages_Catchments</locationSetId>
<timeSeriesType>simulated forecasting</timeSeriesType>
<timeStep unit="hour" multiplier="6"/>
<ensembleId>QPF</ensembleId>
</timeSeries>
<defaultStartTime>start run</defaultStartTime>
<defaultEndTime>end run</defaultEndTime>
<resolveInWorkflow>true</resolveInWorkflow>
<resolveInPlots>false</resolveInPlots>
</timeSeriesModifier>
This modifier can be applied to the time series identified in tag timeseries.
The modifier will have a start time equal to the start of the run and will end at the end of the run.
The option resolveInWorkflow is set to true and the option resolveInPlots is set to false.
This means that the IFD will search for time series which might be modified in the workflow of the selected
node but it will not search in the time series which are displayed in the plots for this node.
Mark unreliable modifier
This modifier sets all the values in a time series to unreliable over a period so the data will not
be used in the models, but the original values will be displayed.
The display is very similar to the display used for the timeseries modifier however the dropdownbox is disabled
and the option ignore timeseries is enabled.
The forecaster can only edit the start and end dates of the period in which the time series will be set to invalid.
In the Modifiers Display table the unreliable values in the modified time series are marked yellow.
An example of the use of this modifier is the modifier IGNORETS. This modifier is used by the NWS
to arrange that the the model RESSNGL or the tranformation AdjustQ ingores certain types of data.
By setting the correct filter in configuration only certain input time series of ressngl or adjustQ
can be ignored by using the modifier.
Display
Below an example of the display of the mark unreliable modifier.
Schema
...
<complexType name="MarkUnreliableModifierComplexType">
<complexContent>
<extension base="fews:ModifierBaseComplexType">
<sequence>
<element name="timeSeries" type="fews:TimeSeriesFilterComplexType" maxOccurs="unbounded"/>
<element name="defaultStartTime" type="fews:DefaultStartTimeEnumStringType">
<annotation>
<documentation>Start of time period to which modifier is applied.
When omitted this value will default to the Year 1000 and will be disabled.
</documentation>
</annotation>
</element>
<element name="defaultEndTime" type="fews:DefaultEndTimeEnumStringType">
<annotation>
<documentation>End of time period to which modifier is applied.
When omitted this value will default to the Year 3000 and will be disabled.
</documentation>
</annotation>
</element>
</sequence>
</extension>
</complexContent>
</complexType>
timeSeries
This tag can be used to identify which timeseries this modifier can be applied.
defaultstarttime
The default start time of the modifier can be defined here.
Possible options are:
- startrun
- time zero
defaultendtime
The default end time of the modifier can be defined here.
Possible options are:
- time zero
- end run
Configuration example
Below an configuration example of this type of modifier
...
<markUnreliableModifier id="ignorets" name="IGNORETS">
<timeSeries>
<moduleInstanceSetId>RESSNGL_Forecast</moduleInstanceSetId>
<valueType>scalar</valueType>
<parameterId>PELV</parameterId>
<locationSetId>Reservoirs</locationSetId>
<timeSeriesType>simulated forecasting</timeSeriesType>
<timeStep unit="hour" multiplier="1"/>
</timeSeries>
<defaultStartTime>start run</defaultStartTime>
<defaultEndTime>end run</defaultEndTime>
</markUnreliableModifier>
Compound modifier
The compound modifier can be used to modify a set of time series with slider bars. Each slider shows a reference
value in blue. If no modification is made the value of the slider will be equal to the reference value. If a modification
is made the slider will always be equal to the value of the modifier. Too indicate that a modification was made the text box
will be made yellow.
An example of the use of the compound modifier is the sacco-modifier. This modifier is used to modify the state of the Sacramento-model.
Each slider represents a stateparameter. In blue the current value is shown, the slider is equal to current value of the model or if the
stateparameter is changed it will be equal to the modification.
Display
Below an example of the display of this modifier.
Schema
...
<complexType name="CompoundModifierComplexType">
<complexContent>
<extension base="fews:ModifierBaseComplexType">
<sequence>
<element name="slider" type="fews:SliderComplexType" maxOccurs="unbounded"/>
<element name="defaultTime" type="fews:DefaultStartTimeEnumStringType">
<annotation>
<documentation>Start of time period to which modifier is applied.
When omitted this value will default to the Year 1000 and will be disabled.
</documentation>
</annotation>
</element>
</sequence>
</extension>
</complexContent>
</complexType>
...
<complexType name="SliderComplexType">
<sequence>
<element name="currentTimeSeries" type="fews:TimeSeriesFilterComplexType"/>
<element name="modifiedTimeSeries" type="fews:TimeSeriesFilterComplexType"/>
<choice>
<sequence>
<element name="maximumAllowedValueParameterId" type="fews:idStringType"/>
<element name="maximumAllowedValueParameterUnit" type="fews:unitConversionStringType" minOccurs="0">
<annotation>
<documentation>The maximum allowed value for the slider is read from a module parameter file. The units of the parameter can be defined with this tag.</documentation>
</annotation>
</element>
</sequence>
<element name="hardLimits" type="fews:HardLimitsComplexType"/>
</choice>
</sequence>
</complexType>
slider
For each slider the time series which holds the reference values should be configured, and the time series which should contain the modified value should be configured. Each slider also has maximum value. This maximum is retrieved from the module parameter file of the model. The tag maximumAllowedValueParameterId identifies which parameter should be used to identify the maximum.
current time series
This time series holds the current value of the model and will be used to determine the value of the blue reference value.
modified time series
If a parameter is changed the modifier will be applied to this time series
maximumAllowedParameterId
The maximum of the slider can be derived from the moduleparameterfile by identifying the parameterId which holds the value
of the maximum
hardLimits
It also possible to define the minimum and maximum of the modififications by hard coding them in the configuration.
defaultTime
Default of modifier date. Possible options are startrun and time zero.
Configuration example
Below an example of the configuration of a compound modifier. In this example a part of the sacco configuration is not shown but only the configuration of one of the five sliders is shown.
...
<compoundModifier id="sacco" name="SACCO">
<slider>
<currentTimeSeries>
<moduleInstanceSetId>SACSMA_Forecast</moduleInstanceSetId>
<valueType>scalar</valueType>
<parameterId>UZTWC</parameterId>
<locationSetId>Gages_Catchments</locationSetId>
<timeSeriesType>simulated forecasting</timeSeriesType>
<timeStep unit="hour" multiplier="6"/>
</currentTimeSeries>
<modifiedTimeSeries>
<moduleInstanceId>ExportMODS</moduleInstanceId>
<valueType>scalar</valueType>
<parameterId>UZTWC</parameterId>
<locationSetId>Gages_Catchments</locationSetId>
<timeSeriesType>external historical</timeSeriesType>
<timeStep unit="nonequidistant"/>
</modifiedTimeSeries>
<maximumAllowedValueParameterId>UZTWM</maximumAllowedValueParameterId>
</slider>
<defaultTime>start run</defaultTime>
</compoundModifier>
Missing value modifier
The missing value modifier can be used to set the values in a time series to missing over a period of time. The user can only define the period of time over which this modifier is active.
The panel which is used for this modifier is very similar to the panel of the time series modifier.
The dropdowbox however which is used to select an operation type is disabled and set to the type Missing.
An example of the use of this modifier is the SETMSNG-modifier which is used by the NWS. To set the value of certain time series
to missing this modifier is used.
Display
An example of the missing value modifier is shown below.
Schema
...
<complexType name="MissingValueModifierComplexType">
<complexContent>
<extension base="fews:ModifierBaseComplexType">
<sequence>
<element name="timeSeries" type="fews:TimeSeriesFilterComplexType" minOccurs="0" maxOccurs="unbounded"/>
<group ref="fews:MissingValueModifierDatesGroup" minOccurs="0"/>
<element name="expiryTime" type="fews:TimeSpanComplexType" minOccurs="0"/>
<element name="resolveInWorkflow" type="boolean"/>
<element name="resolveInPlots" type="boolean"/>
</sequence>
</extension>
</complexContent>
</complexType>
{code:xml
Below an example of the configuration of a missing value modifier.
...