.. include:: ../../wlsubstitutions.rst
.. _twoDMassParams2DConvergenceSphere:

Input Product: Spherical E/B Convergence Maps Parameters
--------------------------------------------------------

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

twoDMassParams2DConvergenceSphere

.. DataProductNameEnd

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

2D-MASS-WL

.. DataProductCustodianEnd

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

|2BF|

.. DataModelTagEnd

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

euc-test-le3-wl-twodmass-ParamsConvergenceSphere.xsd

.. NameSchemaEnd

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

:emphasis:`Data product documentation:`

Data Product for twoDMassParams2DConvergenceSphere.

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

This product contains inputs to compute the 2D convergence maps on the sphere.

: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: wl2dmass:twoDMassParamsConvergenceSphere

QualityFlags of type: dqc:sqfPlaceHolder

Parameters of type: ppr:genericKeyValueParameters

.. DataProductElementsEnd

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

2D-MASS-WL

.. PECreatorEnd

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

2D-MASS-WL

.. PFUsingEnd

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

Running Parameters
++++++++++++++++++

To compute the spherical E/B convergence maps, the following set of parameters is needed:

* how to handle reduced shear:

    * **NItReducedShear**: the number of iterations used to compute the reduced shear [int]
    * **RSThreshold**:  Threshold to perform hard-thresholding in the reduced shear iteration
    * **GaussSTD**:  the standard deviation for the Gaussian filter [double]
    * **ThresholdFDR**: the False Discovery Rate (FDR) threshold if applied [optional, double]

* denoising parameters for **final map**: if Gaussian smoothing is performed, the value of the

    * **DenoisingAlgo**:  Name of denoising algo [string]
    * **GaussSTD**:  the standard deviation for the Gaussian filter [double]
    * **ThresholdFDR**: the False Discovery Rate (FDR) threshold if applied [optional, double]

* **NResamples**: the number of resampling that needs to be performed for Noise/SNR maps [int]

* how to handle the pixelization:

    * **Nside**: HEALPix nside of the final map [int]

* how to handle redshift:

    * **ZMin**: min redshifts for the patches considered [double]
    * **ZMax**: max redshifts for the patches considered [double]
    * **Nbins**: the number of redshift bins [int]
    * **BalancedBins**:  if bins are balanced or not (in terms of number of galaxies) [bool]

* how to handle gaps in data:

    * **NInpaint**: number of inpainting iterations [int]
    * **EqualVarPerScale**: , if a constraint is applied to  have equal variance in/out of the masked area per wavelet scale [bool]
    * **ForceBMode**: Flag to force B Modes to 0 in the gaps [bool]
    * **NInpScale**: number of wavelet scales for inpainting [int]

.. DetailedDescEnd