.. _VisMasterFlatFrame:
  
Vis Master Flat Frame Product
-----------------------------


Data product name
=================
.. DataProductNameStart
   
DpdVisMasterFlatFrame
   
.. DataProductNameEnd
   
Data product custodian
======================
.. DataProductCustodianStart
   

   
.. DataProductCustodianEnd
   
Name of the Schema file
=======================
.. NameSchemaStart
   
.. raw:: html 

    <a href="https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/9.2.0/ST_DM_Schema/auxdir/ST_DM_Schema/dpd/vis/euc-vis-MasterFlatFrame.xsd" target="_blank">euc-vis-MasterFlatFrame.xsd</a>
   
.. NameSchemaEnd

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

:Header: object of type sys:genericHeader
:Data: object of type vis:visMasterFlatFrame
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters: object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

   
Schema documentation tag
========================
.. SchemaDocTagStart
   
:emphasis:`Documentation for data product element DpdVisMasterFlatFrame:`

Master Flat Calibration Pipeline result, using a series of flat calibration exposures to calculate a MasterFlat to be used in other ou-vis pipelines.

:emphasis:`Documentation for data product element Header:`
    
The generic header of the product.
   
.. SchemaDocTagEnd
   
Processing Element(s) creating/using the data product
=====================================================
.. PECreatorStart

Final data product of the Master Flat Calibraiton pipeline
   
.. PECreatorEnd
   
Processing function using the data product
==========================================
.. PFUsingStart

VIS -- Used by PRNU Correction tasks in several pipelines: (ProcessField, LargeFlat, BrighterFatter)

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

Master Flat Calibration Pipeline result, using a series of flat calibration exposures to calculate a MasterFlat to be used in other ou-vis pipelines.

The product produces a Flagmap fits file same size as the Master PRNU whereby each pixel is a standard bit.  The Master PRNU will set the bits for flagging hot and cold pixels.
The Flagmap data format is defined in the `data model here <http://euclid.esac.esa.int/svn/EC/SGS/ST/4-2-05-DM/schema/trunk/dictionary/bas/msk/>`_ and is described in `human-readable format here <https://euclid.roe.ac.uk/projects/vis_pf/wiki/VIS_Flags>`_.

The product produces a LED Profile fits file same size as the Master PRNU, which quantifies the Illumination of the quadrant by the calibration unit LED.

Each pixel in a CCD has slightly different levels of response to light, due to manufacturing
irregularities. The PRNU of a pixel is defined here as the level of responsiveness relative to its nearby
neighbours, where the average is 1.0. The nearest neighbours have the highest weighting in this
average. This weighting is implicit in the use of surface fitting to remove larger scale variations.
Those variations include sky background, calibration LED illumination and shutter effects.

The PRNU model is stored as a 2-D image, not including prescan or overscan areas. PRNU is calibrated using a set of PRNU exposures, illuminated by an LED in the Calibration Unit which sits in front of the focal plane. FLat exposures have different fluence levels and used for different purposes in other pipelines.

When PRNU product is used during Correction, is a multiplicative effect, so the application of a correction involves simply dividing an image by the PRNU model.

The final product will be 144 extensions based on the quadrants with the EXTNAME noted as the CCDID, 2048x2066 pixels in ADU units.

Detailed Algorithm information can be viewed from tech note: https://euclid.roe.ac.uk/dmsf/files/16476/view

Primary Header:

+----------+-----------+---+------------------------------------------------------------------+
| SIMPLE   |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| BITPIX   |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| NAXIS    |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| EXTEND   |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| OBSTYPE  |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| N_CCD    |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| EXPTIME  |           | / | Commanded integration time in seconds, e.g. 565.0                |
+----------+-----------+---+------------------------------------------------------------------+
| DATAUNIT |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| RA       |           | / | Commanded FPA pointing right ascension (deg)                     |
+----------+-----------+---+------------------------------------------------------------------+
| DEC      |           | / | Commanded FPA pointing declination (deg)                         |
+----------+-----------+---+------------------------------------------------------------------+
| INSTRUME |           | / | VIS instrument                                                   |
+----------+-----------+---+------------------------------------------------------------------+
| SEQID    |           | / | VIS sequences as defined in EUCL-IFS-ICD-6-002 VIS Data ICD      |
+----------+-----------+---+------------------------------------------------------------------+
| ORIENTAT |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| DATE     |           | / | UT date when this file was created                               |
+----------+-----------+---+------------------------------------------------------------------+
| DATE-OBS |           | / | UTC Date of observation (start), e.g. '2014-03-15T09:30:09.313'  |
+----------+-----------+---+------------------------------------------------------------------+
| VERSION  |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| END                                                                                         |
+----------+-----------+---+------------------------------------------------------------------+

Extension Header:

