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

.. _CMPKGC1D:

Output - Covariance Matrix of the Power Spectrum 0, 1, 2, 3, 4 multipoles Product
===================================================================================

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdLE3gcCovmatPKCov1D                                                                        |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | GCCMPKCOV                                                                                    |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-gc-cmpk-cov-1D.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/10.1.2/S |
|                                                | T_DM_Schema/auxdir/ST_DM_Schema/dpd/le3/gc/euc-le3-gc-cmpk-cov-1D.xsd>`_                     |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 1.1                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * LE3_GC_CMPK                                                                                |
|                                                |                                                                                              |
|                                                | **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:covmatPkCov1D              |
+--------------+----------------------------------------------+
| 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 power spectrum calculated over the input data catalog.
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 PK multipoles.


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

**Statistics**
  Statistics used to evaluate PK
**Nft**
  Number of grid Points
**MASscheme**
  Mass Assignment Schema used for density fields
**UseFKPweight**
  FKP weighting was enabled/disabled
**UseInterlacing**
  Interlacing field usage enabled/disabled
**BinType**
  Binning scale: LIN/LOG
**BinNumDat**
  Number of bins
**KminDat**
  Minimum K value of input products
**KmaxDat**
  Maximum K value of input products
**DeltaKDat**
  Bin size
**KminWin**
  Minimum K value of input products
**KmaxWin**
  Maximum K value of input products
**BinNumWin**
  Number of bins
**DeltaKWin**
  Bin size
**ReconstructionID**
  Identirfier for the reconstruction used
**CosmologyID**
  Identificator 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
**OnlyEven**
  Multipoles used in the analysis. If enabled multipole 1 and 3 are discarded
**CovarianceFile**
  :ref:`FITS<gccmpkfile1D>` file with the Multipoles 0, 1, 2, 3, 4 covariance


.. _gccmpkfile1D:

**CovarianceFile** FITS file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The FITS type *le3.gc.cmpk.cov.1D* contains two binary table HDUs named **AVERAGE**
**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 Number of PK products used              |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | INPCROSS |                          ID of reconstruction used                           |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | ONLYEVEN |          Multipoles used in computation, if enabled discard 1 and 3          |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | RUNTYPE  |                        Type of clustering measurement                        |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BLINDING | Flag that identifies products that have been blinded for scientific analysis |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |   STAT   |              PK Related Keywords Statistics of PK (e.g. DOAFFT)              |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |   NFT    |                               grid side points                               |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |   MAS    |                            Mass Assignment Schema                            |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | MAS_CORR |                            MAS correction enabled                            |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | INTERLAC |                          INterlacing field enabled                           |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | SN_CORR  |                           Noise Correction enabled                           |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  SCALE   |                       Scale for binning (e.g. LINEAR)                        |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  N_BIN   |                           Number of bins in scale                            |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  K_MIN   |                              Min value of scale                              |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  K_MAX   |                              Max value of scale                              |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | DELTA_K  |                                  Scale step                                  |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | 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    |        K         |                Bin 1d k scale               |       NA       |      FITS *1D*      |
   +              +------------------+---------------------------------------------+----------------+---------------------+
   |              |    MULTIPOLE     |                  multipole                  |       NA       |      FITS *1K*      |
   +              +------------------+---------------------------------------------+----------------+---------------------+
   |              |     AVERAGE      |           spectrum averaged values          |       NA       |      FITS *1D*      |
   +--------------+------------------+---------------------------------------------+----------------+---------------------+