.. _VMPZIDMOCBitMask:

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

Output Product: MOC Footprint Mask
--------------------------------------

Data product name
=================
.. DataProductNameStart

VMPZIDMOCBitMask

.. DataProductNameEnd

Data product custodian
======================
.. DataProductCustodianStart

VMPZ-ID

.. DataProductCustodianEnd

Data model tag
==============
.. DataModelTagStart

|ML2A2BF|

.. DataModelTagEnd

Name of the Schema file
=======================
.. NameSchemaStart

|ML2A2BF|

.. NameSchemaEnd

Schema documentation tag
========================
.. SchemaDocTagStart

|ML2A2BF|

.. SchemaDocTagEnd

Data product elements
=====================
.. DataProductElementsStart

|ML2A2BF|

.. DataProductElementsEnd

Processing Element(s) creating/using the data product
=====================================================
.. PECreatorStart

VMPZ-ID, (CM-)PK-WL

.. PECreatorEnd

Processing function using the data product
==========================================
.. PFUsingStart

LE3

.. PFUsingEnd

Detailed description of the data product
========================================
.. DetailedDescStart

This output product contains essentially a container for a map for one or more flags
in the bitmask as defined in the `MER definition <https://euclid.roe.ac.uk/projects/eucrma/wiki/ImageBitMasks?parent=20120410UserStories>`_.

It includes in **BitMaskMOC** a container with a FITS file (of type le3.id.vmpz.mocbitmask)
describing the flag(s) selected, in MOC HEALPix format (one bit per column),
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/dictionary/bas/cot/euc-test-cot.xsd>`_).  The bit selected is also indicated in the product.
Finally, the mask parameters **BitMaskMOCParams** 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:

#. **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]
#. **BITSEL**: identifier of the bit of combination of bits reported in the bitmask
   (e.g. 0 for least significant bit,..,18) [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:

#. **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** (= 'BIT_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 flagged by the bitN of the mask (1: fully masked regions) [E, float32]

.. warning::
    We have here a solution where we collect just one bit/a combination of bits
    in the bitmask for a single band of an instrument in a MOC HEALPix file.
    Note that the conversion frame->HEALPix implies that we lose the binary format
    if we want the fraction of sky flagged or not in a HEALPix pixel - and therefore
    we need the single bit products.
    The alternative is to have a vectorial form, e.g TFORM2='19E'

.. DetailedDescEnd