.. _SIMNisInputConfiguration:
  
Nis Input Configuration Product
-------------------------------
  
Data product name
=================
.. DataProductNameStart
   
DpdNisInputConfiguration
   
.. DataProductNameEnd
   
Data product custodian
======================
.. DataProductCustodianStart
   
SIM
   
.. DataProductCustodianEnd
   
Data model tag
==============
.. DataModelTagStart
   
9.0.1
   
.. DataModelTagEnd
   
Name of the Schema file
=======================
.. NameSchemaStart
   
euc-test-sim-NisInputConfiguration.xsd
   
.. NameSchemaEnd
   
Schema documentation tag
========================
.. SchemaDocTagStart
   
:emphasis:`Data product documentation:`
    
Input data product for the NISP-S simulation channel

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

This data type contains inputs to simulate a NISP-S pointing: flux and magnitude cuts, simulation and processing settings, such as pointing information, and instrumental feature switches.
   
   
.. SchemaDocTagEnd
   
Data product elements
=====================
.. DataProductElementsStart
   
Header of type: sys:genericHeader

Data of type: nisp:nisInputConfiguration

Parameters of type: ppr:genericKeyValueParameters

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

SIM_Planner/SimPlannerProgram (creator), SIM_TIPS_Simulator/EuclidNisSplit (user)
   
.. PECreatorEnd
   
Processing function using the data product
==========================================
.. PFUsingStart

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

In its **Data** section, this data product combines a generic SIM input configuration data type, with Space Simulation and Processing settings specific to the NIS channel. Input star and galaxy catalogues are provided to EuclidNis :term:`PE` by another data product :ref:`SIMTrueUniverseOutput`.

Input Configuration
+++++++++++++++++++

The input configuration is generic to all SIM simulation channels. It contains the following elements:

* **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)

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

Note that these elements are currently ignored by SIM_TIPS_Simulator, because it uses the :ref:`SIMTrueUniverseOutput` as an input catalog, which already contains these cuts.

Space Simulation Settings
+++++++++++++++++++++++++

Describes simulation settings common to EuclidNip, EuclidNis and EuclidVis :ref:`Processing Elements`. It contains the following elements:

* **FPAPointing**: FPA pointing in Equatorial Coordinates J2000
* **DataProduct**: Data product type and category (e.g. Image or Spectrum, Science or Calibration Dark or Flat, etc.)
* **ObservationDate**: Observation date of the exposure
* **ObservationMode**: Wide Survey or Deep Survey
* **ObservationSequence**: Information on the observation sequence in which the exposure is acquired
* **IntrumentMode**: Instrument mode during the exposure acquisition
* **Orbit**: Predicted satellite orbit (Position, Velocity, Solar aspect angle) at the observation time (optional)

NIS Processing Settings
+++++++++++++++++++++++

The NIS specific processing settings data type contains the following elements:

* **ReadoutMode**: Readout mode used in this exposure
* **CalibUnit**: Calibration unit status and level 
* **GrismWheelPos**: Grism wheel position
* **GrismTiltAngle**: Grism Wheel tilt with respect to the selected grism 
* **FilterWheelPos**: Filter wheel position
* **SimulatedGrismOrderList**: List of grism order names to simulate (in A,B,C,D)
* **ProcessingSteps**: Set of NIS specific processing steps to activate/deactivate
   
.. DetailedDescEnd