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

.. _CMTwoPCFGC2Dpol:

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

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdLE3gcCovmatTwoPointCov2Dpol                                                               |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | GCCM2PCOV2D                                                                                  |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-gc-cm2p-cov-2D-pol.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-pol.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 Polar 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 polar coordinates.

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<gc2cmpcftwodimpol>` file with the Average and covariance values



.. _gc2cmpcftwodimpol:

.. include:: cm2pcfgc_OUTPUT_2D_cart.rst
  :start-after: _gc2cmpcftwodimcart


.. DetailedDescEnd