...
Time series modifiers modify a time series. The original time series is stored in the database. However as soon as this time series is retrieved from the database the modifier will be applied to it. But it is important to note that the original time series is always available in the database.
The modifiers.xml defines which modifiers are available within a fews configuration. The modifiers can be created in the modifiers panel. TimeValue-modifiers can also be created in the plot display by graphicly editing a time series or by changing
values in a table.
Time series modifiers
Single value modifiers
...
The missing value modifier can be used to set the values in a time series to missing over a period of time.
Like the Mark Unreliable Modifier, for the Missing Value modifier, the forecaster can only edit the start date and the end date of period in which the values of the time series should be set to missing. In the table and the graph of the Modifiers Display the values of the modified time series are not shown when they have been set to missing.
Below an example of the configuration of a missing value modifier.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<missingValueModifier id="setmsng" name="setmsngSETMSNG"> <defaultStartTime>start run</defaultStartTime> <defaultEndTime>end run</defaultEndTime> <resolveInWorkflow>false</resolveInWorkflow> <resolveInPlots>true</resolveInPlots> </missingValueModifier> <timeSeries> <parameterId>QIN</parameterId> </timeSeries> <defaultStartTime>start run</defaultStartTime> <offsetDefaultStartTime unit="day" multiplier="1"/> <defaultEndTime>time zero</defaultEndTime> <offsetDefaultEndTime unit="day" multiplier="100"/> <expiryTime unit="day" multiplier="100"/> <resolveInWorkflow>false</resolveInWorkflow> <resolveInPlots>true</resolveInPlots> </missingValueModifier> |
This missing value modifier can only be applied to time series which have the parameterid QIN because the tag timeseries defines a timeseries-filter with parameterId QIN.
When a missing value modifier is created from the modifiers panel by default the start time of the modifier will be equal to the start of the run plus 1 day.
The end of the modifier will default to time zero plus 100 days.
The tag resolveInWorkflow is set to false and the resolveInPlots tag is set to true which means that the modifier can be applied to all time series in the plots of the node, but will not be applied to the time series identified in the workflow of the node. In this example there are no time series defined to which this modifier should be applied. This means it can applied to all time series which are defined in the plots of a node.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<switchOptionModifier id="ssarreg" name="ssarreg"> <timeValueTimeSeries> <moduleInstanceId>ExportMODS</moduleInstanceId> <valueType>scalar</valueType> <parameterId>SETH</parameterId> <qualifierId>US</qualifierId> <locationSetId>ImportIHFSDB</locationSetId> <timeSeriesType>external forecasting</timeSeriesType> <timeStep unit="nonequidistant"/> <ensembleId>main</ensembleId> </timeValueTimeSeries> <timeValueTimeSeries> <moduleInstanceId>ExportMODS</moduleInstanceId> <valueType>scalar</valueType> <parameterId>SETQ</parameterId> <qualifierId>US</qualifierId> <locationSetId>ImportIHFSDB</locationSetId> <timeSeriesType>external forecasting</timeSeriesType> <timeStep unit="nonequidistant"/> <ensembleId>main</ensembleId> </timeValueTimeSeries> <timeValueTimeSeries> <moduleInstanceId>ExportMODS</moduleInstanceId> <valueType>scalar</valueType> <parameterId>SETS</parameterId> <qualifierId>US</qualifierId> <locationSetId>ImportIHFSDB</locationSetId> <timeSeriesType>external forecasting</timeSeriesType> <timeStep unit="nonequidistant"/> <ensembleId>main</ensembleId> </timeValueTimeSeries> <timeValueTimeSeries> <moduleInstanceId>ExportMODS</moduleInstanceId> <valueType>scalar</valueType> <parameterId>SETDH</parameterId> <qualifierId>US</qualifierId> <locationSetId>ImportIHFSDB</locationSetId> <timeSeriesType>external forecasting</timeSeriesType> <timeStep unit="nonequidistant"/> <ensembleId>main</ensembleId> </timeValueTimeSeries> <timeValueTimeSeries> <moduleInstanceId>ExportMODS</moduleInstanceId> <valueType>scalar</valueType> <parameterId>SETDQ</parameterId> <qualifierId>US</qualifierId> <locationSetId>ImportIHFSDB</locationSetId> <timeSeriesType>external forecasting</timeSeriesType> <timeStep unit="nonequidistant"/> <ensembleId>main</ensembleId> </timeValueTimeSeries> <booleanTimeSeries> <moduleInstanceId>ExportMODS</moduleInstanceId> <valueType>scalar</valueType> <parameterId>FREEFLOW</parameterId> <qualifierId>US</qualifierId> <locationSetId>ImportIHFSDB</locationSetId> <timeSeriesType>external forecasting</timeSeriesType> <timeStep unit="nonequidistant"/> <ensembleId>main</ensembleId> </booleanTimeSeries> <timeValueTimeSeries> <moduleInstanceId>ExportMODS</moduleInstanceId> <valueType>scalar</valueType> <parameterId>SETDS</parameterId> <qualifierId>US</qualifierId> <locationSetId>ImportIHFSDB</locationSetId> <timeSeriesType>external forecasting</timeSeriesType> <timeStep unit="nonequidistant"/> <ensembleId>main</ensembleId> </timeValueTimeSeries> <startTime>start run</startTime> <effectiveDate></effectiveDate> </switchOptionModifier> |
...
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. 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.
Below a configuration example.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<mergeSimpleModifiers>
<reverseOrderModifiers id="switchTs" name="SWITCHTS">
<defaultStartTime>start run</defaultStartTime>
<defaultEndTime>time zero</defaultEndTime>
</reverseOrderModifiers>
</mergeSimpleModifiers>
|