+----------+-----------+---+------------------------------------------------------------------+
| XTENSION |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| BITPIX   |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| NAXIS    |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| NAXIS1   |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| NAXIS2   |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| PCOUNT   |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| GCOUNT   |           | / |                                                                  |
+----------+-----------+---+------------------------------------------------------------------+
| TIMESYS  |           | / | Time scale of the time-related keywords                          |
+----------+-----------+---+------------------------------------------------------------------+
| DATE     |           | / | UT date when this file was created                               |
+----------+-----------+---+------------------------------------------------------------------+
| MJDATE   |           | / | MJD start time, e.g. 56731.39594113                              |
+----------+-----------+---+------------------------------------------------------------------+
| WCSAXES  |           | / | Number of coordinate axes                                        |
+----------+-----------+---+------------------------------------------------------------------+
| CRPIX1   |           | / | Reference pixel x coordinate                                     |
+----------+-----------+---+------------------------------------------------------------------+
| CRPIX2   |           | / | Reference pixel y coordinate                                     |
+----------+-----------+---+------------------------------------------------------------------+
| CRVAL1   |           | / | Right ascension at ref pixel                                     |
+----------+-----------+---+------------------------------------------------------------------+
| CRVAL2   |           | / | Declination at ref pixel                                         |
+----------+-----------+---+------------------------------------------------------------------+
| CTYPE1   |           | / | Coordinamte 1 type                                               |
+----------+-----------+---+------------------------------------------------------------------+
| CTYPE2   |           | / | Coordinamte 2 type                                               |
+----------+-----------+---+------------------------------------------------------------------+
| RA       |           | / | Commanded FPA pointing right ascension (deg)                     |
+----------+-----------+---+------------------------------------------------------------------+
| DEC      |           | / | Commanded FPA pointing declination (deg)                         |
+----------+-----------+---+------------------------------------------------------------------+
| CD1_1    |           | / | Translation matrix element                                       |
+----------+-----------+---+------------------------------------------------------------------+
| CD1_2    |           | / | Translation matrix element                                       |
+----------+-----------+---+------------------------------------------------------------------+
| CD2_1    |           | / | Translation matrix element                                       |
+----------+-----------+---+------------------------------------------------------------------+
| CD2_2    |           | / | Translation matrix element                                       |
+----------+-----------+---+------------------------------------------------------------------+
| EXTNAME  |           | / | Format: CCD row-CCD column.quadrant id, e.g. 2.3-H               |
+----------+-----------+---+------------------------------------------------------------------+
| INSTRUME |           | / | VIS instrument                                                   |
+----------+-----------+---+------------------------------------------------------------------+
| EXPTIME  |           | / | Commanded integration time in seconds, e.g. 565.0                |
+----------+-----------+---+------------------------------------------------------------------+
| DETECTOR |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| GAIN     |           | / | Maximum equivalent gain (e-/ADU)                                 |
+----------+-----------+---+------------------------------------------------------------------+
| RDNOISE  |           | / | Read out Noise                                                   |
+----------+-----------+---+------------------------------------------------------------------+
| QE       |           | / | Quantum Efficiency                                               |
+----------+-----------+---+------------------------------------------------------------------+
| DC       |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| PIXSIZE  |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| PIXSCALE |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| CCDID    |           | / | e.g. Detector ID and quad, e.g. 1-1.H' ... '6-6.E'               |
+----------+-----------+---+------------------------------------------------------------------+
| QUADID   |           | / | e.g. Quadrant ID, e.g. 'E', 'F', 'G' or 'H'                      |
+----------+-----------+---+------------------------------------------------------------------+
| PRESCANX |           | / | number of serial prescan pixels, e.g 51                          |
+----------+-----------+---+------------------------------------------------------------------+
| OVRSCANX |           | / | number of serial overscan pixels, e.g 20                         |
+----------+-----------+---+------------------------------------------------------------------+
| DETSEC   |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| ASEC     |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| DSEC     |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| TSEC     |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| BSEC     |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| CSEC     |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| MAXLIN   |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| SATURATE |           | / | Saturation Level (ADU)                                           |
+----------+-----------+---+------------------------------------------------------------------+
| NON_LIN  |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| RON_STD  |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| BIAS_LVL |           | / | Bias Level                                                       |
+----------+-----------+---+------------------------------------------------------------------+
| ADC_MAX  |           | / | ToFill                                                           |
+----------+-----------+---+------------------------------------------------------------------+
| PC1_1    |           | / | Coordinate transformation matrix element                         |
+----------+-----------+---+------------------------------------------------------------------+
| PC1_2    |           | / | Coordinate transformation matrix element                         |
+----------+-----------+---+------------------------------------------------------------------+
| PC2_1    |           | / | Coordinate transformation matrix element                         |
+----------+-----------+---+------------------------------------------------------------------+
| PC2_2    |           | / | Coordinate transformation matrix element                         |
+----------+-----------+---+------------------------------------------------------------------+
| CDELT1   |           | / | [deg] Coordinate increment at reference                          |
+----------+-----------+---+------------------------------------------------------------------+
| CDELT2   |           | / | [deg] Coordinate increment at reference                          |
+----------+-----------+---+------------------------------------------------------------------+
| CUNIT1   |           | / | Physical units of CRVAL1                                         |
+----------+-----------+---+------------------------------------------------------------------+
| CUNIT2   |           | / | Physical units of CRVAL2                                         |
+----------+-----------+---+------------------------------------------------------------------+
| LONPOLE  |           | / | [deg] Native longitude of celestial pol                          |
+----------+-----------+---+------------------------------------------------------------------+
| LATPOLE  |           | / | [deg] Native latitude of celestial pole                          |
+----------+-----------+---+------------------------------------------------------------------+
| RADESYS  |           | / | Astrometric system                                               |
+----------+-----------+---+------------------------------------------------------------------+
| DATE-OBS |           | / | UTC Date of observation (start), e.g. '2014-03-15T09:30:09.313'  |
+----------+-----------+---+------------------------------------------------------------------+
| CHECKSUM |           | / | HDU checksum updated 2018-11-15T12:07:22                         |
+----------+-----------+---+------------------------------------------------------------------+
| DATASUM  |           | / | data unit checksum updated 2018-11-15T12:07:22                   |
+----------+-----------+---+------------------------------------------------------------------+
| NBIAS    |           | / | Number of Bias Frames                                            |
+----------+-----------+---+------------------------------------------------------------------+
| COMBMETH |           | / | Combination Method Used                                          |
+----------+-----------+---+------------------------------------------------------------------+
| NORMMETH |           | / | Normalisation Method                                             |
+----------+-----------+---+------------------------------------------------------------------+
| END                                                                                         |
+----------+-----------+---+------------------------------------------------------------------+

.. DetailedDescEnd