Anchor |
---|
| _Toc154574433 |
---|
| _Toc154574433 |
---|
|
Correlation Module Configuration
...
- equationType . Selection of equation type. Enumeration of options include
- polynomial
![](/download/attachments/8683969/image004.png?version=1&modificationDate=1186731140000&api=v2)
- simple_linear
![](/download/attachments/8683969/image006.png?version=1&modificationDate=1186731140000&api=v2)
- exponential_divide
![](/download/attachments/8683969/image008.png?version=1&modificationDate=1186731140000&api=v2)
- exponential_multiply
![](/download/attachments/8683969/image010.png?version=1&modificationDate=1186731140000&api=v2)
- power
![](/download/attachments/8683969/image012.png?version=1&modificationDate=1186731140000&api=v2)
- logarithmic
![](/download/attachments/8683969/image014.png?version=1&modificationDate=1186731140000&api=v2)
- hyperbolic
![](/download/attachments/8683969/image016.png?version=1&modificationDate=1186731140000&api=v2)
- polynomialOrder : Integer value for value of polynomial order. Applies only if polynomial equation is selected.
eventSetsDescriptorId
Id of the event sets to be used. This id is defined in the CorrelationEventSetsDescriptors (see Regional Configuration). A suitable CorrelationEventSets configuration must be available (see below).
travelTimesDescriptorId
Id of the event sets to be used. This id is defined in the CorrelationEventSetsDescriptors (see Regional Configuration). A suitable CorrelationEventSets configuration must be available (see below).
eventSelectionType
Method to be used in matching events. Events at the support and forecast location can be paired either on the basis of common EventId's, or on the basis of a selection on travel time, where events at the upstream and downstream location are paired if these are found to belong to the same hydrological event as defined using travel time criteria defined in the TravelTimes Configuration. Enumeration of options includes; - eventid
- traveltime
Optional comment for correlation configuration. Used for reference purposes only.
selectionCriteria
Selection criteria used in defining events to be used in establishing correlations.
Figure 83 Elements of the selectionCriteria configuration
period
Root element for defining selection of events based on dates.
startDate
Start date of time span to be used in selection (yyyy-MM-dd).
endDate
End date of time span to be used in selection (yyyy-MM-dd).
startTime
Optional start time of time span to be used in selection (HH:mm:ss)
endTime
Optional end time of time span to be used in selection (HH:mm:ss)
selectInsidePeriod
Boolean to indicate if events are to be selected that fall in the time span defined, or that fall outside the time span defined.
thresholds
Root element for defining selection of events that fall above or below a threshold. The threshold is applied to events selected at the forecast location.
thresholdLimit
Value of the threshold to use in selecting events.
selectAboveLimit
Boolean to indicate if events are to be selected that fall above the threshold if true. Events are selected below the threshold if false.
Root element for defining selection of events on tags defined in the eventSets
tag
Definition of tag to use in event selection. Multiple tags may be defined.
include
Boolean to define if events with given tag are to be included or excluded in selection.
Anchor |
---|
| _Toc154574434 |
---|
| _Toc154574434 |
---|
|
CorrelationEventSetsThis configuration file is related to the Correlation module, and is used to define the events used in establishing a correlation. The configuration file is in the CorrelationEventSets (table or directory). Each configuration defined is referenced using a CorrelationEventSetsId as defined in the Regional Configuration.
...