.. include:: ../../idsubstitutions.txt
.. _VMPZIDMOCFootprintMask:


Output Product: MOC Footprint Mask
=====================================


Data Product Name
__________________
.. DataProductNameStart

DpdMOCFootprintMaskVMPZ

.. DataProductNameEnd

Data Product Custodian
_______________________
.. DataProductCustodianStart

IDVMPZ

.. DataProductCustodianEnd

Name of the Schema File
________________________
.. NameSchemaStart

.. raw:: html 

    <a href="https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/9.2.0/ST_DM_Schema/auxdir/ST_DM_Schema/dpd/le3/id/vmpz/out/euc-le3-id-vmpz-MOCFootprintMask.xsd" target="_blank">euc-le3-id-vmpz-MOCFootprintMask.xsd</a>

.. NameSchemaEnd

Last Edited for DPDD Version
____________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd

Processing Elements Creating / Updating / Using the Product
___________________________________________________________
.. PECreatorStart

**Creators:**

* VMPZ_Main (LE3_VMPZ_ID_Main)

**Consumers:**

* VMPZ_Visibility (LE3_VMPZ_ID_Visibility)

.. PECreatorEnd

Processing function using the data product
_____________________________________________
.. PFUsingStart

* 2PCF-WL, PK-WL, 2PCF-GC, 3PCF-GC, PK-GC, DET-CL, PROF-CL, VMSP-ID
* SWG-GC, SWG-WL, SWG-CL

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

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.

.. IncludeInSASEnd

Data Product Elements
______________________
.. DataProductElementsStart

