.. include:: ../../wlsubstitutions.rst
.. _PKWLParams:

Input Parameters
==================


Data Product Name
__________________
.. DataProductNameStart

DpdPKWLParams

.. DataProductNameEnd

Data Product Custodian 
_________________________
.. DataProductCustodianStart

WLPK

.. 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/pk/inp/euc-le3-wl-pk-Params.xsd" target="_blank">euc-le3-wl-pk-Params.xsd</a>

.. NameSchemaEnd

Last edited for DPDD version
_____________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd

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

**Creators**

* None: Created by hand by Nicolas Tessore.

**Consumers**

* LE3_PK_WL_PseudoCl

.. PECreatorEnd

Processing function using the data product
____________________________________________
.. PFUsingStart

* LE3-WL-PK

.. PFUsingEnd

Data Product Elements
______________________
.. DataProductElementsStart

:Header: object of type sys:genericHeader
:Data: object of type wlpk:pKWLParams
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters: object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This product contains input parameters to calculate the tomographic angular
power spectrum estimates, noise power spectrum estimates, and the mixing
matrices.

Input Parameters
~~~~~~~~~~~~~~~~
To compute the angular power spectrum estimates and mixing matrices, an XML
product with the parameters described below is required (see schema__).

__ https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/develop/ST_DM_Schema/auxdir/ST_DM_Schema/dictionary/pro/le3/wl/pk/euc-test-le3-wl-pk.xsd

Nside : int
    The NSIDE of the HEALPix maps used when estimating the Cls

Lmin : int
    The minimum angular mode number to be estimated.

Lmax : int
    The maximum angular mode number to be estimated.

NellBin : int
    Number of angular mode bins to be computed.

LinLogSpace : int
    Linear (0) or logarithmic (1) spacing of the computed angular modes.

OutValue : int
    Compute binned values for the angular power spectrum :math:`C_l` (0) or the
    scaled values :math:`l (l+1) C_l` (1).

PosPos : boolean
    Estimate the position-position angular power spectra.

PosShear : boolean
    Estimate the position-shear angular power spectra.

ShearShear : boolean
    Estimate the shear-shear angular power spectra.

BinSelection : binSelection
    The tomographic bin selection for which angular power spectra are estimated.

    Contains one or more elements of the following types:

TomBinId : int
    A tomographic bin label provided by OU-PHZ.

RedshiftBin : redshiftBin
    A redshift bin specified by an upper and lower value.

ZMin : double
    Upper redshift bin limit (inclusive).

ZMax : double
    Lower redshift bin limit (exclusive).

NlSamp : int
    Number of random realisations for computing the noise power spectra.

NbarCut : double
    Cut on pixel completeness when calculating mean number of galaxies per
    pixel.

LmaxMm : int
    Maximum angular mode number for mixing matrix computation.

L3max : int
    Maximum mode number that is summed over in the mixing matrix computation.

Seed : int
    Random seed for the randomisation.

NThreads : int
    Number of threads to use for computation.

.. DetailedDescEnd