.. include:: ../../wlsubstitutions.rst
.. _CovarTwoPCFWLClPosPos2D:

Output Product: Covariance of Tomographic Angular Power Spectra
=================================================================

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdCovarTwoPCFWLClPosPos2D                                                                   |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | WLCMTWOPCF                                                                                   |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-wl-cmtwopcf-ClPosPos2D.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/ |
|                                                | 10.1.2/ST_DM_Schema/auxdir/ST_DM_Schema/dpd/le3/wl/cmtwopcf/out/euc-le3-wl-cmtwopcf-ClPosPos |
|                                                | 2D.xsd>`_                                                                                    |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 1.1                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * LE3_CM_2PCF_WL_PosPos_Pipeline                                                             |
|                                                | * LE3_CM_2PCF_WL_PosPosEstimator_Pipeline                                                    |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * WL-SWG                                                                                     |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product     | SGS pipeline output product to be used by LE3 and SWGs                                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Proposed for inclusion in EAS/SAS              | This product is proposed for inclusion in the SAS: Yes                                       |
|                                                |                                                                                              |
|                                                | The covariance matrix gives the error estimates of the position-position real space second   |
|                                                | order statistics power spectrum function.                                                    |
+------------------------------------------------+----------------------------------------------------------------------------------------------+

Data Product Elements
________________________
+--------------+-------------------------------------------------+
| Header       | object of type sys:genericHeader                |
+--------------+-------------------------------------------------+
| Data         | object of type wlcm2pcf:covarTwoPCFWLClPosPos2D |
+--------------+-------------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder               |
+--------------+-------------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters    |
+--------------+-------------------------------------------------+

Detailed Description of the Data Product
__________________________________________
.. DetailedDescStart

This product contains the covariance matrix for tomographic angular power spectra.

This output product is a fits binary table containing important input
parameters as keywords in primary HDU, and a binary table in the next HD with the
covariance for tomographic angular power spectra as described in
 `le3.wl.cm2pcf.output.clpospos2d <https://gitlab.euclid-sgs.uk/ST-DM/ST_FitsDataModel/-/blob/9.2.0/ST_DM_FitsSchema/auxdir/ST_DM_FitsSchema/instances/fit/euc-le3-wl.xml#L982>`_.

* **SpatialCoverage** a description of the spatial footprint [optional, cot:spatialFootprint],
* **CatalogSelection**: describing the selection in the input catalogues [optional, up to 4 elements]

  *  **CatalogFileName**: the name of the input catalogue [sys:dataFileName]
  *  **Selection**: selection associated to catalogue [string]
  *  **CatalogUse**: for which use case the catalog is employed (=["PosPos"])
     [string among "PosPos", "PosShear", "ShearShear"]
  *  **CatalogInfo**:  whether position or shear information is used in this catalogue (=["Pos"])
     [string among "Pos", "Shear"]
  * **CatalogOrder**: order associated to catalogue for reporting (e.g. BIN_ID1)[int32]

Keywords
+++++++++++++

This fits table is expected to contain the following keywords in primary HDU,
characterizing the important parameters of the product:

.. table::
   :width: 100%

   +----------------------------------------------------------------------------------------------------------------+
   |                                           **HDU** *PRIMARY*: header                                            |
   +==========+==========+==============================================================================+===========+
   |          | **Name** |                               **Description**                                | **Value** |
   +----------+----------+------------------------------------------------------------------------------+-----------+
   | Keywords |  SIMPLE  |                                                                              |  logical  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  BITPIX  |                                                                              |  integer  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  NAXIS   |                                                                              |  integer  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  EXTEND  |                                                                              |  logical  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  W_EST   |                          Estimator of angular 2PCF                           |   string  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  RS_EST  |                           Estimator for resampling                           |   string  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  RS_STR  |                              Type of resampling                              |   string  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  THMIN   |                             Min of angular range                             |   double  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  THMAX   |                             Max of angular range                             |   double  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |   OATH   |                             Open Angle threshold                             |   double  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  THUNIT  |                                Unit of theta                                 |   string  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          | BINSCALE |                               lin or log bins                                |   string  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          | COORDSYS |                            cartesian or spherical                            |   string  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  NBINS   |                            Number of angular bins                            |  integer  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          |  NCOMBS  |                          Number of bin combination                           |  integer  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          | INX_COMB |                   Inner index of the combination {1 or 2}                    |  integer  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          | SHE_SOFT |       Where the input catalogue is coming from (if SHE catalogue used)       |   string  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          | POS_SEL  |       ID of selection made (e.g. tomographic redshifts, stellar mass)        |   string  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          | SOFTNAME |                                                                              |   string  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          | SOFTVERS |                                                                              |   string  |
   +          +----------+------------------------------------------------------------------------------+-----------+
   |          | BLINDING | Flag that identifies products that have been blinded for scientific analysis |   string  |
   +----------+----------+------------------------------------------------------------------------------+-----------+


Covariance table
+++++++++++++++++

The table (first HDU, EXTNAME="RS_COVAR_CL_POSPOS2D") will contain the following columns:

.. table::
   :width: 100%

   +------------------------------------------------------------------------------------------------------+
   |                                     **Catalog**: 5 columns table                                     |
   +===========+==================================================================+==========+============+
   |  **Name** |                         **Description**                          | **Unit** | **Format** |
   +-----------+------------------------------------------------------------------+----------+------------+
   |    ELL1   | Full estimate of covariance matrix Multipole for first component |    NA    |  FITS *D*  |
   +-----------+------------------------------------------------------------------+----------+------------+
   |    ELL2   |                  Multipole for second component                  |    NA    |  FITS *D*  |
   +-----------+------------------------------------------------------------------+----------+------------+
   | BIN_COMB1 |                    First Redshift combination                    |    NA    |  FITS *J*  |
   +-----------+------------------------------------------------------------------+----------+------------+
   | BIN_COMB2 |                   Second Redshift combination                    |    NA    |  FITS *J*  |
   +-----------+------------------------------------------------------------------+----------+------------+
   |   CL_CL   |              covariance for angular power spectrum               |    NA    |  FITS *D*  |
   +-----------+------------------------------------------------------------------+----------+------------+


.. note::
    Under discussion is the possibility in the future of having as first HDU an
    estimate for Shot Noise :

    #. **ELL1**: first mean multipole [D, float64]
    #. **ELL2**: second mean multipole [D, float64]
    #. **BIN_COMB1**: first index for combination of redshift bins [J, int32]
    #. **BIN_COMB2**: second index for combination of redshift bins [J, int32]
    #. **CL_SH**: covariance of angular band power spectrum (shot noise) [D, float64]

.. DetailedDescEnd