...
| Excerpt | ||
|---|---|---|
| ||
Functionality to define qualifiers to time series, next to locationIds and parameterIds |
Function: | Qualifiers to parameters |
Where to Use? | Time series |
Why to Use? | To reduce the number of parameters |
Description: | Gives a qualifier to a parameter, like "minimum" of "observed" |
Available since: | DelftFEWS200803 |
Contents
| Table of Contents |
|---|
...
An example looks like:
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <qualifiers xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews httphttps://fewsfewsdocs.wldelftdeltares.nl/schemas/version1.0/qualifiers.xsd"> <qualifier id="min" name="min"> <description>minimum</description> </qualifier> <qualifier id="max" name="max"> <description>maximum</description> </qualifier> </qualifiers> |
Qualifiers can also be defined by referring to a csv file in the configuration. For that the <file> and <id> are required. By using %% can be referred to the content of columns in the csv file. So the next example below the columns "qualifierId" and "qualifierName" determine the id and name of all qualifiers present in the csv file. The columns can be used multiple times also in combination with other text as is done for the definition of the attribute "ExternalQualifierId" which will start with "LNG_KLAS_" for all qualifiers followed by the content in the "qualifierId" column. The <group> elements determines to which group of qualifiers a qualifier belongs, this is used to determine whether timeseries can be summed. Time series with different qualifiers of the same group can be summed.
<qualifier id="dag" name="dag">
<shortName>dag</shortName>
<group>tijdstap</group>
</qualifier>
<qualifier id="maand" name="maand">
<shortName>maand</shortName>
<group>tijdstap</group>
</qualifier>
<qualifier id="jaar" name="jaar">
<shortName>jaar</shortName>
<group>tijdstap</group>
</qualifier>
</qualifiers>
|
Qualifier group
A qualifierGroup is a set qualifiers from which only 1 can be assigned to a time series at a time.
Qualifiers not belonging to a group can be combined multiple times but qualifiers within a group cannot.
Qualifiers groups also determine which time series can be combined in the Time Series Dialog. Time series with different qualifiers belonging to the same group can be summed and replaced with a time series without those qualifiers but with all other identical charateristics.
Csv
Qualifiers can also be defined by referring to a csv file in the configuration. For that the <file> and <id> are required. By using %% can be referred to the content of columns in the csv file. So the next example below the columns "qualifierId" and "qualifierName" determine the id and name of all qualifiers present in the csv file. The columns can be used multiple times also in combination with other text as is done for the definition of the attribute "ExternalQualifierId" which will start with "LNG_KLAS_" for all qualifiers followed by the content in the "qualifierId" column.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<qualifiers xmlns | ||||
| Code Block | ||||
| xml | xml | <?xml version="1.0" encoding="UTF-8"?> <qualifiers xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews httphttps://fewsfewsdocs.wldelftdeltares.nl/schemas/version1.0/qualifiers.xsd"> <csvFile> <file>vissen_lengteklasse.csv</file> <id>%qualifierId%</id> <name>%qualifierName%</name> <group>Vissen lengteklasse</group> <attribute id="ExternalQualifierId"> <text>LNG_KLAS_%qualifierId%</text> </attribute> </csvFile> </qualifiers> |
...
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <filters version="1.1" xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews httphttps://fewsfewsdocs.wldelftdeltares.nl/schemas/version1.0/filters.xsd"> <defaultFilterId>River</defaultFilterId> <!--Observed data Filters--> <filter id="River"> <mapExtentId>River</mapExtentId> <child foreignKey="Rain_Gauges"/> <child foreignKey="Qualifiers"/> </filter> <filter id="Rain_Gauges" name="Rain Gauges"> <timeSeriesSet> <moduleInstanceId>NWP_Grid_To_SubCatchments</moduleInstanceId> <valueType>scalar</valueType> <parameterId>P.nwp.fcst</parameterId> <qualifierId>ACCESS_R</qualifierId> <locationSetId>Gauges_P.obs.All</locationSetId> <timeSeriesType>external forecasting</timeSeriesType> <timeStep unit="hour"/> <readWriteMode>read complete forecast</readWriteMode> </timeSeriesSet> <timeSeriesSet> <moduleInstanceId>NWP_Grid_To_SubCatchments</moduleInstanceId> <valueType>scalar</valueType> <parameterId>P.nwp.fcst</parameterId> <qualifierId>ACCESS_A</qualifierId> <locationSetId>Gauges_P.obs.All</locationSetId> <timeSeriesType>external forecasting</timeSeriesType> <timeStep unit="hour"/> <readWriteMode>read complete forecast</readWriteMode> </timeSeriesSet> </filter> <filter id="Qualifiers" name="Qualifiers"> <relativeViewPeriod start="-100000" end="0" unit="day"/> <qualifierConstraints> <idStartsWith prefix="ACCESS_"/> </qualifierConstraints> </filter> </filters> |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <filters version="1.1" xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews httphttps://fewsfewsdocs.wldelftdeltares.nl/schemas/version1.0/filters.xsd"> <timeSeriesSets id="timeSeriesSetsX"> <timeSeriesSet> <moduleInstanceId>Process</moduleInstanceId> <valueType>scalar</valueType> <parameterId>P.norm</parameterId> <qualifierId>qualifierX</qualifierId> <locationId>NROER09</locationId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="day"/> <readWriteMode>read only</readWriteMode> <synchLevel>1</synchLevel> </timeSeriesSet> <timeSeriesSet> <moduleInstanceId>Process</moduleInstanceId> <valueType>scalar</valueType> <parameterId>P.norm</parameterId> <qualifierId>qualifierY</qualifierId> <locationId>NROER09</locationId> <timeSeriesType>external historical</timeSeriesType> <timeStep unit="day"/> <readWriteMode>read only</readWriteMode> <synchLevel>1</synchLevel> </timeSeriesSet> </timeSeriesSets> <filter id="Filter_For_Qualifier_Panel" name="Filter for qualifier panel"> <timeSeriesSetsId>timeSeriesSetsX</timeSeriesSetsId> <qualifierConstraints> <idStartsWith prefix=""/> </qualifierConstraints> </filter> </filters> |
...
By selecting filter "Rain_Gauges" from example above the qualifiers panel will be visible because there are filters based on qualifier constraints defined, but it is empty because the selected filter is not based on qualifier constraints:
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<qualifierRootNode id="Hydrobiologie">
...
<qualifierNode id="Analyse code">
...
<qualifierId>MEA</qualifierId>
<qualifierId>PTB</qualifierId>
<qualifierId>SRA</qualifierId>
...
</qualifierNode>
<qualifierNode id="Compartiment">
<qualifierId>OR</qualifierId>
<qualifierId>OW</qualifierId>
<qualifierId>VE</qualifierId>
</qualifierNode>
...
</qualifierRootNode> |
For instance the qualifier nodes "Analyse code" and "Compartiment" from the configuration above will not be shown in the tree because all data just has "PTB" and "OW" (shown as "Opp. Water") as qualifiers:
Change qualifier labels
When using the (right click) context menu in the qualifier tree it is possible to change the labels of the qualifiers by making a selection of the attributes.
A label picker window will pop up where all attributes of the qualifiers can be selected. Multiple can be selected in any order, if a qualifier does not have that attribute defined it is skipped, when multiple a chosen all beyond the first will be surrounded by brackets. The qualifiers will be order alphabetically on their complete label.
Selections
Before the label all qualifiers have a checkbox which indicates whether they should be taken into account for time series selection. In the next example for each selected qualifier one time series is found so they wil appear in the time series display.
Selecting multiple qualifiers within a groups results in selecting more time series:
But selecting qualifiers over different groups results in selecting less time series:
The icon of a qualifier node indicates what kind of time series selection should be made. The folder icon as shown in the picture above means show all time series separate.
The icon can be clicked to change to a summation icon which mean a total should be calculated of the selected time series with qualifiers belonging to the same group:
...
</qualifierRootNode> |
For instance the qualifier nodes "Analyse code" and "Compartiment" from the configuration above will not be shown in the tree because all data just has "PTB" and "OW" (shown as "Opp. Water") as qualifiers:
Change qualifier labels
When using the (right click) context menu in the qualifier tree it is possible to change the labels of the qualifiers by making a selection of the attributes.
A label picker window will pop up where all attributes of the qualifiers can be selected. Multiple can be selected in any order, if a qualifier does not have that attribute defined it is skipped, when multiple a chosen all beyond the first will be surrounded by brackets. The qualifiers will be order alphabetically on their complete label.
After picking new labels the qualifier tree has to be rebuild and it will reopen the tree at the last part of the tree that was clicked.
Selections
Before the label all qualifiers have a checkbox which indicates whether they should be taken into account for time series selection. In the next example for each selected qualifier one time series is found so they wil appear in the time series display.
Selecting multiple qualifiers within a groups results in selecting more time series:
But selecting qualifiers over different groups results in selecting less time series:
Qualifier summation
The icon of a qualifier node indicates what kind of time series selection should be made. The folder icon as shown in the picture above means show all time series separate.
The icon can be clicked to change to a summation icon which will result in a summation of all time series that only differ on a qualifier within that group. Those time series will be replaced by 1 time series which contains the total value of the summation. A total will appear as 1 time series in the Time Series Dialog:
Qualifier Aggregation
Within a time series set qualifierAggregation can be specified, this combines all time series that have the (in the same time series set) specified qualifiers together to one time series. Aggregation can be done by sum, mean, min or max.