.. include:: ../../clsubstitutions.txt
.. _detclGalaxiesMask:

Galaxies Mask Input Product
---------------------------

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

detclGalaxiesMask

.. DataProductNameEnd

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

DET-CL

.. DataProductCustodianEnd

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

(TBF)

.. DataModelTagEnd

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

euc-test-le3-cl-detcl-mask.xsd

.. NameSchemaEnd

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

This input product contains the visibility mask for DET-CL

.. SchemaDocTagEnd

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

:Header:       type sys:genericHeader
:Data:         type cl:clustersMask
:QualityFlags: type dqc:sqfPlaceHolder
:Parameters:   type ppr:genericKeyValueParameters

.. DataProductElementsEnd

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

VMPZ-ID, VMSP-ID / DET-CL

.. PECreatorEnd

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

LE3, "Clusters" pipeline 

.. PFUsingEnd

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

This input data product contains the mask of the observed area (corresponding to the detclGalaxies input catalogue). The different masks and formats are listed in VMPZ-ID_

.. _VMPZ-ID : http://euclid.esac.esa.int/dm/dpdd/latest/le3dpd/id/vmpz-id/vmpz-idindex.html

We are here considering a **footprint mask**, in HEALPix format. In order to avoid full-sky coverage where we only need a small sky area, it is assumed that the masks areas are given explicitly, i.e. that only the masked cells appear in the list of cell indices. This product is therefore similar to VMPZ-ID-Healpix-Footprint_ .

.. _VMPZ-ID-Healpix-Footprint :  http://euclid.esac.esa.int/dm/dpdd/latest/le3dpd/id/vmpz-id/dpcards/vmpzid_healpix_bitmask.html 


Keywords
++++++++

These keywords describe the pixelisation system and the masking scales (see VMPZ-ID-Healpix-Footprint_). We currently assume that each mask file is given for a single photometric band.

#. **TTYPE1** (= ‘PIXEL’)
#. **TFORM1** (= ‘I’)
#. **TTYPE2** (= ‘WEIGHT’)
#. **TFORM2** (= ‘E’)
#. **PIXTYPE**: Type of pixelisation scheme (ex: 'HEALPIX')
#. **MASKBAND**: Photometric band of the mask 
#. **NSIDE**:  HEALPix NSIDE parameter (ex: 8192)
#. **ORDERING**: order of the HEALPix sequence ('NESTED' or 'RING')
#. **OBJECT**:  (‘PARTIAL’)

Tables
++++++

This table is a vector containing the value of the mask for each HEALPix resolution element.

#. **PIXEL**: Number of the pixel, if explicit (optional if impicit) 
#. **WEIGHT**: Weight associated to pixel in [0,1] indicating the fraction of the pixel actually covered by the footprint values of the mask

.. DetailedDescEnd