.. include:: ../../wlsubstitutions.rst
.. _TwoPCFWLParamsPosShear2D:

Input Product: Parameters for Tomographic Galaxy-Galaxy Lensing 2PCF
--------------------------------------------------------------------

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

TwoPCFWLParamsPosShear2D

.. DataProductNameEnd

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

2PCF-WL

.. DataProductCustodianEnd

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

|WLDMTAG|

.. DataModelTagEnd

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

euc-test-le3-wl-twopcf-ParamsPosShear2D.xsd

.. NameSchemaEnd

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

:emphasis:`Data product documentation:`

Data Product for twoPCFWLParamsPosShear2D.

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

Input parameters to compute 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:twoPCFWLParams

Parameters of type: ppr:genericKeyValueParameters


.. DataProductElementsEnd

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

SHE, PHZ,  2PCF-WL

.. PECreatorEnd

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

LE3

.. PFUsingEnd

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

To compute the tomographic galaxy-galaxy lensing 2-PCF :ref:`TwoPCFWLPosShear2D <TwoPCFWLPosShear2D>`,  the following set of parameters is needed:

* **IOCoordUnit**: units of the input/output data:

  * **SCoordInput**: coordinate unit for input catalogues [string among
    "arcsec", "arcmin", "deg", "rad"]
  * **SCoordOutput**: coordinate unit for output 2PCF [string among
    "arcsec", "arcmin", "deg", "rad"]

* **Coordinates**: System of coordinates for 2PCF distance computation [string
  among "SPHERICAL", "CARTESIAN"]

* **MergMultiples**: Merging of objects (multiple at same position) [bool]

* **RedshiftBinList**: defining the redshift binning for tomography

  * **Nbins**: Number of redshift bins to consider [long]
  * **RedshiftBin**: list (max 100 elements) of redshift bin, or if single, minimal
    and maximal redshift range to be splitted [list]

    * **Zmin**: min redshift in the bin [double]
    * **Zmax**: max redshift in the bin [double]

* **BinningParams**: defining the spatial binning:

  * **Thmin**: min angular separation (units specified by *SCoordOutput*) [double]
  * **Thmax**: max angular separation (units specified by *SCoordOutput*) [double]
  * **Nbins**: number of angular bins [double]
  * **BinType**: whether logarithmic or linear angular binning [string among "Lin", "Log"]

* **OpenAngle**: open angle threshold [double]

* **WeightScales**: Flag to compute the weighted center of the bin [bool]

* **SplitParams**: spatial splitting strategy:

  * **NRa**: Number of splitting in right ascension [long]
  * **NDec**: Number of splitting in declination [long]
  * **SplitAlgo**: algorithm/strategy used for splitting [string]


* **RebinParams**: redefining the number of angular bins

  * **TwoPcfTRebin**: multiple of the number of bins (NTH) for rebinning the angular bin of the output cosmic shear correlation product
  * **SpectraRebin**: multiple of the number of bins (NTH)  for rebinning the angular bin before the extraction of the band power spectrum

This is described in |XSD-2PCF-WL|_.

.. DetailedDescEnd