DQC Static Flag Limits¶
Metadata¶
Data product name |
DpdDqcStaticFlagLimits |
Data product custodian |
DQC |
Name of the Schema file |
|
Last Edited for DPDD Version |
10.0 |
Processing Element(s) creating/using the data product |
Creators:
Consumers:
|
Processing function using the data product |
None. |
Proposed for inclusion in EAS/SAS |
Data Product Elements¶
Header |
object of type sys:genericHeader |
Data |
object of type dqc:sqfStaticLimits |
QualityFlags |
object of type dqc:sqfPlaceHolder |
Parameters |
object of type ppr:genericKeyValueParameters |
Detailed Description of the Data Product¶
Static Quality Flags (SQF) are boolean elements stored inside a QualityFlags section at the top level of every Data Product. The Static Quality Flags are called “static” because they are defined within the Data Model and are always present inside the DPs. Each DPD in the Data Model should have Static Quality Flags.
Static Quality Flags indicate whether or not some specific Static Quality Parameter (SQP) is out of bounds (exceeding a maximum limit or minimum limit or lies outside a range). Thus every Static Quality Flag is associated with one specific Static Quality Parameter. Also, every Static Quality Parameter is associated with one or more Static Quality Flag.
Each SQF is tied to one SQP, which is tested against a minimum limit, a maximum limit or a range, i.e. both minimum and maximum limit. This limit can be defined either within the DPD, i.e. in the Data Model (DM) as fixed values in the QualityFlags section, or outside of the DM in a separate DPD (DpdDqcStaticFlagLimits). The tool SQFCreator can be used to create these limits DPs.
See Static Quality Flags Limits for details.
The DPD DpdDqcStaticFlagLimits is used to create the limits-XML-files. With this method, it is possible to change the limits, without changing the DM, it is also possible to define a list of limits for each SQF, so that each element of a vectorial SQP can have its own limit(s). It is also possible to define different sets of limits for the same DPD, so that different scenarios (e.g. ‘Science’ vs ‘Calibration’) can have different limits for their flags. You can also create one DpdDqcStaticFlagLimits DP with limits from multiple DPDs, this is especially useful if one pipeline produces more than one type of DP.
Elements¶
Selector A tag to be referenced when writing pipeline scripts, for selecting a DpdDqcStaticFlagLimits xml file to be applied in a given run. E.g “include FlagLimits with Selector=Calibration”. Although only one FlagLimits file at a time is allowed to be applied on a DP, there may be different limits required for different scenarios, e.g. ‘Science’ vs. ‘Calibration’.
DpdProduct A list of DPDs and their limits, each DPD can be only once in the list.
- DpdName
The name of the data product to which these static quality flags refer to.
- FlagLimits
A list of limits. One for each SQF in the current DPD.
- FlagName
The name of the flag, as it appears in the ‘QualityFlags’ section.
- XPath
The xpath to the Static Quality Parameter (e.g. DpdExtAstromSolution/Data/QualityParams/RootMeanSquare).
- LimitType
The type of the limit (min, max or range).
- DataType
The type of the data of the Static Quality Parameter (byte, int, float or double).
- MinLimit
The minimum limit value in case limit type is min or range. This may be a list, if corresponding Static Quality Parameter is a list.
- MaxLimit
The maximum limit value in case limit type is max or range. This may be a list, if corresponding Static Quality Parameter is a list.
- Description
A short description of the flag.