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

.. _TwoPCFGC2Dpol:

Output - 2D Polar [2D Polar and Multipole Auto-correlation Product]
-------------------------------------------------------------------


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

DpdLE3gcTwoPointAutoCorrPol

.. 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-pol.xsd

.. NameSchemaEnd

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

|DOCTAG|

.. SchemaDocTagEnd

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

:Header:       object of type sys:genericHeader
:Data:         object of type gc:gcTwoPointAutoPol
: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 2D Polar and Multipoles of the two-point
auto-correlation function at different separation scales.  The product
contains 3 FITS files: one for the 2D pair counts, one for the 2D
polar two-point auto-correlation function and one for the multipole
moments of the 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]
**BinTypeDim1**
  Binning scale type in dim 1 [LIN, LOG]
**BinNumberDim1**
  Number of bins in scale in dim 1
**BinMinValueDim1**
  Minimum separation scale in dim 1 Mpc/h
**BinMaxValueDim1**
  Maximum separation scale in dim 1 Mpc/h
**BinTypeDim2**
  Binning scale type in dim 2 [LIN, LOG]
**BinNumberDim2**
  Number of bins in scale in dim 2
**BinMinValueDim2**
  Minimum separation scale in dim 2 Mpc/h
**BinMaxValueDim2**
  Maximum separation scale in dim 2 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<gc2pcfpairautofile2Dpol>` file with 2D pair counts
**CorrelationFile**
  :ref:`FITS<gc2pcfcorrautofile2Dpol>` file with the 2D polar auto correlation
**CorrelationFileMultipole**
  :ref:`FITS<gc2pcfcorrautofileMulti>` file with the Multipole 0, 1, 2, 3, 4 auto correlation


.. _gc2pcfpairautofile2Dpol:

.. include:: 2pcfgc_OUTPUT_2D_cart.rst
  :start-after: _gc2pcfpairautofile2D
  :end-before: _gc2pcfcorrautofile2D




.. _gc2pcfcorrautofile2Dpol:

.. include:: 2pcfgc_OUTPUT_2D_cart.rst
  :start-after: _gc2pcfcorrautofile2D:
  :end-before: _gc2pcfcorrautofileProj



.. _gc2pcfcorrautofileMulti:

**CorrelationFileMultipole** FITS file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The FITS type *le3.gc.2pcf.auto.corr.mul* 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  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1TYPE**   | Scale for binning dim 1 [LIN, LOG]                | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1NUM**    | Number of bins in scale dim 1                     | integer |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1MIN**    | Min value of scale dim 1                          | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN1MAX**    | Max value of scale dim 1                          | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2TYPE**   | Scale for binning dim 2 [LIN, LOG]                | string  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2NUM**    | Number of bins in scale dim 2                     | integer |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2MIN**    | Min value of scale  dim 2                         | double  |
+          +----------------+---------------------------------------------------+---------+
|          | **BIN2MAX**    | Max value of scale dim 2                          | 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  |
+----------+----------------+---------------------------------------------------+---------+
| 6 columns table                                                                         |
+----------+----------------+---------------------------------------------------+---------+
| Columns  | **SCALE**      | Distance separation dim 1 scale                   |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **XI0**        | Multipole 0 auto correlation                      |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **XI1**        | Multipole 1 auto correlation                      |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **XI2**        | Multipole 2 auto correlation                      |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **XI3**        | Multipole 3 auto correlation                      |FITS *1D*|
+          +----------------+---------------------------------------------------+---------+
|          | **XI4**        | Multipole 4 auto correlation                      |FITS *1D*|
+----------+----------------+---------------------------------------------------+---------+


.. note::
  In the 2D Polar product, the separation bins in the first dimension are the 
  comoving separations while the separation bins in the second dimension are 
  the angular separations.

.. DetailedDescEnd