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

.. _CMTwoPCFGC2Dcart:

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

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

DpdLE3gcCovmatTwoPointCov2Dcart

.. DataProductNameEnd

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

|CUSTODIANTAG|

.. DataProductCustodianEnd

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

|GCTAG|

.. DataModelTagEnd

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

euc-test-le3-gc-cm2p-cov-2D-cart.xsd

.. NameSchemaEnd

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

|DOCTAG|

.. SchemaDocTagEnd

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

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

.. DataProductElementsEnd

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

Creator: CM2PCF-GC

.. PECreatorEnd

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

This is a SGS pipeline final output product to be used by SWGs.

.. PFUsingEnd

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.


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:

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


+----------+----------------+---------------------------------------------------+---------+
| HDU *AVERAGE*                                                                           |
+==========+================+===================================================+=========+
| Keywords | **TELESCOP**   | Mission identifier [EUCLID]                       | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **INSTRUME**   | PF producing this file [LE3GC]                    | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **FILENAME**   | Name of FITS file                                 | string  |
+          +----------------+---------------------------------------------------+---------+
|          |                                                                              |
|          | Catalog information                                                          |
+          +----------------+---------------------------------------------------+---------+
|          | **N_FILES**    | Number of 2PCF products file used for covariance  | integer |
+          +----------------+---------------------------------------------------+---------+
|          | **INPCROSS**   | [true/false] input is cross-correlation           | string  |
+          +----------------+---------------------------------------------------+---------+
|          |                                                                              |
|          | 2PCF information                                                             |
+          +----------------+---------------------------------------------------+---------+
|          | **STAT**       | Statistics of 2PCF [TWO_DIM_CART]                 | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **METHOD**     | Pair counting method [LINKED_LIST, KD_TREE]       | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1TYPE**   | Scale for binning [LIN, LOG]                      | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1NUM**    | Number of bins in scale dim 1                     | integer |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1MIN**    | Min value of scale dim 1                          | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1MAX**    | Max value of scale dim 1                          | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2TYPE**   | Scale for binning dim 2 [LIN, LOG]                | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2NUM**    | Number of bins in scale dim 2                     | integer |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2MIN**    | Min value of scale  dim 2                         | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2MAX**    | Max value of scale dim 2                          | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **WEIGHT**     | Object weight use in computation [true, false]    | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **SPLIT**      | Number of R subcatalogs in computation            | integer |
+          +----------------+---------------------------------------------------+---------+
|          | **RECON_ID**   | Identifier for the reconstruction used            | string  |
+          +----------------+---------------------------------------------------+---------+
|          |                                                                              |
|          | Cosmology information                                                        |
+          +----------------+---------------------------------------------------+---------+
|          | **COSMO_ID**   | Identifier for the cosmology used                 | string  |
+----------+----------------+---------------------------------------------------+---------+
| 3 columns table                                                                         |
+----------+----------------+---------------------------------------------------+---------+
| Columns  | **SCALE_DIM1** | Separation distance dim 1 [Mpc/h]                 |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **SCALE_DIM2** | Separation distance dim 2 [Mpc/h]                 |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **AVERAGE**    | 2PCF averaged value per bin                       |FITS *1D*|
+----------+----------------+---------------------------------------------------+---------+


+----------+----------------+---------------------------------------------------+---------+
| HDU *COVARIANCE*                                                                        |
+==========+================+===================================================+=========+
| Keywords | **TELESCOP**   | Mission identifier [EUCLID]                       | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **INSTRUME**   | PF producing this file [LE3GC]                    | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **FILENAME**   | Name of FITS file                                 | string  |
+          +----------------+---------------------------------------------------+---------+
|          |                                                                              |
|          | Catalog information                                                          |
+          +----------------+---------------------------------------------------+---------+
|          | **N_FILES**    | Number of 2PCF products file used for covariance  | integer |
+          +----------------+---------------------------------------------------+---------+
|          | **INPCROSS**   | [true/false] input is cross-correlation           | string  |
+          +----------------+---------------------------------------------------+---------+
|          |                                                                              |
|          | 2PCF information                                                             |
+          +----------------+---------------------------------------------------+---------+
|          | **STAT**       | Statistics of 2PCF [TWO_DIM_CART]                 | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **METHOD**     | Pair counting method [LINKED_LIST, KD_TREE]       | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN_TYPE**   | Scale for binning [LIN, LOG]                      | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1NUM**    | Number of bins in scale dim 1                     | integer |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1MIN**    | Min value of scale dim 1                          | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1MAX**    | Max value of scale dim 1                          | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2TYPE**   | Scale for binning dim 2 [LIN, LOG]                | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2NUM**    | Number of bins in scale dim 2                     | integer |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2MIN**    | Min value of scale  dim 2                         | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2MAX**    | Max value of scale dim 2                          | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **WEIGHT**     | Object weight use in computation [true, false]    | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **SPLIT**      | Number of R subcatalogs in computation            | integer |
+          +----------------+---------------------------------------------------+---------+
|          | **RECON_ID**   | Identifier for the reconstruction used            | string  |
+          +----------------+---------------------------------------------------+---------+
|          |                                                                              |
|          | Cosmology information                                                        |
+          +----------------+---------------------------------------------------+---------+
|          | **COSMO_ID**   | Identifier for the cosmology used                 | string  |
+----------+----------------+---------------------------------------------------+---------+
| 5 columns table                                                                         |
+----------+----------------+---------------------------------------------------+---------+
| Columns  |**SCALE-DIM1-I**| Bin scale dim 1 I                                 |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          |**SCALE-DIM2-I**| Bin scale dim 2 I                                 |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          |**SCALE-DIM1-J**| Bin scale dim 1 J                                 |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          |**SCALE-DIM2-J**| Bin scale dim 2 J                                 |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **COVARIANCE** | Covariance value                                  |FITS *1D*|
+----------+----------------+---------------------------------------------------+---------+

.. DetailedDescEnd