.. _DpdDqcHumanFlags

DQC Human Flags
===============

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdDqcHumanFlags                                                                             |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | DQC                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-dqc-HumanFlags.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/10.1.2/ST_DM |
|                                                | _Schema/auxdir/ST_DM_Schema/dpd/dqc/euc-dqc-HumanFlags.xsd>`_                                |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 10.0                                                                                         |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * ST-DM/ST_DataModelTools/ST_DM_HFCreatorGUI                                                 |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * Euclid Metadata Explorer, i.e. QualityViewer                                               |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| 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:humanFlagInformation      |
+--------------+----------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder            |
+--------------+----------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters |
+--------------+----------------------------------------------+


Detailed Description of the Data Product
________________________________________
.. DetailedDescStart

Human Flags (HF) are flags that are manually added to a Data Product (DP). HFs are saved as DPs
themselves and can be ingested into Euclid Archiv System (EAS). The Data Product Definition (DPD)
for a HF is called 'DpdDqcHumanFlags'.

For the user's convenience, we wrote a tool to create HF DPs. It is called 'HFCreator' and is part
of the ST_DataModelTools project.

See `Human Flags <https://euclid.roe.ac.uk/projects/data-quality-tools/wiki/HumanFlags>`__ for details.

This data product will be automatically loaded when someone is looking at the flagged
data product in the `Euclid Metadata Explorer <https://eas-dps-mex-ops.esac.esa.int/dataproducts>`__ .
The flagged items are shown in the 'Quality' section.

Elements
++++++++

**FlaggedProductID** Product ID of the DP being flagged by this flag.

**HumanFlags** A list of flags.

* FlagId
	An ID is required so the flag can be referred to by a reassessment. Might be removed if
	reassessments are modified to include an element of type flagInstance (directly referencing
	the flag instance in the table of flags). NOTE: There can be reassessments of all kinds of
	flags - i.e. a polymorphism - is this allowed? Can an "xs:choice" mechanism be used? The
	current implementation of humanReassessmentFlag uses *both* mechanisms! Delete one of them.

* Severity
	Severity of the human flag, enumerated string.

* FlaggedItems
	A list of manually flagged items.

	* ItemPath
		A specific XPath pointing to a value that is flagged. For example: //Data/SomePath/SomeValue[1]

	* Explanation
		An explanation of why this item was flagged.

.. DetailedDescEnd