.. include:: ../../wlsubstitutions.rst
.. _CovarTwoPCFWLParams:

Input Product: Parameters for Covariance of Tomographic Angular Product
========================================================================

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdCovarTwoPCFWLParams                                                                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | WLCMTWOPCF                                                                                   |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-wl-cmtwopcf-ParamsCovar.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob |
|                                                | /10.1.2/ST_DM_Schema/auxdir/ST_DM_Schema/dpd/le3/wl/cmtwopcf/inp/euc-le3-wl-cmtwopcf-ParamsC |
|                                                | ovar.xsd>`_                                                                                  |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 1.1                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * Created by hand.                                                                           |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * LE3_CM_2PCF_WL_PosPosEstimator_Pipeline                                                    |
|                                                | * LE3_CM_2PCF_WL_ShearShear_Pipeline                                                         |
|                                                | * LE3_CM_2PCF_WL_PosShear_Pipeline                                                           |
|                                                | * LE3_CM_2PCF_WL_PosPos_Pipeline                                                             |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product     | LE3-CM-2PCF-WL                                                                               |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Proposed for inclusion in EAS/SAS              | This product is proposed for inclusion in the SAS: No                                        |
|                                                |                                                                                              |
|                                                | Motivation: the product gathers the necessary parameters for processing a pipeline. The      |
|                                                | products created by the processing are stored in the SAS and contain an extract of the main  |
|                                                | parameters.                                                                                  |
+------------------------------------------------+----------------------------------------------------------------------------------------------+

Data Product Elements
________________________
+--------------+----------------------------------------------+
| Header       | object of type sys:genericHeader             |
+--------------+----------------------------------------------+
| Data         | object of type wlcm2pcf:covarTwoPCFWLParams  |
+--------------+----------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder            |
+--------------+----------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters |
+--------------+----------------------------------------------+

Detailed Description of the Data Product
__________________________________________
.. DetailedDescStart
This product contains resampling parameters to compute the covariance matrices.

To compute the covariance matrices the following resampling parameters are specified:

* **ResamplingParams**: describing the spatial or catalog resampling strategy:

  * **ResamplingCatalogParams**: describing catalog resampling:

    * **NRCat1**: Number of resamples for first catalog [int64]
    * **NRCat2**: Number of resamples for second catalog [optional, int64]
    * **CatalogResample**: choice of resampling estimator [string among "None",
      "BootStrap", "Jackknife"]
    * **Seed**: seed to use for resampling estimator [optional, string]

  * **ResamplingSpatialParams**: describing spatial resampling:

    * **SpatialResample**: choice of resampling estimator [string among "None",
      "BootStrap", "Jackknife"]
    * **Seed**: seed to use for resampling estimator [optional, string]

.. DetailedDescEnd