Correlation display
The correlation display is a display plug-in that extends the correlation module functionality. The display allows the user to interactively establish correlation between upstream and downstream locations and derive a forecast based on these correlations.
For each correlation display to be used interactively, the configuration included only the definition of the correlationEventSets to be used. The layout of the display cannot be configured.
The Id of the correlation display is identified in the DisplayInstanceDescriptors. When available on the file system, the name of the XML file for configuring the display with an Id of e.g. LookupDisplay is for example:
LookupDisplay 1.00 default.xml
LookupDisplay |
File name for the LookupDisplay configuration |
1.00 |
Version number |
default |
Flag to indicate the version is the default configuration (otherwise omitted). |
Figure 153 Root elements of the configuration display configuration.
inputTimeSerieInfo
TimeSeriesSet defined for the input data. This time series set is used when applying the correlation established to a complete hydrograph.
eventSetsDescriptorId
Id of the correlationEventSets to be used in the display. The event set must be defined in the CorrelationEventSetsDescriptors configuration (See regional Configuration).
travelTimesDescriptorId
Id of the travelTimesDescriptor to be used in the display. The travel times set must be defined in the TravelTimesDescriptors configuration (See regional Configuration).
outputTimeSerieInfo
TimeSeriesSet defined for the output data. This time series set is used only for displaying the temporary time series to be displayed when applying the correlation established to a complete hydrograph. This time series is not saved in the database.
correlationDisplayOptions
Root element of options element for setting line colours in the scatter plot.
Figure 154 Elements of the scatterplot item in the CorrelationDisplay configuration
scatterplotOptions
Options for setting the properties of the scatter plot. The lineStyle of the scatter plot is "none" by definition (need not be defined).
equationOptions
Options for setting the properties of the regression line determined with the equation established.
preferredColor
Preferred colour for plotting scatter plot / regression line. For enumeration see timeSeriesDisplay Configuration in System Configuration.
markerStyle
Marker style for scatter plot / regression line. For enumeration see timeSeriesDisplay Configuration in System Configuration.
markerSize
Marker size for scatter plot / regression line in points.
