.. include:: ../../idsubstitutions.txt .. _VMPZIDMOCBitMask: Output Product: MOC Bit Mask ============================ Metadata ______________________ +------------------------------------------------+----------------------------------------------------------------------------------------------+ | Data product name | DpdMOCBitMaskVMPZ | +------------------------------------------------+----------------------------------------------------------------------------------------------+ | Data product custodian | IDVMPZ | +------------------------------------------------+----------------------------------------------------------------------------------------------+ | Name of the Schema file | .. raw:: html | | | | | | `euc-le3-id-vmpz-MOCBitMask.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:bitMaskMOCVMPZ | +--------------+----------------------------------------------+ | QualityFlags | object of type dqc:sqfPlaceHolder | +--------------+----------------------------------------------+ | Parameters | object of type ppr:genericKeyValueParameters | +--------------+----------------------------------------------+ 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 `_. 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 `_). 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: .. 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 are ‘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: .. table:: :width: 100% +-----------------------------------------------------------------------------------+ | **HDU** *BIT_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 | + +----------------+-----------------------------+-------------------+ | | MOCORDER | | integer | + +----------------+-----------------------------+-------------------+ | | MOCTYPE | | string | + +----------------+-----------------------------+-------------------+ | | EXTNAME | | string | +----------------+----------------+-----------------------------+-------------------+ .. table:: :width: 100% +-----------------------------------------------------------------------------------+ | **HDU** *BIT_MASK*: 3 columns table | +=========+==========+======================================+==========+============+ | | **Name** | **Description** | **Unit** | **Format** | +---------+----------+--------------------------------------+----------+------------+ | Columns | UNIQ | Index of the HEALPix pixel cell | NA | FITS *K* | + +----------+--------------------------------------+----------+------------+ | | WEIGHT | Mask value, ranging from O to 2^32-1 | NA | FITS *J* | + +----------+--------------------------------------+----------+------------+ | | ERROR | Mask error value | NA | 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] #. **EXTNAME** (= 'BIT_MASK') [StringKeyword] #. **MOCORDER** (best HEALPix order) [IntegerKeyword] The table is then expected to contain the following columns: #. **UNIQ**: index of pixel [K, int64] #. **WEIGHT**: (unsigned integer) value associated to pixel in [0,2^32-1] indicating one or more flags in the bitmask [J, uint32] .. DetailedDescEnd