.. include:: ../../wlsubstitutions.rst
.. _TwoPCFWLPosShear2D:

Output Product: Tomographic Galaxy-Galaxy Lensing Correlation
-------------------------------------------------------------

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

TwoPCFWLPosShear2D

.. DataProductNameEnd

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

2PCF-WL

.. DataProductCustodianEnd

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

|WLDMTAG|

.. DataModelTagEnd

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

euc-test-le3-wl-2pcf-PosShear2D.xsd

.. NameSchemaEnd

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

:emphasis:`Data product documentation:`

Data Product for twoPCFWLPosShear2DF.

:emphasis:`Documentation for data product element dpdTwoPCFWLPosShear2D:`

This product contains the tomographic galaxy - galaxy lensing 2PCF.

:emphasis:`Documentation for data product element Header:`

The generic header of the product

:emphasis:`Documentation for data product element Data:`

The data of the product


.. SchemaDocTagEnd

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

Header of type: sys:genericHeader

Data of type: wl2pcf:twoPCFWLPosShear2D

Parameters of type: ppr:genericKeyValueParameters


.. DataProductElementsEnd

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

2PCF-WL

.. PECreatorEnd

Processing function using the data product
==========================================
.. PFUsingStart

SGS pipeline output product to be used by SWGs

.. PFUsingEnd

Detailed description of the data product
========================================
.. DetailedDescStart

This output product is a fits file (see ``le3.wl.2pcf.output.shearpos2d`` in |XSD-FITS-WL|_).

Extra (optional) metadata associated to the FITS container are the following:

* **SpatialCoverage** a description of the spatial footprint [optional, cot:spatialFootprint],
* **CatalogSelection**: describing the selection in the input catalogues [optional, up to 2 elements]

  *  **CatalogFileName**: the name of the input catalogue [sys:dataFileName]
  *  **CatalogSHE**: type of input catalogue [string among "BFD", "KSB",
     "LensMC","MomentsML","REGAUSS","MER_PHZ", "OTHER" ]
  *  **Selection**: selection associated to catalogue [string]
  *  **CatalogUse**: for which use case the catalog is employed (=["PosShear"])
     [string among "PosPos", "PosShear", "ShearShear"]
  *  **CatalogInfo**:  whether position or shear information is used in this catalogue
     [string among "Pos", "Shear"]
  * **CatalogOrder**: order associated to catalogue for reporting (e.g. BIN_ID1)[int32]

The fits file contains:

- a primary array containing important computation parameters as keywords,
- binary tables in the next HDUs with galaxy-galaxy lensing 2-PCF for specific redshift bins.

Primary Array
+++++++++++++

This fits table is expected to contain the following keywords in primary HDU,
characterizing the important parameters of the product:

#. **THMIN**: minimal angular value chosen for spatial binning [DoubleKeyword]
#. **THMAX**: maximal angular value chosen for spatial binning [DoubleKeyword]
#. **OATH**: maximal open angle value used for the approximation [DoubleKeyword]
#. **THUNIT**: unit of spatial distance [StringKeyword]
#. **BINSCALE**: if linear or logarithmic scales are used for output [StringKeyword]
#. **COORDSYS**: if spherical or cartesian computation of distances [StringKeyword]
#. **SHE_SOFT**: which SHE catalogue used [StringKeyword]
#. **POS_SEL**: selection for position catalogue [StringKeyword]
#. **SHE_SEL**: selection for shear catalogue [StringKeyword]
#. **SOFTNAME**: name of software used for 2PCF [StringKeyword]
#. **SOFTVERS**: version of software used for 2PCF [StringKeyword]

Table (HDU=1...)
++++++++++++++++

The following keywords are added to the header of the HDUs:

#. **BIN_ID1**: bin for first catalog [IntegerKeyword]
#. **BIN_ID2**: bin for second catalog [IntegerKeyword]
#. **EXTNAME**: "POSSHEAR2D_2PCF"

and the columns are:

#. **THETA**: mean angular separation in the bin [D, float64]
#. **GAMMA_T**: 2PCF for tangential component of shear [D, float64]
#. **GAMMA_X**: 2PCF for cross component of shear [D, float64]
#. **WEIGHT**: total weight for the bin [D, float64]
#. **SQRT_D**:  Poisson error associated to the bin [D, float64]
#. **SQRT_DCOR**:  Poisson error associated to the bin, down-weighted by the ratio
   of number of galaxy pairs by the number of nodes  [D, float64]
#. **NPAIR**:  Number of pairs [D, float64].

.. note::
    Under discussion is the possibility in the future of having as first HDU a summary table with information
    on the binning for 2PCF tables (HDU>2):

    #. **THETA**: angular separation (center of spatial bin)  [D, float64]
    #. **MIN_THETA**:  minimal angular separation in the bin [D, float64]
    #. **MAX_THETA**:  maximal angular separation in the bin [D, float64]


    and in the second hdu a summary table to allow fast access to the HDU corresponding to a particular
    bin combination:

    #. **BIN_ID1**: bin for first catalog [J, int32]
    #. **BIN_ID2**: bin for second catalog [J, int32]
    #. **HDU**: HDU index [J, int32]

.. DetailedDescEnd