| scrollbar |
|---|
What | HistoricalEvents.xml |
|---|---|
Required | no |
Description | Definition of historical events to be plotted against real time forecast data for reference purposes |
schema location |
DELFT-FEWS allows a set of historical events to be defined that can be retrieved when looking at forecast data through the time series display. These events can then be displayed in the same plot as the real-time data for reference purposes.
...
- HistoricalEvents: Fixed file name for the HistoricalEvents configuration (this can now be split into multiple files with different post fixes i.e. HistoricalEvents_Northern.xml, HistoricalEvents_West.xml)
- 1.00: Version number
- default: Unit to indicate the version is the default configuration (otherwise omitted).
...
- locationId: Id of the location of the event (see definition of DELFT-FEWS locations).
- parameterId: Id of the parameter in the event (see definition of DELFT-FEWS parameters).
- name: name of the historical event. This name will be available as a list of historical events.
Alternatively locationId, parameterId and eventData can be left out and replaced with historicalEventSets.
eventData
Time series data for the event. This follows the same defition of the inputVariable detailed in the Tranformation Module configuration. The typical profile option is used for defining an historical event).
Attributes;:
- variableId: ID of the variable (group).Later used in referencing the variable.
- variableType: Optional type definition of variable (defaults to "any")
- convertDatum: Optional Boolean flag to indicate if datum is to be converted.
...
Time step for typical profile if variable to be defined for the historical event.
Attributes;:
- unit (enumeration of: second, minute, hour, day, week, nonequidistant)
- multiplier defines the number of units given above in a time step (not relevant for nonequidistant time steps)
- divider same function as the multiplier, but defines fraction of units in time step.
...
Data entered to define the event. Data is entered using the dateTime attribute only, the specific date and time values given for each data point. Other attributes available for defining typical profiles are not used.
Attributes;:
- dateTime: Attribute value indicating the value entered is valid for a specific date time combination. The string has the format "<year><month><day>T<hour>:<minute>:<second>". For example the 23rd of August is "1984-12-31T00:00:00".
...
Example of an Historic event without using historical event sets (example file):
| Code Block | ||
|---|---|---|
| ||
| ||
<!— Example historic event --> <historicalEvent name="04-07 January 1999" locationId="RCS.RIV.765512" parameterId="H.obs"> <eventData> <timeStep unit="minute" multiplier="15"/> <relativeViewPeriod unit="hour" start="-48" end="24"/> <data dateTime="1999-01-04T10:00:00" value="2.196"/> <data dateTime="1999-01-04T10:15:00" value="2.199"/> <data dateTime="1999-01-04T10:30:00" value="2.201"/> <data dateTime="1999-01-04T10:45:00" value="2.198"/> <data dateTime="1999-01-04T11:00:00" value="2.204"/> <data dateTime="1999-01-04T11:15:00" value="2.213"/> <data dateTime="1999-01-04T11:30:00" value="2.218"/> <data dateTime="1999-01-04T11:45:00" value="2.233"/> <data dateTime="1999-01-04T12:00:00" value="2.252"/> ... ... ... <data dateTime="1999-01-07T09:15:00" value="2.472" comment="Notified everybody to monitor this."/> <data dateTime="1999-01-07T09:30:00" value="2.462"/> <data dateTime="1999-01-07T09:45:00" value="2.453"/> <data dateTime="1999-01-07T10:00:00" value="2.444"/> </eventData> </historicalEvent> |
Example of an Historic event when using historical event sets:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<!— Example historic event sets -->
<historicalEventSet name="04-07 January 1999">
<historicalEvent locationId="RCS.RIV.765512" parameterId="H.obs" name="test">
<eventData>
<timeStep unit="minute" multiplier="15"/>
<relativeViewPeriod unit="hour" start="-48" end="24"/>
<data dateTime="1999-01-04T10:00:00" value="2.196"/>
<data dateTime="1999-01-04T10:15:00" value="2.199"/>
<data dateTime="1999-01-04T10:30:00" value="2.201"/>
<data dateTime="1999-01-04T10:45:00" value="2.198"/>
<data dateTime="1999-01-04T11:00:00" value="2.204"/>
<data dateTime="1999-01-04T11:15:00" value="2.213"/>
<data dateTime="1999-01-04T11:30:00" value="2.218"/>
<data dateTime="1999-01-04T11:45:00" value="2.233"/>
<data dateTime="1999-01-04T12:00:00" value="2.252"/>
<data dateTime="1999-01-07T09:15:00" value="2.472" comment="Notified everybody to monitor this."/>
<data dateTime="1999-01-07T09:30:00" value="2.462"/>
<data dateTime="1999-01-07T09:45:00" value="2.453"/>
<data dateTime="1999-01-07T10:00:00" value="2.444"/>
</eventData>
</historicalEvent>
<historicalEvent locationId="RDS.RIV.765772" parameterId="H.obs" name="test2">
<eventData>
<timeStep unit="minute" multiplier="15"/>
<relativeViewPeriod unit="hour" start="-48" end="24"/>
<data dateTime="1999-01-04T10:00:00" value="3.146"/>
<data dateTime="1999-01-07T09:15:00" value="3.371" comment="Notified AK."/>
</eventData>
</historicalEvent>
</historicalEventSet>
</historicalEvents>
|