.. _SIMSimRequest:
  
Sim Request Product
===================

$SetSchemaPath sim/euc-sim-SimRequest.xsd

Data Product Name
_________________
.. DataProductNameStart

$PrintDataProductName

.. DataProductNameEnd

Data Product Custodian
______________________
.. DataProductCustodianStart

$PrintDataProductCustodian

.. DataProductCustodianEnd

Name of the Schema File
________________________
.. NameSchemaStart

$PrintSchemaFilename

.. NameSchemaEnd


Last Edited for DPDD Version
____________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd


Processing Elements Creating / Updating / Using the Product
___________________________________________________________

.. PECreatorStart

**Creators:**

This data product is created and ingested in the EAS by hand.

**Consumers:**

SIM_Planner/SimPlannerProgram

.. PECreatorEnd


Processing Function using the products
______________________________________
.. PFUsingStart

SIM_Planner, SIM_IAL_Pipelines

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in the SAS: no

This data product is for PF_SIM internal use only.

.. IncludeInSASEnd

Data Product Elements
_____________________
.. DataProductElementsStart

$PrintDataProductElements

.. DataProductElementsEnd
   
Detailed Description of the Data Product
----------------------------------------
.. DetailedDescStart
   
Contrary to most of the data products in the :term:`ECSGS`, the SimRequest input data product is written by end user. It contains the following elements that specify the simulation to be produced by the different OU-SIM channels: 

* **MagnitudeLimit**: Magnitude cut in the **MagnitudeLimitFilter** in AB system. It applies both to stars and galaxies (optional)
* **MagnitudeLimitFilter**: Filter for the magnitude cut in AB system (default: Euclid-H band) (optional)
* **LogHalphaFluxLimit**: log(Halpha flux) cut, with Halpha flux in unit of erg/s/cm2/A (optional)
* **RandomSeed**: Random seed used and propagated across all the SIM pipeline (optional)
* **SimInputConfId**: This Id is propagated in the rest of the pipeline for specific processing. This Id is present ONLY if the productCategory is set to SIMULATION. This Id could transport a full description of the SIM processing parameters or a shortcut for this configuration : CAMPAIGNTTGRISM, ROTATE90GAL,... (optional)
* **SurveyConstraintArea**: Restriction to the fields with centers included in this area (optional)
* **SurveyConstraintTime**: Time specific restriction in the observation list XML file (optional)
* **SurveyConstraintObservations**: Optional list of ObservationsIDs taken from the reference survey (optional)
* **RandomDithers**: Needed when DataProduct.Category==Calib (optional)
* **ForceDithering**: Force the dithering computation instead of using the dithering in the survey file (optional)
* **ObservationMode**: Wide Survey or Deep Survey
* **DataProduct**: Data product type and category (e.g. Image or Spectrum, Science or Calibration, Dark or Flat, etc.)
* **VisProcessingSettings**:  VIS specific simulations settings, not including the common simulation settings (optional)
* **NipProcessingSettings**:  NIP specific simulations settings, not including the common simulation settings (optional)
* **NisProcessingSettings**:  NIS specific simulations settings, not including the common simulation settings (optional)
* **ExtProcessingSettings**:  EXT specific simulations settings, not including the common simulation settings (optional)

The name of the release is given by the **DataSetRelease** element in **Header** section of the data product.

.. DetailedDescEnd