What |
pi-ratingCurves.xml |
---|---|
Description |
Configuration for rating curves at specific locations |
schema location |
http://fews.wldelft.nl/schemas/version1.0/pi-schema/pi-ratingCurves.xsd |
Entry in ModuleDescriptors |
<moduleDescriptor id="Transformation"> |
Rating Curves Configuration
The transformation stageDischarge/ratingCurve uses rating curves according to the schema pi-ratingcurves.xsd. It is possible to store the ratingcurves in a ratingCurves.xml file in the regionConfig directory. However it is recommended to store
the ratingCurves to the FEWS database. The ratingCurves can be imported in the FEWS database by using a dedicated import which is capable of importing rating curves from file as long as the file is compliant with the pi-ratingCurves.xsd schema.
Rating Curve schema
Below an overview of the schema of the pi-ratingcurves.
Header
The header element contains the metadata about the rating curve. Below an overview of the available elements.
locationId
The location id for which the rating curve is valid
qualifierId
The allows the configurator to add 1 or more qualifier to the definition of the rating curve. This is useful when for 1 location more rating curves are valid.
startDate
This element defines when the rating curve becomes active.
endDate
This (optional) element defines until when the rating curve is activ.
longName
Optional descriptive name
stationName
Optional station name
stageUnit
Definition of the stage unit
dischargeUnit
Definition of the discharge unit
comment
This section allows to define a (optional comment) for the rating curve. If a comment is defined the comment will be shown in the TimeSeriesDialog when viewing the rating curve.
creationDate
The date on which the rating curve was created
creationTime
The time on which the rating curve was created.
region
The decription of the region. This is needed when the id of the rating curve is the same in different regions.
Table
The table contains the actual description of the
InterpolationMethod
Two options are available:linear and logaritmic. When linear is selected the calculation is done by the regular linear method.
In case the logaritmic option is selected the interpolation will be performed on a table with the logaritmic values of the stages and the discharges.
minStage
The minimum stage which is allowed for this rating curve. If the minStage is configured as 0.2m and a stage of 0.1m is used as input to calculate a discharge.
than t he actual stage used in the calculation will not 0.1m but 0.2m. If the rating curve is used in a discharge to stage calculation and the calculated stage is lower than
the minStage than the calculated s tage will be set to the minStage value. If, for example, the minStage is set 0.2m and the calculated stage is equal to 0.1m the
actual calculated stage will be 0.2m to ensure that no stages lower than minStage are calculated.
This option is usually used to limit the stage value calculated when using extrapolation.
maxStage
The maximum stage which is allowed for this rating curve.
If the maxStage is configured as 5.2m and a stage of 5.5m is used as input to calculate a discharge,
then the actual stage used in the calculation will not be 5.5m but 5.2m. If the rating curve is used in a discharge to stage calculation and the calculated stage is higher than
the maxStage than the calculated stage will be set to the minStage value. If, for example, the minStage is set 0.2m and the calculated stage is equal to 0.1m the
actual calculated stage will be 0.2m to ensure that no stages lower than minStage are calculated.
row
The row element can be used to define the rows of the stage-discharge table. Each row has a mandatory stage and discharge element. An optional offset can be added.
If a row doesn't include an offset element then the previous defined offset will be used.