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

VMSP Distribution Model
========================

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdLE3IDVMSPDistModel                                                                        |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | IDVMSP                                                                                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-id-vmsp-distmodelfile.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/1 |
|                                                | 0.1.2/ST_DM_Schema/auxdir/ST_DM_Schema/dpd/le3/id/vmsp/out/euc-le3-id-vmsp-distmodelfile.xsd |
|                                                | >`_                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 1.1                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | Last Edited for DPDD Version                                                                 |
| product                                        | ____________________________                                                                 |
|                                                | .. DpddVersionlTagStart                                                                      |
|                                                |                                                                                              |
|                                                | 1.1                                                                                          |
|                                                |                                                                                              |
|                                                | .. DpddVersionTagEnd                                                                         |
|                                                |                                                                                              |
|                                                | Processing Elements Creating / Updating / Using the Product                                  |
|                                                | ____________________________________________________________                                 |
|                                                | .. PECreatorStart                                                                            |
|                                                |                                                                                              |
|                                                | **Creators:**                                                                                |
|                                                |                                                                                              |
|                                                | * VMSP_Train                                                                                 |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * VMSP_Sample                                                                                |
|                                                | * GC-SWG                                                                                     |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product     | * ID-VMSP pipeline uses this product to produce the random catalog.                          |
|                                                | * SWG-GC uses this product.                                                                  |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Proposed for inclusion in EAS/SAS              | This product is proposed for inclusion in the SAS: yes                                       |
|                                                |                                                                                              |
|                                                | The VMSP distribution product is constructed from the Deep fields and is a calibration input |
|                                                | for the random catalog :ref:`_DpdLE3IDVMSPRandomCatalog`. It is of interest for verification |
|                                                | of the galaxy clustering pipeline.                                                           |
+------------------------------------------------+----------------------------------------------------------------------------------------------+

Data Product Elements
______________________
+--------------+----------------------------------------------+
| Header       | object of type sys:genericHeader             |
+--------------+----------------------------------------------+
| Data         | object of type vmsp:vmspDistModel            |
+--------------+----------------------------------------------+
| QualityFlags | object of type vmsp:vmspDistModelDqc         |
+--------------+----------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters |
+--------------+----------------------------------------------+

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

The distribution model characterizes the distribution of galaxy properties,
including the redshift, fluxes, size, etc. The distribution model is produced from the Euclid Deep-CPC catalog by the ``VMSP_Train`` processing element. It is an internal dataproduct that is used by ``VMSP_Sample``.

The format of the data file is not currently specified. When ``VMSP_Train`` is run
in `SHUFFLE` mode (now the only supported mode), the file is a FITS binary table
that contains a catalog of sources extracted from the Euclid Deep-CPC fields.

The format of the distribution model is subject to change, and is expected to be updated to describe the interloper galaxy distribution.

Metadata
~~~~~~~~
The metadata stored in the Distribution model file for VMSP-ID
includes the following keys.

* DataContainer dataContainer - DistModel file container
* CatalogName string - Name of the processed catalog
* Version string - Version meta data



.. DetailedDescEnd