.. include:: ../../wlsubstitutions.rst
.. _TwoPCFWLParamsPosPos2D:

Input Product: Parameters for Tomographic Angular 2PCF
========================================================


Data Product Name
__________________
.. DataProductNameStart

DpdTwoPCFWLParamsPosPos2D

.. DataProductNameEnd

Data Product Custodian
_______________________
.. DataProductCustodianStart

WLTWOPCF

.. DataProductCustodianEnd

Name of the Schema File
________________________
.. NameSchemaStart

.. raw:: html 

    <a href="https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/9.2.0/ST_DM_Schema/auxdir/ST_DM_Schema/dpd/le3/wl/twopcf/inp/euc-le3-wl-twopcf-ParamsPosPos2D.xsd" target="_blank">euc-le3-wl-twopcf-ParamsPosPos2D.xsd</a>

.. NameSchemaEnd

Last Edited for DPDD Version
____________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd

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

**Creators:**

* Created by hand

**Consumers:**

* LE3_2PCF_WL_PosPosEstimator_Pipeline
* LE3_2PCF_WL_PosPos_Pipeline
* LE3_CM_2PCF_WL_PosPosEstimator_Pipeline
* LE3_CM_2PCF_WL_PosPos_Pipeline

.. PECreatorEnd

Processing Function using the products
________________________________________
.. PFUsingStart

* LE3-2PCF-WL
* LE3-CM-2PCF-WL

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in the SAS: No

Motivation: the product gathers the necessary parameters for processing a pipeline. The  products created by the processing are stored in the SAS and contain an extract of the main parameters.

.. IncludeInSASEnd

Data Product Elements
______________________
.. DataProductElementsStart

:Header: object of type sys:genericHeader
:Data: object of type wl2pcf:twoPCFWLParamsPosPos2D
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters: object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

Input parameters to compute tomographic angular 2PCF.

To compute the tomographic angular 2-PCF :ref:`TwoPCFWLPosPos2D <TwoPCFWLPosPos2D>`,
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

  * **TwoPcfRebin**: 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

* **EstimatorWTheta**: estimator ("Landy-Szalay", "Hamilton") or correlation
  (Data-Data, Data-Random, Random-Random) to report
  [string among "DD", "DR", "RR", "Landy-Szalay","Hamilton"].

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

.. DetailedDescEnd