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

.. _TwoPCFGC1Dcross:

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

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

DpdLE3gcTwoPointCrossCorr

.. DataProductNameEnd

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

|CUSTODIANTAG|

.. DataProductCustodianEnd

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

|GCTAG|

.. DataModelTagEnd

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

euc-test-le3-gc-2pcf-cross.xsd

.. NameSchemaEnd

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

|DOCTAG|

.. SchemaDocTagEnd

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

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

.. DataProductElementsEnd

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

Creator: 2PCF-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 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:

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

+-----------------+-----------------------+------------------------------------------------+-----------+
| HDU *PAIRS*     |                                                                                    |
+=================+=======================+================================================+===========+
| Keywords        | **TELESCOP**          | Mission identifier [EUCLID]                    | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **INSTRUME**          | PF producing this file [LE3GC]                 | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **FILENAME**          | Name of FITS file                              | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 |                       |                                                            |
|                 | Catalog information   |                                                            |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D1_NAME**           | Name of the data (real) catalog 1              | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D1_ID**             | Identifier for the data (real) catalog 1       | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D1_NOBJ**           | Number of objects in the data (real) catalog 1 | integer   |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R1_NAME**           | Name of the random catalog 1                   | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R1_ID**             | Identifier for the random catalog 1            | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R1_NOBJ**           | Number of objects in the random catalog 1      | integer   |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D2_NAME**           | Name of the data (real) catalog 2              | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D2_ID**             | Identifier for the data (real) catalog 2       | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D2_NOBJ**           | Number of objects in the data (real) catalog 2 | integer   |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R2_NAME**           | Name of the random catalog 2                   | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R2_ID**             | Identifier for the random catalog 2            | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R2_NOBJ**           | Number of objects in the random catalog 2      | integer   |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 |                       |                                                            |
|                 | 2PCF information      |                                                            |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **METHOD**            | Partitioning method [LINKED_LIST, KD_TREE]     | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **BIN_TYPE**          | Scale for binning [LIN, LOG]                   | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **BIN_NUM**           | Number of bins in scale                        | integer   |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **BIN_MIN**           | Min value of scale                             | double    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **BIN_MAX**           | Max value of scale                             | double    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **WEIGHT**            | Object weight use in computation [true, false] | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **SPLIT**             | Number of R subcatalogs in computation         | integer   |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **PAIRD1D2**          | Number of D1-D2 pairs                          | double    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **PAIRD1R2**          | Number of D1-R2 pairs                          | double    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **PAIRR1D2**          | Number of R1-D2 pairs                          | double    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **PAIRR1R2**          | Number of R1-R2 pairs                          | double    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 |                       |                                                            |
|                 | Cosmology information |                                                            |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **COSMO_ID**          | Identifier for the cosmology used              | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
| 5 columns table |                                                                                    |
+-----------------+-----------------------+------------------------------------------------+-----------+
| Columns         | **SCALE**             | Distance separation scale                      | FITS *1D* |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D1D2**              | Number of weighted D1-D2 pairs                 | FITS *1D* |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D1R2**              | Number of weighted D1-R2 pairs                 | FITS *1D* |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R1D2**              | Number of weighted R1-D2 pairs                 | FITS *1D* |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R1R2**              | Number of weighted R1-R2 pairs                 | 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:

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

+-------------------+-----------------------+------------------------------------------------+-----------+
| HDU *CORRELATION* |                                                                                    |
+===================+=======================+================================================+===========+
| Keywords          | **TELESCOP**          | Mission identifier [EUCLID]                    | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **INSTRUME**          | PF producing this file [LE3GC]                 | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **FILENAME**          | Name of FITS file                              | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   |                       |                                                            |
|                   | Catalog information   |                                                            |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **D1_NAME**           | Name of the data (real) catalog 1              | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **D1_ID**             | Identifier for the data (real) catalog 1       | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **D1_NOBJ**           | Number of objects in the data (real) catalog 1 | integer   |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **R1_NAME**           | Name of the random catalog 1                   | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **R1_ID**             | Identifier for the random catalog 1            | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **R1_NOBJ**           | Number of objects in the random catalog 1      | integer   |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **D2_NAME**           | Name of the data (real) catalog 2              | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **D2_ID**             | Identifier for the data (real) catalog 2       | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **D2_NOBJ**           | Number of objects in the data (real) catalog 2 | integer   |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **R2_NAME**           | Name of the random catalog 2                   | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **R2_ID**             | Identifier for the random catalog 2            | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **R2_NOBJ**           | Number of objects in the random catalog 2      | integer   |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   |                       |                                                            |
|                   | 2PCF information      |                                                            |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **METHOD**            | Partitioning method [LINKED_LIST, KD_TREE]     | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **BIN_TYPE**          | Scale for binning [LIN, LOG]                   | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **BIN_NUM**           | Number of bins in scale                        | integer   |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **BIN_MIN**           | Min value of scale                             | double    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **BIN_MAX**           | Max value of scale                             | double    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **WEIGHT**            | Object weight use in computation [true, false] | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **SPLIT**             | Number of R subcatalogs in computation         | integer   |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   |                       |                                                            |
|                   | Cosmology information |                                                            |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **COSMO_ID**          | Identifier for the cosmology used              | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
| 2 columns table   |                                                                                    |
+-------------------+-----------------------+------------------------------------------------+-----------+
| Columns           | **SCALE**             | Distance separation scale                      | FITS *1D* |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **XI**                | Angle averaged cross correlation               | FITS *1D* |
+-------------------+-----------------------+------------------------------------------------+-----------+



.. DetailedDescEnd