.. _PHZMeanSpecZBiasMap:

Mean Spectroscopic redshift bias map product
=============================================


Data Product Name
__________________
.. DataProductNameStart

DpdMeanSpecZBiasMap

.. DataProductNameEnd

Data Product Custodian
_______________________
.. DataProductCustodianStart



.. 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/phz/euc-phz-MeanSpecZBiasMap.xsd" target="_blank">euc-phz-MeanSpecZBiasMap.xsd</a>

.. NameSchemaEnd

Data Product Elements
______________________
.. DataProductElementsStart

:Header: object of type sys:genericHeader
:Data: object of type phz:phzMeanSpecZBiasMap
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters: object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

Schema documentation tag
_________________________
.. SchemaDocTagStart

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

This product contains the mean spectroscopic redshifts needed to compute the bias corrections.

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

The generic header of the product.

.. SchemaDocTagEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This product contains a FITS table mapping the bias corection cells with the mean spec-z of the calibration field objects. It is produced outside the Euclid pipeline and it is used to compute the shift in redshift to correct for the PHZ bias.

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

* This product is produced outside the Euclid pipeline and is manually ingested in the EAS.
* It is used to compute the shift in redshift to correct for the PHZ bias.

.. PECreatorEnd

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

* PHZ PF intermediary product.

.. PFUsingEnd

The table is expected to follow the format described by the phz.meanSpecZBiasMap version 0.9 description, which defines the following columns:

+-------------------+-----------------------------------------+--------------+
| Column name       | Description                             | Unit         |
+===================+=========================================+==============+
| OBJECT_ID         | The object identifier                   | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| SOM_CELL_ID       | The SOM cell s identifier               | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| TOM_BIN_ID        | Tomographic bin s identifier            | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| ALT_TOM_BIN_ID    | Alternate Tomographic bin s identifier  | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| NO_WEIGHT         | The  weight of the object (uniformly 1) | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| PHZ_WEIGHT        | The  PHZ weight of the object           | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| KSB_WEIGHT        | The  KSB weight of the object           | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| LENS_MC_WEIGHT    | The  LENS_MC weight of the object       | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| MOMENTS_ML_WEIGHT | The  MOMENTS_ML weight of the object    | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| REGAUSS_WEIGHT    | The  REGAUSS weight of the object       | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| GAL_SPEC_Z        | The specz of the object                 | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+
| GAL_SPEC_Z_ERR    | The error on the specz of the object    | :math:`NA`   |
+-------------------+-----------------------------------------+--------------+

This product is used along with the CoAddedPDZBiasMap in the PHZ Bias Correction pipeline to produce the PHZ bias correction map.

.. DetailedDescEnd