.. include:: ../../wlsubstitutions.rst
.. _twoDMassParams2DConvergencePatch:

Input Product: Patch-Based E/B Convergence Maps Parameters
================================================================


Data Product Name
__________________
.. DataProductNameStart

DpdTwoDMassParamsConvergencePatch

.. DataProductNameEnd

Data Product Custodian
________________________
.. DataProductCustodianStart

WLTWODMASS

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

.. NameSchemaEnd

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

**Creators:**

* None: It is a parameter file to store inputs.

**Consumers:**

* LE3_2D_MASS_WL_KS

.. PECreatorEnd

Processing function using the data product
____________________________________________
.. PFUsingStart

LE3_2D_MASS_WL_KS

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in the SAS: No.

.. IncludeInSASEnd

Data Product Elements
______________________
.. DataProductElementsStart

:Header: object of type sys:genericHeader
:Data: object of type wl2dmass:twoDMassParamsConvergencePatch
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters: object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This product contains inputs to compute the 2D convergence maps for one or several patches.

To compute the E/B convergence maps using projection on a single patch/multiple patches,
the following set of parameters is needed:

* how to handle reduced shear:

  * **NItReducedShear**: the number of iterations used to compute the reduced shear [int]
  * denoising parameters for **reduced shear**:

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

  * **Project**: what type of projection [stc:projection]
  * **NPatches**: the number of patches in the list [int]
  * and a **PatchList** list containing as elements:

    * **ProjCtr**: position of the centres of the patches considered [stc:sphericalCoordinate]
    * **PatchWidth**: size of the patches [double]
    * **PixelSize**: physical size of the pixel [double]

* 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]
  * **AddBorder**:  if an extra border is taken into account [bool]

.. DetailedDescEnd