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

Output Product: HEALPix Visibility Mask
=======================================

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdHealpixVisibilityMaskVMPZ                                                                 |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | IDVMPZ                                                                                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-id-vmpz-HealpixVisibilityMask.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/ |
|                                                | -/blob/10.1.2/ST_DM_Schema/auxdir/ST_DM_Schema/dpd/le3/id/vmpz/out/euc-le3-id-vmpz-HealpixVi |
|                                                | sibilityMask.xsd>`_                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 2.0                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * VMPZ_Visibility (LE3_VMPZ_ID_Visibility)                                                   |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * VMPZ_Random (LE3_VMPZ_ID_Random)                                                           |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| 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:visibilityMaskHealpixVMPZ |
+--------------+-------------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder               |
+--------------+-------------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters    |
+--------------+-------------------------------------------------+

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This output product is a HEALPix Partial map collecting, at a given position of the sky and for a given type/redshift
bin, the excess or deficit of galaxies with respect to the mean density (= density contrast) assumed to be related to
systematic effects.

It includes the **VisibilityMaskHealpix** metadata, a container with a FITS file
(of type le3.id.vmpz.healpixvisibilitymask) describing the visibility map for the survey
in (partial) HEALPix format, 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, `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 **VisibilityMaskHealpixParams** 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  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | DEPTHEST |                       Estimator of depth                       |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          |   SEL    |                 Whole galaxy selection string.                 |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          |  BINSEL  |               ID of galaxy sample/bin selection                |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | SOFTNAME |                                                                |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | SOFTVERS |                                                                |   string  |
   +          +----------+----------------------------------------------------------------+-----------+
   |          | SOFTINST |                                                                |   string  |
   +----------+----------+----------------------------------------------------------------+-----------+


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

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

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

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

.. table::
   :width: 100%

   +------------------------------------------------------------------------------+
   |                      **HDU** *VISIBILITY_MASK*: header                       |
   +===============+===============+===========================+==================+
   |               |    **Name**   |      **Description**      |    **Value**     |
   +---------------+---------------+---------------------------+------------------+
   |    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      |
   +               +---------------+---------------------------+------------------+
   |               |     TTYPE3    |                           |      string      |
   +               +---------------+---------------------------+------------------+
   |               |     TFORM3    |                           |      string      |
   +               +---------------+---------------------------+------------------+
   |               |    PIXTYPE    |                           |      string      |
   +               +---------------+---------------------------+------------------+
   |               |    ORDERING   |                           |      string      |
   +               +---------------+---------------------------+------------------+
   |               |    COORDSYS   |                           |      string      |
   +               +---------------+---------------------------+------------------+
   |               |    EXTNAME    |                           |      string      |
   +               +---------------+---------------------------+------------------+
   |               |     NSIDE     |                           |     integer      |
   +               +---------------+---------------------------+------------------+
   |               |    INDXSCHM   |                           |      string      |
   +---------------+---------------+---------------------------+------------------+

.. table::
   :width: 100%

   +------------------------------------------------------------------------------+
   |                  **HDU** *VISIBILITY_MASK*: 3 columns table                  |
   +=========+==========+=================================+==========+============+
   |         | **Name** |         **Description**         | **Unit** | **Format** |
   +---------+----------+---------------------------------+----------+------------+
   | Columns |  PIXEL   | Index of the HEALPix pixel cell |    NA    |  FITS *K*  |
   +         +----------+---------------------------------+----------+------------+
   |         |  WEIGHT  |              Depth              |    NA    |  FITS *E*  |
   +         +----------+---------------------------------+----------+------------+
   |         |  ERROR   |         Mask error value        |    NA    |  FITS *E*  |
   +---------+----------+---------------------------------+----------+------------+


#. **TTYPE1**  (= 'PIXEL') [StringKeyword]
#. **TFORM1**  (= 'K') [StringKeyword]
#. **TTYPE2**  (= 'WEIGHT') [StringKeyword]
#. **TFORM2**  (= 'E') [StringKeyword]
#. **PIXTYPE** (= 'HEALPIX') [StringKeyword]
#. **ORDERING** (= 'RING' or 'NESTED') [StringKeyword]
#. **COORDSYS** (= 'C'=celestial, 'E'=ecliptic or 'G'=galactic) [StringKeyword]
#. **EXTNAME** (= 'VISIBILITY_MASK') [StringKeyword]
#. **NSIDE** [IntegerKeyword]
#. **INDEXSCHM** (= 'EXPLICIT') [StringKeyword]

The table is then expected to contain the following columns:

* **PIXEL**: index of pixel [K, int64]
* **WEIGHT**: (floating-point) weight in [0,1] giving the probability of detection of a given population/bin

.. DetailedDescEnd