Summary
This howto describes how to configure a preferred equation of a correlation plot (using the correlationdisplay). it describes how to adjust the CorrelationDisplay config file to select a default for a specific correlation.
Description
The files defining what is shown in the correlation display are stored in the DisplayConfigFiles directory. For each correlation a number of elements must be configured:
- inputTimeSerieInfo: Historic time series sets information.
Parameter id is required for calculating correlation. The other variables are required for running the forecast hydrograph. - eventSetsDescriptorId: Correlation event sets descriptor ID
- travelTimesDescriptorId: Travel times descriptor ID
- eventSelectionType: Selection type: event id selection or travel time selection.
A (new) optional element has been added which allows to set a preferred equation-type for the selected correlation: defaultEquation. This elements has to attributes: equationType (required) and polynomalOrder (optional). This element should be the last element of a CorrelationDisplay config file.
The following options are available for the equationType attribute:
- polynomial
- simple_linear
- multiple_linear
- exponential_divide
- exponential_multiply
- power
- logarithmic
- hyperbolic
Configuration Steps
- Open an existing configuration file. In xmlspy grid view it may look like this:
In text view it will look like this:
<?xml version="1.0" encoding="UTF-8"?> <!--NFFS Thames region--> <correlationDisplay xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/correlationDisplay.xsd" version="1.1"> <inputTimeSerieInfo> <moduleInstanceId>ImportTelemetry</moduleInstanceId> <parameterId>H.obs</parameterId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="minute" multiplier="15" divider="1"/> <relativeViewPeriod unit="day" end="2" start="-4"/> <readWriteMode>add originals</readWriteMode> </inputTimeSerieInfo> <eventSetsDescriptorId>NE_Ash_(Herts)_Events</eventSetsDescriptorId> <travelTimesDescriptorId>NE_Ash_(Herts)_TravelTimes</travelTimesDescriptorId> <eventSelectionType>traveltime</eventSelectionType> <outputTimeSerieInfo> <moduleInstanceId>ImportTelemetry</moduleInstanceId> <parameterId>H.simulated</parameterId> <timeSeriesType>simulated forecasting</timeSeriesType> <timeStep unit="minute" multiplier="15" divider="1"/> <relativeViewPeriod unit="day" start="-4" end="2"/> <readWriteMode>add originals</readWriteMode> </outputTimeSerieInfo> <correlationDisplayOptions> <scatterplotOptions> <preferredColor>red</preferredColor> <markerStyle>circle</markerStyle> <markerSize>8</markerSize> </scatterplotOptions> <equationOptions> <lineStyle>solid</lineStyle> <markerStyle>none</markerStyle> </equationOptions> </correlationDisplayOptions> </correlationDisplay>
- Now add the following to the end of the file (before the final </correlationDisplay> element): <defaultEquation equationType="simple_linear"/>. In xmlspy grid view it will now look like this:
<?xml version="1.0" encoding="UTF-8"?> <!--NFFS Thames region--> <correlationDisplay xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/correlationDisplay.xsd" version="1.1"> <inputTimeSerieInfo> <moduleInstanceId>ImportTelemetry</moduleInstanceId> <parameterId>H.obs</parameterId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="minute" multiplier="15" divider="1"/> <relativeViewPeriod unit="day" end="2" start="-4"/> <readWriteMode>add originals</readWriteMode> </inputTimeSerieInfo> <eventSetsDescriptorId>NE_Ash_(Herts)_Events</eventSetsDescriptorId> <travelTimesDescriptorId>NE_Ash_(Herts)_TravelTimes</travelTimesDescriptorId> <eventSelectionType>traveltime</eventSelectionType> <outputTimeSerieInfo> <moduleInstanceId>ImportTelemetry</moduleInstanceId> <parameterId>H.simulated</parameterId> <timeSeriesType>simulated forecasting</timeSeriesType> <timeStep unit="minute" multiplier="15" divider="1"/> <relativeViewPeriod unit="day" start="-4" end="2"/> <readWriteMode>add originals</readWriteMode> </outputTimeSerieInfo> <correlationDisplayOptions> <scatterplotOptions> <preferredColor>red</preferredColor> <markerStyle>circle</markerStyle> <markerSize>8</markerSize> </scatterplotOptions> <equationOptions> <lineStyle>solid</lineStyle> <markerStyle>none</markerStyle> </equationOptions> </correlationDisplayOptions> <defaultEquation equationType="simple_linear"/> </correlationDisplay>