.. include:: ../../wlsubstitutions.rst
.. _twoDMassConvergencePatch:

Output Product: E/B Convergence Maps for Small Field
========================================================

$SetSchemaPath le3/wl/twodmass/out/euc-le3-wl-twodmass-ConvergencePatch.xsd

Data Product Name
__________________
.. DataProductNameStart

$PrintDataProductName

.. DataProductNameEnd

Data Product Custodian
________________________
.. DataProductCustodianStart

$PrintDataProductCustodian

.. DataProductCustodianEnd

Name of the Schema File
________________________
.. NameSchemaStart

$PrintSchemaFilename

.. NameSchemaEnd

Last edited for DPDD version
_______________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd

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

**Creators:**

* LE3_2D_MASS_WL_KS

**Consumers:**

* LE3_2D_MASS_WL_KS

.. PECreatorEnd

Processing function using the data product
____________________________________________
.. PFUsingStart

* LE3_2D_MASS_WL_KS
* Science Working Group

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in the SAS: Yes

This product is an internal product of SGS.

.. IncludeInSASEnd

Data Product Elements
______________________
.. DataProductElementsStart

$PrintDataProductElements

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This product contains 2D convergence maps (denoised and/or noisy), and/or SNR map for a patch.

This output product contains three optional FITS structures:

* a :ref:`noisy convergence map <twoDMassConvMapElementSF>` as a FITS data array (one redshift bin per HDU)
  containing the E/B modes for a patch and all redshift bins, the number of galaxies per pixel and with
  important input parameters as keywords. In particular, the **DENTYPE** keyword indicates that the data
  has not been denoised [*NoisyConvergence* xml tag]
* a :ref:`denoised convergence map <twoDMassConvMapElementSF>` as a FITS data array (one redshift bin per HDU)
  containing the denoised E/B modes for a patch and all redshift bins, the number of galaxies per pixel and
  with important input parameters as keywords. In particular, the **DENTYPE** keyword indicates that the
  data has been denoised  [*DenoisedConvergence* xml tag]
* a :ref:`SNR map <twoDMassSNRMapElementSF>` as a FITS data array (one redshift bin per HDU) containing
  the E/B modes SNR maps for a patch and all redshift bins, the number of galaxies per pixel and with
  important input parameters as keywords  [*SNRPatch* xml tag]
* a "NResamples" field to specify the number of samples that were used to compute the SNR maps [*int*]
* a "McSeed" field to specify the seed of the random number generator [*int*]
* an associated spatial footprint (see `spatialFootprint here <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/tree/develop/dictionary/bas/cot/euc-test-cot.xsd>`_) [*cot:spatialFootprint*].

.. _twoDMassConvMapElementSF:

Noisy or denoised convergence maps
++++++++++++++++++++++++++++++++++

**Primary HDU**:

$PrintPrimaryHeader fit/euc-le3-wl.xml le3.wl.2dmass.output.patchconvergence

**Extensions**:

For the array in HDU (HDU= 1..N, one per redshift bin), the following keywords are specified for
each HDU (**EXTNAME** = "KAPPA_ZBIN_i"):

*Header*:

$PrintArrayHDUContents fit/euc-le3-wl.xml le3.wl.2dmass.output.patchconvergence KAPPA_ZBIN_i

The image contains a 3 dimensional image containing 2D maps for E and B modes
(noisy or denoised according to **DENTYPE** parameters)  and an image with the number of galaxies per
pixel in the redshift bin (can serve to derive a noise level or to identify zones with no galaxy
measured where inpainting has been performed).

.. _twoDMassSNRMapElementSF:

SNR maps
++++++++

**Primary HDU**:

$PrintPrimaryHeader fit/euc-le3-wl.xml le3.wl.2dmass.output.patchsnr

**Extensions**:

For the array in HDU (HDU= 1..N, one per redshift bin), the following keywords are specified for
each HDU (**EXTNAME** = "SNR_ZBIN_n"):

*Header*:

$PrintArrayHDUContents fit/euc-le3-wl.xml le3.wl.2dmass.output.patchsnr SNR_ZBIN_i

The image contains a 3 dimensional image containing the 2D SNR images for E and B convergence,
and an image with the number of galaxies per pixel.

.. DetailedDescEnd