.. include:: gcsubstitutions.txt

.. _GCinputDataCatalog:

Input - Data Catalog Product
----------------------------
.. GCinputMockDataCatalog


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

DpdLE3gcInputDataCat

.. DataProductNameEnd

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

|CUSTODIANTAG|

.. DataProductCustodianEnd

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

|GCTAG|

.. DataModelTagEnd

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

euc-test-le3-gc-cat-data-in.xsd

.. NameSchemaEnd

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

|DOCTAG|

.. SchemaDocTagEnd

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

:Header:       object of type sys:genericHeader
:Data:         object of type gc:gcTestCatalog
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters:   object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

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

Creator: LE3-GC as input for tests.


.. PECreatorEnd

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

Used by: LE3-GC-2PCF, LE3-GC-PK, LE3-GC-3PCF, LE3-GC-BK.

.. PFUsingEnd

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:


.. tabularcolumns:: |l|l|l|l|

+----------+----------------+---------------------------------------------------+---------+
| HDU *CATALOG*                                                                           |
+==========+================+===================================================+=========+
| Keywords | **TELESCOP**   | Identifier for the mock catalog producer          | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **INSTRUME**   | Identifier for the PF using the mock catalog      | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **FILENAME**   | Name of FITS file                                 | string  |
+          +----------------+---------------------------------------------------+---------+
|          |                                                                              |
|          | Catalog information                                                          |
+          +----------------+---------------------------------------------------+---------+
|          | **CAT_ID**     | Type of mock catalog                              | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **COORD**      | Coordinate type                                   | string  |
|          |                | [CARTESIAN, EQUATORIAL, PSEUDO_EQUATORIAL]        |         |
+          +----------------+---------------------------------------------------+---------+
|          | **ANGLE**      | Angle type for angular coordinates COORD type     | string  |
|          |                | [DEGREES, RADIANS]                                |         |
+----------+----------------+---------------------------------------------------+---------+
| 6 columns table                                                                         |
+----------+----------------+---------------------------------------------------+---------+
| Columns  | **SOURCE_ID**  | Identifier for the source                         |FITS *1K*|
+          +----------------+---------------------------------------------------+---------+
|          | **COORD_1**    | Coordinate 1, according to COORD type             |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **COORD_2**    | Coordinate 2, according to COORD type             |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **COORD_3**    | Coordinate 3, according to COORD type             |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **WEIGHT**     | Weight associated to object                       |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **DENSITY**    | Nbar value for PK/BK                              |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