.. include:: ../../wlsubstitutions.rst
.. _twoDMassConvergencePatchesToSphere:

Output Product: MultiPatch-Based E/B Convergence Maps for Large field
=========================================================================


Data Product Name
__________________
.. DataProductNameStart

DpdTwoDMassConvergencePatchesToSphere

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

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

* None

.. PECreatorEnd

Processing function using the data product
____________________________________________
.. PFUsingStart

Science Working Group

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in the SAS: Yes

Internal product of SGS.

.. IncludeInSASEnd

Data Product Elements
______________________
.. DataProductElementsStart

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

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This product contains 2D "wide-field" convergence maps (denoised
and/or noisy), and/or SNR map and Monte-Carlo realizations based
on multiple projected patch.

This output product contains four optional FITS structures:

* a :ref:`noisy convergence map <twoDMassConvMapElementPS>` as a FITS data array
  (one HDU per redshift bin) containing the E/B modes in HEALPix maps.
  Important input parameters are stored as keywords, in particular,
  the **DENTYPE** keyword indicates that the data has not been denoised [*NoisyConvergence* XML tag]
* a :ref:`denoised convergence map <twoDMassConvMapElementPS>` as a FITs data array
  (one HDU per redshift bin) containing the denoised E/B modes in HEALPix maps.
  Important input parameters are stored as keywords, in particular, the
  **DENTYPE** keyword indicates that the data has been denoised [*DenoisedConvergence* XML tag]
* several :ref:`Monte-Carlo maps <twoDMassConvMapElementPS>` as multiple FITS data
  arrays (one FITS per realization) containing the E/B modes in HEALPix maps
  for a realization (one HDU per redshift bin), of same format as the previous ones [*MonteCarloMap* XML tag]
* a :ref:`galaxy-count HEALPix map <twoDMassGalCountMapElementPS>` as a FITS data array
  (one HDU per redshift bin) containing the number of galaxies per pixel  [*GalCount* XML tag]
* a :ref:`patch position array <twoDMassPosArrayElementPS>` as a FITS data array
  containing the list of positions for the center of the patches used to compute
  the convergence maps   [*ProjCenterPos* XML tag]
* a "NResamples" XML field to specify the number of samples that were used to compute
  the SNR maps  [*int*]
* a :ref:`SNR map <twoDMassSNRMapElementPS>` as a FITS data array (one HDU per
  redshift bin) containing the E/B modes SNR maps   [*SNRMaps* XML tag]
* 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*].

All products have same primary array, described as follows,  characterizing the
important parameters of the product, such as the coordinate system:

#. **RADESYS**: Coordinate system (e.g. 'FK5') [string]
#. **EQUINOX**: equinox of celestial coordinate system (e.g. 2000) [string]

   Keywords specifying survey information:

#. **DATE-OBS**: start of observation with format 'yyyy-mm-ddThh:mm:ss.sss' [string]
#. **DATE-END**: end of observation with format 'yyyy-mm-ddThh:mm:ss.sss' [string]

   and basic software parameters:

#. **SHE_SOFT**: which SHE catalogue used  [StringKeyword]
#. **SOFTNAME**: software used to create the product [string]
#. **SOFTVERS**: version of software [string]
#. **PROJ**: projection used [string]
#. **PWIDTH**: Patch Width [double]
#. **PIXSIZE**: physical size of the pixels in the patch [double]
#. **OVERLAP**: fraction of patch overlap [double]
#. **NPATCHES**: number of patches used for the decomposition [int]
#. **NITREDSH**: number of iteration to compute reduced shear [int]
#. **STDREDSH**: standard deviation for Gaussian smoothing performed to compute
   the reduced shear (0 if no Gaussian smoothing) [double]
#. **FDRREDSH**: false discovery rate threshold used to compute the reduced shear [double]
#. **NITINP**: number of iteration for inpainting (0 if no inpainting) [int]
#. **NSCINP**: number of scale for inpainting (0 if no inpainting) [int]
#. **VARPERSC**: flag specifying if equal variance in/out masked area per scale [bool]
#. **FBMODE**: flag specifying if B-Mode forced to 0 in the gaps [bool]
#. **ADDBORD**: specify if border effect processing [bool]
#. **DENTYPE**: denoising type (e.g. Gaussian, None, name of third party software) [string]
#. **GAUSSSTD**: standard deviation for Gaussian smoothing
   (0 if no Gaussian smoothing) [double]
