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

.. _TwoPCFGC2Dpolcross:

Output - 2D Polar [2D Polar and Multipole Cross-correlation Product]
======================================================================

$SetSchemaPath le3/gc/euc-le3-gc-2pcf-cross-pol.xsd

Data Product Name
__________________
.. DataProductNameStart

$PrintDataProductName

.. DataProductNameEnd

Data Product Custodian
________________________
.. DataProductCustodianStart

$PrintDataProductCustodian

.. DataProductCustodianEnd

Name of the Schema File
________________________
.. NameSchemaStart

$PrintSchemaFilename

.. NameSchemaEnd

Last Edited for DPDD Version
____________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd

Processing Elements Creating / Updating / Using the Product
___________________________________________________________
.. PECreatorStart

**Creators:**

* LE3_GC_2PCF

**Consumers:**

* LE_GC_CM2PCF

.. PECreatorEnd

Processing function using the data product
___________________________________________
.. PFUsingStart

* LE3_GC_TwoPointCovariance
* This is a SGS pipeline final output product to be used by SWGs.

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in the SAS: Yes

Is going to be used by the SWG-GC for their scientific analysis.

.. IncludeInSASEnd

Data Product Elements
______________________
.. DataProductElementsStart

$PrintDataProductElements

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This output product is the 2D Polar and Multipole of the two-point
cross-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 cross-correlation function and one for the
multipole moments of the 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]
**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 cross counts
**CorrelationFile**
  :ref:`FITS<gc2pcfcorrautofile2Dpol>` file with the 2D polar cross correlation
**CorrelationFileMultipole**
  :ref:`FITS<gc2pcfcorrautofileMulti>` file with the Multipole 0, 1, 2, 3, 4 cross correlation


.. _gc2pcfpaircrossfile2Dpol:

.. include:: 2pcfgc_OUTPUT_2D_cart_cross.rst
  :start-after: _gc2pcfpaircrossfile2D
  :end-before: _gc2pcfcorrcrossfile2D




.. _gc2pcfcorrcrossfile2Dpol:

.. include:: 2pcfgc_OUTPUT_2D_cart_cross.rst
  :start-after: _gc2pcfcorrcrossfile2D:
  :end-before: _gc2pcfcorrcrossfileProj



.. _gc2pcfcorrcrossfileMulti:

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

$PrintHDUTableContents fit/euc-le3-gc.xml le3.gc.2pcf.cross.corr.mul CORRELATION

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