.. _SPEConfigurationSet:


Configuration Set Product
=========================

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdSpeConfigurationSet                                                                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | SPE                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-spe-ConfigurationSet.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/10.1.2 |
|                                                | /ST_DM_Schema/auxdir/ST_DM_Schema/dpd/spe/euc-spe-ConfigurationSet.xsd>`_                    |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 1.3                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * None. This is an input product that is generated manually or using some                    |
|                                                | dedicated scripts.                                                                           |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * All SPE :term:`Processing Element`\s.                                                      |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product     | SPE                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Proposed for inclusion in EAS/SAS              | This product is proposed for inclusion in the SAS: no                                        |
|                                                |                                                                                              |
|                                                | The product contains configuration files for the SPE pipeline that are most                  |
|                                                | probably not relevant for the general scientist.                                             |
+------------------------------------------------+----------------------------------------------------------------------------------------------+

Data Product Elements
_____________________
+--------------+----------------------------------------------+
| Header       | object of type sys:genericHeader             |
+--------------+----------------------------------------------+
| Data         | object of type spe:speConfigurationSet       |
+--------------+----------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder            |
+--------------+----------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters |
+--------------+----------------------------------------------+


Detailed Description of the Data Product
________________________________________
.. DetailedDescStart

This is an input product to the SPE :term:`Pipeline`. It contains a list of
one configuration files with the parameter values to be used by the SPE 
pipeline.

The main elements inside this product are:

* **ProcessingMode**: The SPE pipeline processing mode (e.g. WIDE, DEEP) to
  which the configuration set should be associated.
* **ConfigurationFile** (one): Element containing the name of the 
  configuration file to be used for the SPE pipeline.
* **Comment** (optional): A comment describing this particular configuration 
  set (why it was created, why we are not using the default configuration 
  files, etc).

.. DetailedDescEnd