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

.. _TwoPCFGC1Dcross:

Output - 1D [Angle-averaged Cross-correlation Product]
========================================================

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdLE3gcTwoPointCrossCorr                                                                    |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | GC2PCF                                                                                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-gc-2pcf-cross.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-2pcf-cross.xsd>`_                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 1.1                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * LE3_GC_2PCF                                                                                |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * LE_GC_CM2PCF                                                                               |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product     | * LE3_GC_TwoPointCovariance                                                                  |
|                                                | * 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:gcTwoPointCross            |
+--------------+----------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder            |
+--------------+----------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters |
+--------------+----------------------------------------------+


Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This output product is the angle-averaged two-point cross-correlation
function at different separation scales.  The product contains 2 FITS
files: one for the 1D pair counts and one for the angle-averaged
two-point cross-correlation function.

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

**DataCatalog1**
  Name of input DATA catalog 1
**RandCatalog1**
  Name of input RANDOM catalog 1
**DataCatalog2**
  Name of input DATA catalog 2
**RandCatalog2**
  Name of input RANDOM catalog 2
**CountingMethod**
  Counting method [LINKED_LIST, KD_TREE]
**BinType**
  Binning scale type [LIN, LOG]
**BinNumber**
  Number of bins in scale
**BinMinValue**
  Minimum separation scale Mpc/h
**BinMaxValue**
  Maximum separation scale Mpc/h
**UseWeight**
  Use object weight in the computation [true/false]
**SplitFactor**
  Number of random sub-catalogs used for RR computation
**CosmologyID**
  Identifier for the cosmology used
**ReleaseName**
  Name of the release
**PairsFile**
  :ref:`FITS<gc2pcfpaircrossfile>` file with 1D pair counts
**CorrelationFile**
  :ref:`FITS<gc2pcfcorrcrossfile>` file with the angle averaged cross correlation


.. _gc2pcfpaircrossfile:

**PairsFile** FITS file
^^^^^^^^^^^^^^^^^^^^^^^
The FITS type *le3.gc.2pcf.cross.pair.1D* contains one binary table HDU named **PAIRS** with the following structure:

.. table::
   :width: 100%

   +----------------------------------------------------------------------------------------------------------------------+
   |                                               **HDU** *PAIRS*: 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     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  TTYPE4  |                                                                              |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  TFORM4  |                                                                              |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  TUNIT4  |                                                                              |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  TTYPE5  |                                                                              |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  TFORM5  |                                                                              |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  TUNIT5  |                                                                              |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | TELESCOP |                              Mission identifier                              | string = EUCLID |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | INSTRUME |                                PF identifier                                 |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | FILENAME |                              Name of fits file                               |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | D1_NAME  |               Catalog Related Keywords Name of DATA catalog 1                |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  D1_ID   |                         Identifier of DATA catalog 1                         |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | D1_NOBJ  |                       Object Number of DATA catalog 1                        |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | R1_NAME  |                           Name of RANDom catalog 1                           |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  R1_ID   |                        Identifier of RANDom catalog 1                        |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | R1_NOBJ  |                      Object Number of RANDom catalog 1                       |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | D2_NAME  |                            Name of DATA catalog 2                            |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  D2_ID   |                         Identifier of DATA catalog 2                         |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | D2_NOBJ  |                       Object Number of DATA catalog 2                        |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | R2_NAME  |                           Name of RANDom catalog 2                           |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  R2_ID   |                        Identifier of RANDom catalog 2                        |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | R2_NOBJ  |                      Object Number of RANDom catalog 2                       |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | RUNTYPE  |                        Type of clustering measurement                        |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | SELECT1  |                  Identifier for the SEL selection performed                  |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | SELECT2  |                  Identifier for the SEL selection performed                  |      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  |      2PCF Related Keywords Pair counting method : KD_TREE, LINKED_LIST       |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN_TYPE |                Scale for used in binning :LINear, LOGarithmic                |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN_NUM  |                           Number of bins in scale                            |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN_MIN  |                          Min value of bin in scale                           |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN_MAX  |                          Max value of bin in scale                           |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  WEIGHT  |              Use object weight in the computation : true, false              |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  SPLIT   |         Split factor - number of R subcatalogs - used in computation         |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | PAIRD1D2 |                                                                              |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | PAIRD1R2 |                                                                              |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | PAIRR1D2 |                                                                              |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | PAIRR1R2 |                                                                              |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | COSMO_ID |         Cosmology Related Keywords Identifier for the cosmology used         |      string     |
   +----------+----------+------------------------------------------------------------------------------+-----------------+

.. table::
   :width: 100%

   +----------------------------------------------------------------------------------------------------------------------+
   |                                           **HDU** *PAIRS*: 5 columns table                                           |
   +============+=============+=========================================================+=============+===================+
   |            |   **Name**  |                     **Description**                     |   **Unit**  |     **Format**    |
   +------------+-------------+---------------------------------------------------------+-------------+-------------------+
   |  Columns   |    SCALE    |                      Binning Scale                      |      NA     |     FITS *1D*     |
   +            +-------------+---------------------------------------------------------+-------------+-------------------+
   |            |     D1D2    |          D1D2 Cross pairs counted per scale bin         |      NA     |     FITS *1D*     |
   +            +-------------+---------------------------------------------------------+-------------+-------------------+
   |            |     D1R2    |          D1R2 Cross pairs counted per scale bin         |      NA     |     FITS *1D*     |
   +            +-------------+---------------------------------------------------------+-------------+-------------------+
   |            |     R1D2    |          R1D2 Cross pairs counted per scale bin         |      NA     |     FITS *1D*     |
   +            +-------------+---------------------------------------------------------+-------------+-------------------+
   |            |     R1R2    |          R1R2 Cross pairs counted per scale bin         |      NA     |     FITS *1D*     |
   +------------+-------------+---------------------------------------------------------+-------------+-------------------+


.. _gc2pcfcorrcrossfile:

**CorrelationFile** FITS file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The FITS type *le3.gc.2pcf.cross.corr.1D* contains one binary table HDU named **CORRELATION** with the following structure:

.. table::
   :width: 100%

   +----------------------------------------------------------------------------------------------------------------------+
   |                                            **HDU** *CORRELATION*: 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     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | TELESCOP |                              Mission identifier                              | string = EUCLID |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | INSTRUME |                                PF identifier                                 |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | FILENAME |                              Name of fits file                               |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | D1_NAME  |               Catalog Related Keywords Name of DATA catalog 1                |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  D1_ID   |                         Identifier of DATA catalog 1                         |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | D1_NOBJ  |                       Object Number of DATA catalog 1                        |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | R1_NAME  |                           Name of RANDom catalog 1                           |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  R1_ID   |                        Identifier of RANDom catalog 1                        |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | R1_NOBJ  |                      Object Number of RANDom catalog 1                       |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | D2_NAME  |                            Name of DATA catalog 2                            |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  D2_ID   |                         Identifier of DATA catalog 2                         |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | D2_NOBJ  |                       Object Number of DATA catalog 2                        |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | R2_NAME  |                           Name of RANDom catalog 2                           |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  R2_ID   |                        Identifier of RANDom catalog 2                        |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | R2_NOBJ  |                      Object Number of RANDom catalog 2                       |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | RUNTYPE  |                        Type of clustering measurement                        |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | SELECT1  |                  Identifier for the SEL selection performed                  |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | SELECT2  |                  Identifier for the SEL selection performed                  |      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  |      2PCF Related Keywords  Pair counting method :KD_TREE, LINKED_LIST       |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN_TYPE |                Scale for used in binning :LINear, LOGarithmic                |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN_NUM  |                           Number of bins in scale                            |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN_MIN  |                          Min value of bin in scale                           |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | BIN_MAX  |                          Max value of bin in scale                           |      double     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  WEIGHT  |              Use object weight in the computation : true, false              |      string     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          |  SPLIT   |         Split factor - number of R subcatalogs - used in computation         |     integer     |
   +          +----------+------------------------------------------------------------------------------+-----------------+
   |          | COSMO_ID |         Cosmology Related Keywords Identifier for the cosmology used         |      string     |
   +----------+----------+------------------------------------------------------------------------------+-----------------+

.. table::
   :width: 100%

   +----------------------------------------------------------------------------------------------------------------------+
   |                                        **HDU** *CORRELATION*: 2 columns table                                        |
   +=============+===============+====================================================+===============+===================+
   |             |    **Name**   |                  **Description**                   |    **Unit**   |     **Format**    |
   +-------------+---------------+----------------------------------------------------+---------------+-------------------+
   |   Columns   |     SCALE     |                     Bin scale                      |       NA      |     FITS *1D*     |
   +             +---------------+----------------------------------------------------+---------------+-------------------+
   |             |       XI      |          Cross correlation value per bin           |       NA      |     FITS *1D*     |
   +-------------+---------------+----------------------------------------------------+---------------+-------------------+


.. DetailedDescEnd