#. **FDRVAL**: false discovery rate threshold [double]
#. **NZBINS**: number of redshift bins [int]
#. **BAL_BINS**: Balanced redshift bins or not [bool]
#. **MCSEED**: Noise MC seed (None if no MC realization) [string]
#. **MCREAL**: number associated to the MC realization of the convergence map
   (None if no MC realization) [int]
#. **NRESAMPL**: number of resampling of input catalog [int]

They however differ in the information stored in the next HDUs.

.. _twoDMassConvMapElementPS:

Noisy or denoised convergence maps/Monte Carlo realizations
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

For the array in HDU (HDU= 1..N, one per redshift bin), the following keywords
are specified for each hdu, starting with required HEALPix keywords (see https://healpix.sourceforge.io/data/examples/healpix_fits_specs.pdf):

#. **PIXTYPE** ='HEALPIX' [string]
#. **ORDERING**: 'RING' or 'NESTED' [string]
#. **NSIDE**: resolution parameter [int]
#. **FIRSTPIX**: lowest index in maps [int]
#. **LASTPIX**: highest index in Maps [int]
#. **INDEXSCHM**: 'IMPLICIT' or 'EXPLICIT' [string]
#. **OBJECT**: 'FULLSKY' [string]

and redshift parameters:

#. **ZMIN**: minimum of the redshift bin [double]
#. **ZMAX**: maximum of the redshift bin [double]
#. **EXTNAME** = "KAPPA_PATCHES"

For each redshift bin (1 hdu per redshift bin), the E/B modes are stored in a 2d binary
table with two vector columns (**KAPPA_E**, **KAPPA_B**)s.

.. _twoDMassPosArrayElementPS:

Patch positions: array with center of projection
+++++++++++++++++++++++++++++++++++++++++++++++++

For the first HDU, the named is set as:

#. **ZMIN**: minimum of the redshift bin [double]
#. **ZMAX**: maximum of the redshift bin [double]
#. **EXTNAME** = "PATCHES_POSITIONS"

Two columns (**RA_CTR**, **DEC_CTR**) are reported in this extension, containing
the position of the centre of the patches used to compute the projections.

.. _twoDMassGalCountMapElementPS:

Galaxy-count maps
+++++++++++++++++

For the array in a HDU (HDU= 1..N, one per redshift bin), the following keywords
are specified, starting with required HEALPix keywords (see https://healpix.sourceforge.io/data/examples/healpix_fits_specs.pdf):

#. **PIXTYPE** ='HEALPIX' [string]
#. **ORDERING**: 'RING' or 'NESTED' [string]
#. **NSIDE**: resolution parameter [int]
#. **FIRSTPIX**: lowest index in maps [int]
#. **LASTPIX**: highest index in Maps [int]
#. **INDEXSCHM**: 'IMPLICIT' or 'EXPLICIT' [string]
#. **OBJECT**: 'FULLSKY' [string]

and redshift parameters:

#. **ZMIN**: minimum of the redshift bin [double]
#. **ZMAX**: maximum of the redshift bin [double]
#. **EXTNAME** = "GALCOUNT_PATCHES"

According to HEALPix convention, for each redshift bin, a **GALCOUNT** column will
contain the number of Galaxies measured per pixel on the sphere and redshift bin
considered, which can also be used to identify the area inpainted (pixel without
measured galaxies).

.. _twoDMassSNRMapElementPS:

SNR maps
+++++++++

For the array in HDU (HDU= 1..N, one per redshift bin), the following keywords
are specified for each hdu, starting with required HEALPix keywords (see https://healpix.sourceforge.io/data/examples/healpix_fits_specs.pdf):

#. **PIXTYPE** ='HEALPIX' [string]
#. **ORDERING**: 'RING' or 'NESTED' [string]
#. **NSIDE**: resolution parameter [int]
#. **FIRSTPIX**: lowest index in maps [int]
#. **LASTPIX**: highest index in Maps [int]
#. **INDEXSCHM**: 'IMPLICIT' or 'EXPLICIT' [string]
#. **OBJECT**: 'FULLSKY' [string]

and redshift parameters:

#. **ZMIN**: minimum of the redshift bin [double]
#. **ZMAX**: maximum of the redshift bin [double]
#. **EXTNAME** = "SNR_PATCHES"

According to HEALPix convention, for each redshift bin (1 hdu per redshift bin),
the maps are stored in a 2d binary table with two vector columns  (**SNR_E**,
**SNR_B**), associated to the E/B SNR maps.

.. DetailedDescEnd