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

Output Product: Photometric Random Catalog
============================================


Data Product Name
__________________
.. DataProductNameStart

DpdRandomCatalogVMPZ

.. 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-RandomCatalog.xsd" target="_blank">euc-le3-id-vmpz-RandomCatalog.xsd</a>

.. NameSchemaEnd

Last Edited for DPDD Version
____________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd

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

**Creators:**

* VMPZ_Random (LE3_VMPZ_ID_Random)

**Consumers:**

* None

.. 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:randomCatalogVMPZ
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters: object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This output product is a photometric random catalogue.

It is an extension of a base catalogue, includes the **RandomCatalog** metadata,
a container with a FITS file (of type le3.id.vmpz.randomcatalog), and the mask
parameters **RandomParams** 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 used in the depth map
   (e.g. 0 for least significant bit,..,18) [StringKeyword]
#. **DEPTHEST**: estimator used for depth computation [StringKeyword]
#. **BINSEL**: Identifier for the selection of the bin/population [StringKeyword]

   and basic software parameters:

#. **SEED**:Seed used for random generations[StringKeyword]
#. **NSIMOBJ**:Number of simulated objects in the catalogue [IntegerKeyword]
#. **SOFTNAME**: name of software used [StringKeyword]
#. **SOFTVERS**: version of software used  [StringKeyword]


Random Catalogue Table (First Extension, Binary Table)
++++++++++++++++++++++++++++++++++++++++++++++++++++++

#. **SIM_ID**: Galaxy Simulated Id [K, int64]
#. **RIGHT_ASCENSION**: Right ascension (*in degrees*) [D, float64]
#. **DECLINATION**: Declination (*in degrees*) [D, float64]
#. **TOM_BIN_ID**: ID of selection bin [J, int32]
#. **WEIGHT**: weight associated to the galaxy (probability of detection?) [E, float32]

.. note::
   Do we really need a SIM_ID? Ben said that it could be useful if we want to subselect several
   sub-catalogs from a master one if I remember well

.. note::
   The weight column is not clear: does it give a probability of detection in a tomographic bin, or the weight
   associated to a galaxy for mitigating systematics effects/improving SNR  as for the
   photometric galaxy clustering ?- with recipe not yet fixed in WL-

.. note::
   Assigning the TOM_BIN_ID implies knowing the probability of assigning a detected galaxy
   from a given galaxy population to a given TOM_BIN_ID and should imply not yet identified products from PHZ.

.. note::
   Here this is a random catalogue associated to a given selection, not a master catalogue
   where selection can be applied. But the photometric galaxy clustering use case should lead
   to a quite stable selection. Other possibility is to encode selection in the TOM_BIN_ID,
   and then further subselect on this.

.. DetailedDescEnd