.. include:: ../../gcsubstitutions.txt

.. _CMTwoPCFGC2Dcart:

Output - 2D cartesian [Covariance Matrix of the 2D Cartesian 2PCF Product]
===========================================================================

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdLE3gcCovmatTwoPointCov2Dcart                                                              |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | GCCM2PCOV2D                                                                                  |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-gc-cm2p-cov-2D-cart.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/10. |
|                                                | 1.2/ST_DM_Schema/auxdir/ST_DM_Schema/dpd/le3/gc/euc-le3-gc-cm2p-cov-2D-cart.xsd>`_           |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 1.1                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * LE3_GC_CM2PCF                                                                              |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * None                                                                                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product     | This is a SGS pipeline final output product to be used by SWGs.                              |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| 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:covmat2pCov2D              |
+--------------+----------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder            |
+--------------+----------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters |
+--------------+----------------------------------------------+

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This output product is the covariance and average of the 2D 2PCF in Cartesian coordinates at different separation scales.
The product FITS file has 2 HDUs named **AVERAGE** and **COVARIANCE** containing a list of keywords
that specify the configuration used and a binary table with the 2D correlation
function in Cartesian coordinates.

Processing Element(s) creating/using the data product
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

**Statistics**
  2PCF type [TWO_DIM_CART]
**CountingMethod**
  Counting method [LINKED_LIST, KD_TREE]
**BinTypeDim1**
  binning type along 1st dim
**BinNumberDim1**
  Number of bins along 1st dim
**BinMinValueDim1**
  Minimum separation scale Mpc/h along 1st dim
**BinMaxValueDim1**
  Maximum separation scale Mpc/h along 1st dim
**BinTypeDim2**
  binning type along 2nd dim
**BinNumberDim2**
  Number of bins along 2nd dim
**BinMinValueDim2**
  Minimum separation scale Mpc/h along 2nd dim
**BinMaxValueDim2**
  Maximum separation scale Mpc/h along 2nd dim
**SplitFactor**
  Number of sub-catalogs in which the random catalog has been split for RR computation
**UseWeight**
  Use object weight in the computation [true/false]
**ReconstructionID**
  Identifirer for the reconstruction
**CosmologyID**
  Identifier for the cosmology used
**ReleaseName**
  Name of the release
**FileNum**
  The number of realization used to compute the covariance
**FileAdded**
  Name of the file added to the covariance computation [optional]
**InputCross**
  Input products used are cross-correlation products
**CovarianceFile**
  :ref:`FITS<gc2cmpcftwodimcart>` file with the Average and covariance values


.. _gc2cmpcftwodimcart:


**CovarianceFile** FITS file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The FITS type *le3.gc.cm2p.cov.2D* contains two binary tables HDUs named **AVERAGE** and **COVARIANCE**
with the following structure:

.. table::
   :width: 100%

   +----------------------------------------------------------------------------------------------------------------------+
   |                                              **HDU** *AVERAGE*: 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     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | TELESCOP |                              Mission identifier                              | string = EUCLID |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | INSTRUME |                                PF identifier                                 |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | FILENAME |                              Name of fits file                               |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | N_FILES  |             Catalog Related Keywords Name of Random Catalog Used             |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | INPCROSS |                          ID of reconstruction used                           |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | RUNTYPE  |                        Type of clustering measurement                        |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BLINDING | Flag that identifies products that have been blinded for scientific analysis |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |   STAT   |           2PCF Related Keywords Statistics of 2PCF (e.g. ONE_DIM)            |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  METHOD  |                    Counting method : KD_TREE, LINKED_LIST                    |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN1TYPE |             Scale for used in binning dim 1 :LINear, LOGarithmic             |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN1NUM  |                        Number of bins in scale dim 1                         |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN1MIN  |                       Min value of bin in scale dim 1                        |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN1MAX  |                       Max value of bin in scale dim 1                        |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN2TYPE |            Scale for used in binning dim 2 : LINear, LOGarithmic             |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN2NUM  |                        Number of bins in scale dim 2                         |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN2MIN  |                       Min value of bin in scale dim 2                        |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN2MAX  |                       Max value of bin in scale dim 2                        |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  WEIGHT  |              Use object weight in the computation : true, false              |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  SPLIT   |         Split factor - number of R subcatalogs - used in computation         |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | RECON_ID |                      Identifier for the Reconstruction                       |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | COSMO_ID |         Cosmology Related Keywords Identifier for the cosmology used         |      string     |
   +----------+----------+------------------------------------------------------------------------------+-----------------+

.. table::
   :width: 100%

   +----------------------------------------------------------------------------------------------------------------------+
   |                                          **HDU** *AVERAGE*: 3 columns table                                          |
   +===============+====================+=========================================+================+======================+
   |               |      **Name**      |             **Description**             |    **Unit**    |      **Format**      |
   +---------------+--------------------+-----------------------------------------+----------------+----------------------+
   |    Columns    |     SCALE_DIM1     |               Bin 1d Scale              |       NA       |      FITS *1D*       |
   +               +--------------------+-----------------------------------------+----------------+----------------------+
   |               |     SCALE_DIM2     |               Bin 2d Scale              |       NA       |      FITS *1D*       |
   +               +--------------------+-----------------------------------------+----------------+----------------------+
   |               |      AVERAGE       |          Average per scale bin          |       NA       |      FITS *1D*       |
   +---------------+--------------------+-----------------------------------------+----------------+----------------------+