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 it may look like this:
In text view it will look like this: - 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:
