.. _NIRMasterDark:
  
[to complete] NIR Master Dark
=====================

$SetSchemaPath nir/euc-test-nir-MasterDark.xsd

Data Product Name
__________________
.. DataProductNameStart

$PrintDataProductName

.. DataProductNameEnd

Data Product Custodian
_________________________________
.. DataProductCustodianStart

$PrintDataProductCustodian

.. DataProductCustodianEnd

Name of the Schema File
________________________
.. NameSchemaStart

$PrintSchemaFilename

.. NameSchemaEnd

Data Product Elements
______________________
.. DataProductElementsStart

$PrintDataProductElements

.. DataProductElementsEnd


Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

A master dark frame for each filter is foreseen.

In addition, a set of metadata is used to describe the validity range, the time interval and the list of raw dark frames
used to generate the master dark, the temperature of the focal plane.


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

The **MasterDark** frame is a Calibration Data product created by the *NIR_MasterDark_Pipeline* which combines dedicated
dark frames to create a MEF file.

The task responsible for MasterDark creation is **MakeMasterDarkProg** (under *NIR_DarkBiasSubtraction* project).

.. PECreatorEnd


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

This is an internal NIR data product, and it is used only by the NIR PF.

It is applied by **DarkSubtractionProgram** task (under *NIR_DarkBiasSubtraction* project) in the *NIR_ProcessField_Pipeline*
and in most of the calibration pipelines.

.. PFUsingEnd


Data Product structure description
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. DataProductDescrStart

The main elements inside the *Data* section are:

* **Filter**: The filter name (e.g. NIR_Y, NIR_J, NIR_H)
* **ValidityRange**: Calibration file validity period estimated
* **MSDParameters**: The collection of some parameters specific for MasterDark creation
    * **FrameNumbers**: Number of dark frames that went into the Master Dark creation. Corresponding to *NFRAME* primary header keyword
    * **TotalExposureTime**: Total exposure time in seconds. Corresponding to *EXPTOT* primary header keyword
    * **FocalPlaneTemperature**: Focal plane temperature. Corresponding to *FP_TEMP* primary header keyword
* **DataStorage**: Element that links to a FITS file containing the MasterDark FITS file
* **QualityParams** (optional): List of Detector Data Quality Parameters
    * **Min**: Minimum image pixel value
    * **Max**: Maximum image pixel value
    * **Mean**: Average image level (mean of all image pixel values)
    * **Median**: Median image level (median of all image pixel values)
    * **MAD**: Median Absolute Deviation of the image pixel values
    * **MaskedPixelFraction**: The fraction of masked pixels
    * **NoisePixelNumber**: Number of high noise pixels with filled dark values. *NDFILL* detector header

.. DataProductDescrEnd

FITS file description
~~~~~~~~~~~~~~~~~~~~~
.. FITSFileDescriptionStart

The structure of the NIR MasterDark is the same as the Science Image of the :ref:`NIRCalibratedFrame` with 16 x 3 layers, i.e. containing
median dark current, RMS, and Data Quality flags for each detector.


Primary header
****************

The primary header contains keywords to identify FITS data type and some others (e.g. *NFRAME*, *EXPTOT*, *FP_TEMP*)
dedicated to track specific *MSDParameters*.

$PrintPrimaryHeader fit/euc-test-nir.xml nir.masterDark

SCI Extension header
****************

The scientific header contains some basic image definition keywords.

In addition it guests the *NDFILL* -> *NoisePixelNumber*

$PrintExtensionHeader fit/euc-test-nir.xml nir.masterDark SCI.n

.. FITSFileDescriptionEnd

.. DetailedDescEnd