:Header: object of type sys:genericHeader
:Data: object of type vmpzid:footprintMaskMOCVMPZ
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters: object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This output product is essentially the footprint of the survey for a given band/instrument.
The **FootprintMaskMOC** metadata includes a container with a FITS file (of type le3.id.vmpz.mocfootprintmask)
describing the footprint for the survey in MOC HEALPix format,
for a given observed band/instrument (Euclid/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>`_).
Finally, the mask parameters **FootprintMaskMOCParams** 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:

+----------+-----------+---+-----------------------------------------------------------------+
| SIMPLE   |           | / |                                                                 |
+----------+-----------+---+-----------------------------------------------------------------+
| BITPIX   |           | / |                                                                 |
+----------+-----------+---+-----------------------------------------------------------------+
| NAXIS    |           | / |                                                                 |
+----------+-----------+---+-----------------------------------------------------------------+
| EXTEND   |           | / |                                                                 |
+----------+-----------+---+-----------------------------------------------------------------+
| DATE-OBS |           | / | e.g. Start date for observations considered                     |
+----------+-----------+---+-----------------------------------------------------------------+
| DATE-END |           | / | e.g. End date for observations considered                       |
+----------+-----------+---+-----------------------------------------------------------------+
| TELESCOP |           | / | e.g. Euclid or -1                                               |
+----------+-----------+---+-----------------------------------------------------------------+
| INSTRUME |           | / | e.g. VIS or -1                                                  |
+----------+-----------+---+-----------------------------------------------------------------+
| FILTER   |           | / | e.g. VIS or -1                                                  |
+----------+-----------+---+-----------------------------------------------------------------+
| FILTLST  |           | / | index for combination of filters if intersection of footprints  |
+----------+-----------+---+-----------------------------------------------------------------+
| TILEID   |           | / | e.g. 5237, or -1 if not single tile                             |
+----------+-----------+---+-----------------------------------------------------------------+
| LISTID   |           | / | Product ID for a MER list of tiles                              |
+----------+-----------+---+-----------------------------------------------------------------+
| NSIDE_WK |           | / | Nside used for mosaic frame to HEALPix                          |
+----------+-----------+---+-----------------------------------------------------------------+
| SOFTNAME |           | / |                                                                 |
+----------+-----------+---+-----------------------------------------------------------------+
| SOFTVERS |           | / |                                                                 |
+----------+-----------+---+-----------------------------------------------------------------+
| END                                                                                        |
+----------+-----------+---+-----------------------------------------------------------------+

#. **DATE-OBS**: start of observation with format 'yyyy-mm-ddThh:mm:ss.sss' [StringKeyword]
#. **DATE-END**: end of observation with format 'yyyy-mm-ddThh:mm:ss.sss' [StringKeyword]
#. **TELESCOP**: name of the telescope [StringKeyword]
#. **INSTRUME**: name of the instrument [StringKeyword]
#. **FILTER**: name of the filter [StringKeyword]
#. **FILTLST**: selection of filter if intersection of multiple footprints [StringKeyword]
#. **TILEID**: identifier of the MER Tile processed (-1 if multiple Tiles) [IntegerKeyword]
#. **LISTID**: identifier of a MER list of tiles product (-1 if single Tile) [StringKeyword]
#. **NSIDE_WK**: Nside parameter used for frame->HEALPix [StringKeyword]

   and basic software parameters:

#. **SOFTNAME**: name of software used [StringKeyword]
#. **SOFTVERS**: version of software used  [StringKeyword]

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

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

+----------+--------------+---------------------------------+-----------+
| HDU *FOOTPRINT_MASK*                                                  |
+==========+==============+=================================+===========+
| Keywords | **XTENSION** |                                 | string    |
+          +--------------+---------------------------------+-----------+
|          | **BITPIX**   |                                 | integer   |
+          +--------------+---------------------------------+-----------+
|          | **NAXIS**    |                                 | integer   |
+          +--------------+---------------------------------+-----------+
|          | **NAXIS1**   |                                 | integer   |
+          +--------------+---------------------------------+-----------+
|          | **NAXIS2**   |                                 | integer   |
+          +--------------+---------------------------------+-----------+
|          | **PCOUNT**   |                                 | integer   |
+          +--------------+---------------------------------+-----------+
|          | **GCOUNT**   |                                 | integer   |
+          +--------------+---------------------------------+-----------+
|          | **TFIELDS**  |                                 | integer   |
+          +--------------+---------------------------------+-----------+
|          | **TTYPE1**   |                                 | string    |
+          +--------------+---------------------------------+-----------+
|          | **TFORM1**   |                                 | string    |
+          +--------------+---------------------------------+-----------+
|          | **TTYPE2**   |                                 | string    |
+          +--------------+---------------------------------+-----------+
|          | **TFORM2**   |                                 | string    |
+          +--------------+---------------------------------+-----------+
|          | **PIXTYPE**  |                                 | string    |
+          +--------------+---------------------------------+-----------+
|          | **ORDERING** |                                 | string    |
+          +--------------+---------------------------------+-----------+
|          | **COORDSYS** |                                 | string    |
+          +--------------+---------------------------------+-----------+
|          | **MOCORDER** |                                 | integer   |
+          +--------------+---------------------------------+-----------+
|          | **MOCTYPE**  |                                 | string    |
+          +--------------+---------------------------------+-----------+
|          | **DATE**     |                                 | string    |
+          +--------------+---------------------------------+-----------+
|          | **EXTNAME**  |                                 | string    |
+----------+--------------+---------------------------------+-----------+
| 2 columns table                                                       |
+----------+--------------+---------------------------------+-----------+
| Columns  | **UNIQ**     | Index of the HEALPix pixel cell | FITS *K*  |
+          +--------------+---------------------------------+-----------+
|          | **WEIGHT**   | Mask value, ranging from O to 1 | FITS *E*  |
+----------+--------------+---------------------------------+-----------+

#. **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]
#. **MOCORDER** (best HEALPix order) [IntegerKeyword]
#. **MOCTYPE** [StringKeyword]
#. **DATE**  [StringKeyword]
#. **EXTNAME** (= 'FOOTPRINT_MASK') [StringKeyword]

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 (1: not observed regions) [E, float32]

.. DetailedDescEnd