.. _SIRScienceFrame:

Science Frame Product
---------------------

Data product name
=================
.. DataProductNameStart

DpdSirScienceFrame

.. DataProductNameEnd




Data product custodian
======================
.. DataProductCustodianStart

SIR

.. DataProductCustodianEnd




Data model tag
==============
.. DataModelTagStart

R-10.0

.. DataModelTagEnd




Name of the Schema file
=======================
.. NameSchemaStart

.. raw:: html 

    <a href="https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/10.0.4/ST_DM_Schema/auxdir/ST_DM_Schema/dpd/sir/euc-sir-ScienceFrame.xsd" target="_blank">euc-sir-ScienceFrame.xsd</a>

.. NameSchemaEnd




Last Edited for DPDD Version
============================
.. LastEditedDPDDVersionStart

2.0

.. LastEditedDPDDVersionEnd




Processing Elements Creating / Updating / Using the Product
===========================================================
**Creators:**
  * SIR_Extract_Spectra

**Consumers:**
  * SIR_Extract_Spectra
  * SIR_Calibration_Opt
  * SIR_Calibration_Crv
  * SIR_Calibration_Ids
  * SIR_Calibration_Rel
  * SIR_Calibration_Abs


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

* SIR
* LE3

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
=================================
This product is proposed for inclusion in the SAS: yes

This product is used to store background subtracted frames.
These frames will also contain the pointing correction computed by SIR.


Data product elements
=====================
.. DataProductElementsStart

:Header: object of type sys:genericHeader
:Data: object of type sir:scienceFrame
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters: object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd



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

The **Science Frame** is produced at the end of the preprocessing steps and it represents data contained in the whole field of view.
It is serialized into a multi extension `FITS <https://fits.gsfc.nasa.gov/fits_standard.html>`_ file.
The primary extension does not contains data but only metadata about the pointing.

Data are stored into 48 extensions: 3 for each detector.
The extensions are:

* DETn.SCI: the extension containing dispersed image values on the n-th detector
* DETn.VAR: the extension containing variance on image values
* DETn.DQ: the extension containing pixel data quality. This layer is used to mark non-useful data values: bad pixels, cosmic rays, persistence and so on. The value of this layer is a bit mask which follow this convention:

  * 0: hot pixel
  * 1: cold pixel
  * 2: saturated pixel
  * 3: cosmic ray
  * 4: satellite trail
  * 5: interpolated pixel
  * 6: bleeding
  * 7: on-board masking
  * 8: bad pixel
  * 9: non-linear pixel
  * 10: persistent charge pixel
  * 11: ghost masking
  * 12: transient object
  * 13: extended object
  * 14: scattered light pixel
  * 15: charge injection
  * 16: near charge injection

.. DetailedDescEnd