.. include:: ../../idsubstitutions.txt
.. _SELIDParams:

SEL-ID Parameters Product
==========================


Data Product Name
__________________
.. DataProductNameStart

DpdLE3IDSELConfigurationSet

.. DataProductNameEnd

Data Product Custodian
_______________________
.. DataProductCustodianStart

IDSEL

.. 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/id/sel/inp/euc-le3-id-sel-ConfigurationSet.xsd" target="_blank">euc-le3-id-sel-ConfigurationSet.xsd</a>

.. NameSchemaEnd

Last Edited for DPDD Version
____________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd

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

**Creators:**

* GC-SWG specifies the configuration

**Consumers:**

* SEL_Collect
* SEL_Select
* SEL_PC

.. PECreatorEnd

Processing function using the data product
_______________________________________________
.. PFUsingStart

SEL-ID

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in the SAS: yes

This is an input configuration file that should be made available for verification purposes.


.. IncludeInSASEnd

Data Product Elements
______________________
.. DataProductElementsStart

:Header: object of type sys:genericHeader
:Data: object of type selid:selIDConfigurationSet
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters: object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This product stores configuration parameters for SEL, including
that paths to 1 or more selection files.

Each selection file contains the criteria to define a sample.
A selection can include a redshift range and cuts on any columns
in the catalog.

Format of the selection file
++++++++++++++++++++++++++++

The selection file is a text file that contains a query string.
The query string is in SQL-like format (to be completed).

Metadata
++++++++
The configuration is stored in the metadata in the follwing elements.

**Data/**

+------------------+-------------------------+---------------------------------------------+
| Key              | Type                    | Description                                 |
+==================+=========================+=============================================+
| MainSelection    | selectionDefinition     | Selection criteria for Main sample          |
+------------------+-------------------------+---------------------------------------------+
| DeepSelection    | selectionDefinition     | Selection criteria for Deep sample          |
+------------------+-------------------------+---------------------------------------------+
| SampleSelection  | selectionDefinitionList | List of selections for subsamples           |
+------------------+-------------------------+---------------------------------------------+
| ConfigurationID  | str                     | Configuration identifier                    |
+------------------+-------------------------+---------------------------------------------+
| CosmologyID      | str                     | Cosmology identifier                        |
+------------------+-------------------------+---------------------------------------------+
| CosmologyFile    | DataContainer           | Pointer to the cosmological parameters file |
+------------------+-------------------------+---------------------------------------------+

The `selectionDefinition` element contains:

**selectionDefinition**

+--------------------------+---------------+-----------------------------+
| Key                      | Type          | Description                 |
+==========================+===============+=============================+
| SelectionID              | str           | Identifier of the selection |
+--------------------------+---------------+-----------------------------+
| SelectionName            | str           | Name of the selection       |
+--------------------------+---------------+-----------------------------+
| Query                    | str           | Optional query string       |
+--------------------------+---------------+-----------------------------+
| SelectionFile            | DataContainer | Optional file name          |
+--------------------------+---------------+-----------------------------+
| MachineLearningModelFile | DataContainer | Optional file name          |
+--------------------------+---------------+-----------------------------+

The selection is specified in one or more of the following elements.

- `Query`: SQL-like query string.
- `SelectionFile`: File with the query string.
- `MachineLearningModelFile`: File with a machine learning model for classification.

.. DetailedDescEnd