.. include:: gcsubstitutions.txt

.. _GCinputDataCatalog:

Input - GC mock Data Catalog Product
======================================


.. GCinputMockDataCatalog

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdLE3gcInputDataCat                                                                         |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | GCCATDATA                                                                                    |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-gc-cat-data-in.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/10.1.2/S |
|                                                | T_DM_Schema/auxdir/ST_DM_Schema/dpd/le3/gc/inp/euc-le3-gc-cat-data-in.xsd>`_                 |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 1.1                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * Created by hand                                                                            |
|                                                | * External tool.                                                                             |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * LE3_GC_2PCF                                                                                |
|                                                | * LE3_GC_PK                                                                                  |
|                                                | * LE3_GC_3PCF                                                                                |
|                                                | * LE3_GC_BK                                                                                  |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product     | * LE3_GC_TwoPointCorrelation                                                                 |
|                                                | * LE3_GC_PowerSpectrum                                                                       |
|                                                | * LE3_GC_ThreePointCorrelation                                                               |
|                                                | * LE3_GC_Bispectrum                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Proposed for inclusion in EAS/SAS              | This product is proposed for inclusion in the SAS: Yes                                       |
|                                                |                                                                                              |
|                                                | Is going to be used by the SWG-GC for their scientific analysis.                             |
+------------------------------------------------+----------------------------------------------------------------------------------------------+

Data Product Elements
______________________
+--------------+----------------------------------------------+
| Header       | object of type sys:genericHeader             |
+--------------+----------------------------------------------+
| Data         | object of type gc:gcTestCatalog              |
+--------------+----------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder            |
+--------------+----------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters |
+--------------+----------------------------------------------+

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This product is a mock catalog simulating the :ref:`SEL-ID<PF-SEL-ID>`
product and containing only the quantities needed for all the Galaxy
Clustering Processing Functions.  The purpose of this catalog is to
provide test datasets to be used to verify and validate the processing
functions.  In the EUCLID LE3 pipeline, this product is replaced by
the SEL-ID product.

.. note::
  The **density** column in the FITS table is used only for testing purposes and is
  not expected to be provided by :ref:`SEL-ID<PF-SEL-ID>`


XML Keywords
^^^^^^^^^^^^
The product contains the following keywords:

**Instrument**
  Identifier of the PF using the mock catalog
**CatalogID**
  Type of mock catalog
**CoordType**
  Coordinates used in the mock catalog [CARTESIAN, EQUATORIAL, PSEUDO_EQUATORIAL]
**AngleType**
  Angular scales used [DEGREES, RADIANS]
**ReleaseName**
  Name of the release using the product
**Catalog**
  FITS file with input catalog


**Catalog** FITS file
^^^^^^^^^^^^^^^^^^^^^
The FITS type *le3.gc.cat.test* contains one binary table HDU named **CATALOG** with the following structure:

.. table::
   :width: 100%

   +-------------------------------------------------------------------------------------------+
   |                                 **HDU** *CATALOG*: header                                 |
   +==========+==========+=========================================================+===========+
   |          | **Name** |                     **Description**                     | **Value** |
   +----------+----------+---------------------------------------------------------+-----------+
   | Keywords | XTENSION |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  BITPIX  |                                                         |  integer  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  NAXIS   |                                                         |  integer  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  NAXIS1  |                                                         |  integer  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  NAXIS2  |                                                         |  integer  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  PCOUNT  |                                                         |  integer  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  GCOUNT  |                                                         |  integer  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | TFIELDS  |                                                         |  integer  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | EXTNAME  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |   DATE   |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | CHECKSUM |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | DATASUM  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | FILENAME |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TTYPE1  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TFORM1  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TUNIT1  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TTYPE2  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TFORM2  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TUNIT2  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TTYPE3  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TFORM3  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TUNIT3  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TTYPE4  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TFORM4  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TUNIT4  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TTYPE5  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TFORM5  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TUNIT5  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TTYPE6  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TFORM6  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  TUNIT6  |                                                         |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | TELESCOP |                    Mission identifier                   |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | INSTRUME |                      PF identifier                      |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | FILENAME |                    Name of fits file                    |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | CAT_TYPE | Catalog Related Keywords Type of catalog DATA or RANDOM |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | CAT_NAME |                       ID of Catalog                     |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | CAT_NOBJ |                 Object Number of Catalog                |  integer  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  COORD   |        coordinate type EQUATORIAL, CARTESIAN, ...       |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  ANGLE   |                  angle type RAD or DEG                  |   string  |
   +          +----------+---------------------------------------------------------+-----------+
   |          | COMPLETE |                completeness of the sample               |   double  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  PURITY  |                   purity of the sample                  |   double  |
   +          +----------+---------------------------------------------------------+-----------+
   |          |  SELECT  |          ID of the file with selection criteria         |  integer  |
   +----------+----------+---------------------------------------------------------+-----------+

.. table::
   :width: 100%

   +-------------------------------------------------------------------------------------------+
   |                             **HDU** *CATALOG*: 5 columns table                            |
   +==========+=============+====================================+============+================+
   |          |   **Name**  |          **Description**           |  **Unit**  |   **Format**   |
   +----------+-------------+------------------------------------+------------+----------------+
   | Columns  |  OBJECT_ID  |    unique identifier of source     |     NA     |   FITS *1K*    |
   +          +-------------+------------------------------------+------------+----------------+
   |          |   COORD_1   |            COORDINATE 1            |     NA     |   FITS *1D*    |
   +          +-------------+------------------------------------+------------+----------------+
   |          |   COORD_2   |            COORDINATE 2            |     NA     |   FITS *1D*    |
   +          +-------------+------------------------------------+------------+----------------+
   |          |   COORD_3   |            COORDINATE 3            |     NA     |   FITS *1D*    |
   +          +-------------+------------------------------------+------------+----------------+
   |          |    WEIGHT   |               mask?                |     NA     |   FITS *1D*    |
   +----------+-------------+------------------------------------+------------+----------------+


.. note::
   The values within the COORD_1, COORD_2 and COORD_3 columns depends on the
   *COORD* keyword.
   The *CARTESIAN* configuration uses X, Y, Z Cartesian distances.
   The *EQUATORIAL* configuration uses RA and Dec angles and the radial distance.
   The *PSEUDO_EQUATORIAL* configuration uses RA and Dec angles and the Redshift (z) of the object.

.. DetailedDescEnd