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

.. _TwoPCFGC1D:

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


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

DpdLE3gcTwoPointAutoCorr

.. DataProductNameEnd

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

|CUSTODIANTAG|

.. DataProductCustodianEnd

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

|GCTAG|

.. DataModelTagEnd

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

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

.. NameSchemaEnd

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

|DOCTAG|

.. SchemaDocTagEnd

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

:Header:       object of type sys:genericHeader
:Data:         object of type gc:gcTwoPointAuto
: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 auto-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 auto-correlation function.


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

**DataCatalog**
  Name of input DATA catalog
**RandCatalog**
  Name of input RANDOM catalog
**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<gc2pcfpairautofile>` file with 1D pair counts
**CorrelationFile**
  :ref:`FITS<gc2pcfcorrautofile>` file with the angle averaged auto correlation


.. _gc2pcfpairautofile:

**PairsFile** FITS file
^^^^^^^^^^^^^^^^^^^^^^^
The FITS type *le3.gc.2pcf.auto.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   |                                                |           |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D_NAME**            | Name of the data (real) catalog                | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D_ID**              | Identifier for the data (real) catalog         | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **D_NOBJ**            | Number of objects in the data (real) catalog   | integer   |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R_NAME**            | Name of the random catalog                     | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R_ID**              | Identifier for the random catalog              | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **R_NOBJ**            | Number of objects in the random catalog        | 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   |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **PAIR_DD**           | Number of DD pairs                             | double    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **PAIR_DR**           | Number of DR pairs                             | double    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **PAIR_RR**           | Number of RR pairs                             | double    |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 |                       |                                                |           |
|                 | Cosmology information |                                                |           |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **COSMO_ID**          | Identifier for the cosmology used              | string    |
+-----------------+-----------------------+------------------------------------------------+-----------+
| 4 columns table |                       |                                                |           |
+-----------------+-----------------------+------------------------------------------------+-----------+
| Columns         | **SCALE**             | Distance separation scale                      | FITS *1D* |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **DD**                | Number of weighted DD pairs                    | FITS *1D* |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **DR**                | Number of weighted DR pairs                    | FITS *1D* |
+-----------------+-----------------------+------------------------------------------------+-----------+
|                 | **RR**                | Number of weighted RR pairs                    | FITS *1D* |
+-----------------+-----------------------+------------------------------------------------+-----------+


.. _gc2pcfcorrautofile:

**CorrelationFile** FITS file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The FITS type *le3.gc.2pcf.auto.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   |                                                |           |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **D_NAME**            | Name of the data (real) catalog                | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **D_ID**              | Identifier for the data (real) catalog         | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **D_NOBJ**            | Number of objects in the data (real) catalog   | integer   |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **R_NAME**            | Name of the random catalog                     | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **R_ID**              | Identifier for the random catalog              | string    |
+-------------------+-----------------------+------------------------------------------------+-----------+
|                   | **R_NOBJ**            | Number of objects in the random catalog        | 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 auto correlation                | FITS *1D* |
+-------------------+-----------------------+------------------------------------------------+-----------+


.. DetailedDescEnd