.. include:: ../../clsubstitutions.txt
.. _richclRichness:

Cluster Richness Output Product
-------------------------------

Data product name
=================
.. DataProductNameStart

richclRichness

.. DataProductNameEnd

Data product custodian
======================
.. DataProductCustodianStart

RICH-CL

.. DataProductCustodianEnd

Data model tag
==============
.. DataModelTagStart

DpdLE3clRichness

.. DataModelTagEnd

Name of the Schema file
=======================
.. NameSchemaStart

euc-test-le3-cl-richcl-rich.xsd

.. NameSchemaEnd

Schema documentation tag
========================
.. SchemaDocTagStart

This output product contains the richness estimates of the candidate clusters

.. SchemaDocTagEnd

Data product elements
=====================
.. DataProductElementsStart

:Header:       type sys:genericHeader
:Data:         type cl:clustersRichness
:Data:         type cl:clustersRichMembers
:QualityFlags: type dqc:sqfPlaceHolder
:Parameters:   type ppr:genericKeyValueParameters

.. DataProductElementsEnd

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

RICH-CL

.. PECreatorEnd

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

SGS pipeline output product to be used by SWGs

.. PFUsingEnd

Detailed description of the data product
========================================
.. DetailedDescStart

This data product contains the list of richness estimates, by both method "Pmem" and "Red Sequence",  for each detected cluster.

Keywords
+++++++++++++

This fits file is expected to contain the following keywords in the primary HDU,
characterizing the important parameters of the product:

#. **DET_CODE**: Name of the clusters detection algorithm (AMICO or PZWAV)
#. **MODEL_ID**: Identifier of the cluster model used in the filtering procedure
#. **SNR_THR**: S/N threshold for extracting a detection
#. **MAX_NB**: Maximum number of structures to which a galaxy can be associated
#. **MIN_PROB**: Minimum probability for the association to be saved in this catalog
#. **MIN_RA**: Minimum RA of the area on which the run has to be performed [deg]
#. **MAX_RA**: Maximum RA of the area on which the run has to be performed [deg]
#. **MIN_DEC**: Minimum Dec of the area on which the run has to be performed [deg]
#. **MAX_DEC**: Maximum Dec of the area on which the run has to be performed [deg]



Table
+++++++++++++

The richclRichness table is expected to contain the following columns, for each detected cluster:

+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| Column name                   | Description                                                                     | Unit                 |
+===============================+=================================================================================+======================+
| **ID_CLUSTER**	              | Identifier of the detected cluster, as it appears in :ref:`detclAMICOClusters`  |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_PMEM**             | Richness estimate at a function of scalar RADIUS_PMEM, from Pmem method         |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_LERR_PMEM**	      | Error associated with RICHNESS_PMEM (lower/left side)                           |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_UERR_PMEM**	      | Error associated with RICHNESS_PMEM (upper/right side)                          |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RADIUS_PMEM**               | Radius around cluster (in arcmin) where RICHNESS_PMEM is estimated              | :math:`arcmin`       |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_VEC_PMEM**         | Richness estimate as a function of RADIUS_VEC_PMEM values, from Pmem method     |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_UERR_VEC_PMEM**    | Errors associated with RICHNESS_VEC_PMEM (lower/left side)                      |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_LERR_VEC_PMEM**    | Errors associated with RICHNESS_VEC_PMEM (upper/right side)                     |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RADIUS_VEC_PMEM**           | Vector of radii around cluster for RICHNESS_VEC_PMEM                            | :math:`arcmin`       |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **FLAG_PMEM**                 | Flag code for the processing of the cluster by PMEM                             | :math:`arcmin`       |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_RS** 	            | Richness estimate at a function of scalar RADIUS_RS, from RS method             |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_LERR_RS**	        | Error associated with RICHNESS_RS (lower/left side)                             |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_UERR_RS**   	      | Error associated with RICHNESS_RS (upper/right side)                            |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RADIUS_RS** 	              | Radius around cluster for RICHNESS_RS                                           |  :math:`arcmin`      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_VEC_RS** 	        | Richness estimate as a function of RADIUS_VEC_RS values from RS method          |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_UERR_VEC_RS**      | Errors associated with RICHNESS_VEC_RS (lower/left side)                        |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RICHNESS_LERR_VEC_RS**      | Errors associated with RICHNESS_VEC_RS (upper/right side)                       |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **RADIUS_VEC_RS**           	| Vector of radii around cluster where RICHNESS_VEC_RS                            |  :math:`arcmin`      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **TOTAL_FLUX_RS**             | Total flux, from RS                                                             |  :math:`mag`         |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **TOTAL_FLUX_ERR_RS**         | Error on total flux, from RS                                                    |  :math:`mag`         |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **FLAG_FLUX_RS**              | (Flag on total flux, from RS)                                                   |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **FLAG_RS**                   | Flag code for the processing of the cluster by RS                               | :math:`arcmin`       |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **BKG_FRACTION_PMEM**         | Fraction of visible background area from PMEM (between 0 and 1, 1=full bkg)     |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **CLUSTER_FRACTION_PMEM**     | Fraction of visible cluster area within 1 Mpc from PMEM                         |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **BKG_FRACTION_RS**           | Fraction of visible background area from RS (between 0 and 1, 1=full bkg)       |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+
| **CLUSTER_FRACTION_RS**       | Fraction of visible cluster area within 1 Mpc from RS                           |                      |
+-------------------------------+---------------------------------------------------------------------------------+----------------------+