.. include:: ../../idsubstitutions.txt
.. _VMPZIDMOCEffectiveCoverageMask:

Output Product: MOC Effective Coverage Mask
===========================================

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdMOCEffectiveCoverageVMPZ                                                                  |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | IDVMPZ                                                                                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-id-vmpz-MOCEffectiveCoverageMask.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataMod |
|                                                | el/-/blob/10.1.2/ST_DM_Schema/auxdir/ST_DM_Schema/dpd/le3/id/vmpz/out/euc-le3-id-vmpz-MOCEff |
|                                                | ectiveCoverageMask.xsd>`_                                                                    |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 2.0                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * VMPZ_Main (LE3_VMPZ_ID_Main)                                                               |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * VMPZ_Visibility (LE3_VMPZ_ID_Visibility)                                                   |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product     | * 2PCF-WL, PK-WL, 2PCF-GC, 3PCF-GC, PK-GC, DET-CL, PROF-CL, VMSP-ID                          |
|                                                | * SWG-GC, SWG-WL, SWG-CL                                                                     |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Proposed for inclusion in EAS/SAS              | This product is proposed for inclusion in SAS: yes                                           |
|                                                |                                                                                              |
|                                                | This product is used by different PFs in OU-LE3 and expected to be used in scientific        |
|                                                | analysis in SWG-GC, SWG-WL and SWG-CL.                                                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+

Data Product Elements
______________________
+--------------+----------------------------------------------------+
| Header       | object of type sys:genericHeader                   |
+--------------+----------------------------------------------------+
| Data         | object of type vmpzid:effectiveCoverageMaskMOCVMPZ |
+--------------+----------------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder                  |
+--------------+----------------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters       |
+--------------+----------------------------------------------------+

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This output product is between 0 and 1. It is essentially obtained from the combination of the footprint with extra excluded regions corresponding to regions flagged in the bit mask and RMS image collected in MER :ref:`MERMosaic`. Both Euclid and EXT bands are combined in a single mask.

It includes in **EffectiveCoverageMaskMOC** a container with a FITS file (of type le3.id.vmpz.moceffectivecoveragemask) describing the flag(s) selected, in MOC HEALPix format (one bit per column),
combining all the observed bands/instruments (Euclid and EXT), and a raw description with polygons
of the envelope of the sky covered is added as well to ease future queries on the
product (**SpatialCoverage** metadata, see `spatialFootprint <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/develop/ST_DM_Schema/auxdir/ST_DM_Schema/dictionary/bas/cot/euc-cot.xsd>`_).  The bit selected is also indicated in the product.
Finally, the mask parameters **EffectiveCoverageMaskMOCParams** can optionally be associated to the product.

Keywords (Primary HDU)
++++++++++++++++++++++

The primary HDU is expected to contain the following keywords, characterizing
important parameters of the input product:

.. table::
   :width: 100%

   +--------------------------------------------------------------------------------------------------+
   |                                    **HDU** *PRIMARY*: header                                     |
   +==========+==========+================================================================+===========+
   |          | **Name** |                        **Description**                         | **Value** |
   +----------+----------+----------------------------------------------------------------+-----------+
   | Keywords |  SIMPLE  |                                                                |  logical  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          |  BITPIX  |                                                                |  integer  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          |  NAXIS   |                                                                |  integer  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          |  EXTEND  |                                                                |  logical  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | DATE-OBS |          e.g. Start date for observations considered           |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | DATE-END |           e.g. End date for observations considered            |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | TELESCOP |                       e.g. Euclid or -1                        |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | INSTRUME |                         e.g. VIS or -1                         |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          |  FILTER  |                         e.g. VIS or -1                         |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | FILTLST  | index for combination of filters if intersection of footprints |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          |  TILEID  |              e.g. 5237, or -1 if not single tile               |  integer  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          |  LISTID  |               Product ID for a MER list of tiles               |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | NSIDE_WK |             Nside used for mosaic frame to HEALPix             |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          |  BITSEL  |   e.g. Bit mask selection applied based on MER binary values   |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | SOFTNAME |                                                                |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | SOFTVERS |                                                                |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | SOFTINST |                                                                |   string  |
   +----------+----------+----------------------------------------------------------------+-----------+


Time format is 'yyyy-mm-ddThh:mm:ss.sss' and basic software parameters are:

* **SOFTNAME**: name of software used [StringKeyword]
* **SOFTVERS**: version of software used  [StringKeyword]
* **SOFTINST**: institute developing the software [StringKeyword]


Partial MOC Footprint Table (First Extension, Binary Table)
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

The following keywords are used to describe what MOC conventions are followed:

** FIX THIS LINE** PrintHDUTableContents fit/euc-le3-id.xml le3.id.vmpz.moceffectivecoveragemask EFFECTIVE_COVERAGE_MASK

#. **TTYPE1**  (= 'UNIQ') [StringKeyword]
#. **TFORM1**  (= 'K') [StringKeyword]
#. **TTYPE2**  (= 'WEIGHT') [StringKeyword]
#. **TFORM2**  (= 'E') [StringKeyword]
#. **PIXTYPE** (= 'HEALPIX') [StringKeyword]
#. **ORDERING** (= 'NUNIQ') [StringKeyword]
#. **COORDSYS** (= 'C'=celestial, 'E'=ecliptic or 'G'=galactic) [StringKeyword]
#. **EXTNAME** (= 'EFFECTIVE COVERAGE_MASK') [StringKeyword]
#. **MOCORDER** (best HEALPix order) [IntegerKeyword]

The table is then expected to contain the following columns:

* **UNIQ**: index of pixel [K, int64]
* **WEIGHT**: weight associated to pixel in [0,1] indicating the fraction of the pixel actually covered by the footprint/flagged (1: not observed/flagged regions) [E, float32]

.. DetailedDescEnd