.. _SIRScienceFrame:

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

Metadata
______________________

+--------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                          | DpdSirScienceFrame                                                                           |
+--------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                     | SIR                                                                                          |
+--------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                    | .. raw:: html                                                                                |
|                                            |                                                                                              |
|                                            | `euc-sir-ScienceFrame.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/10.1.2/ST_ |
|                                            | DM_Schema/auxdir/ST_DM_Schema/dpd/sir/euc-sir-ScienceFrame.xsd>`_                            |
+--------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product | * SIR                                                                                        |
|                                            | * LE3                                                                                        |
+--------------------------------------------+----------------------------------------------------------------------------------------------+

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
=====================
+--------------+----------------------------------------------+
| Header       | object of type sys:genericHeader             |
+--------------+----------------------------------------------+
| Data         | object of type sir:scienceFrame              |
+--------------+----------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder            |
+--------------+----------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters |
+--------------+----------------------------------------------+



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


DataContainer file name description
===================================

The following XML keywords:

  * Data.ObservationSequence.ObservationId (OBSID)
  * Data.ObservationSequence.PointingId (PTGID)
  * Data.ObservationSequence.DitherObservation (DITH)
  * Data.Grism (GWA)
  * Data.GrismWheelTilt (TILT)

are combined to create the DataContainer file name:

`EUC_SIR_W-SCIFRM_BKGSUB_<OBSID>_<PTGID>_<DITH>_<GWA>_<TILT>_<TIMESTAMP>.fits.gz`

Here below and example:

`EUC_SIR_W-SCIFRM_BKGSUB_65879_270539_0_RGS000_0_20250410T105605.065923Z.fits.gz`

.. DetailedDescEnd