.. _NIRBadPixelMask:

[to complete] NIR Bad Pixel Mask
==================

$SetSchemaPath nir/euc-test-nir-BadPixelMask.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

The NIR **Bad Pixel Mask** contains bad and unreliable pixels in the near-infrared detectors.

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

The **Bad Pixel Mask** is created by **makeNirBadPixels**  task in *NIR_BadPixelMasking* project.

It creates a mask for the bad pixels in the near-infrared detectors.  It makes a list of bad pixels based on the
detector data obtained from GFSC, which consists of test data with dis-connected pixels, zero-fluence pixels, and noisy
pixels.

It combines a set of :ref:`NIRBadPixelFlavorMask` to create the final NIR Bad Pixel Mask.

.. 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 **maskBadpixels** task (under *NIR_BadPixelMasking* 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:

* **ValidityRange**: Calibration file validity period estimated
* **DataStorage**: Element that links to a FITS file containing the Bad Pixel Mask FITS file
* **QualityParams** (optional): List of Detector Data Quality Parameters
    * **DetectorId**: Detector id
    * **TotalBadPixels**: Total number of bad pixels (NBADPIXT)
    * **DisconnettedBP**: Number of disconnected pixels (NBADPIX1)
    * **ZeroQEBP**: Number of Zero Quantum Efficiency pixels (NBADPIX2)
    * **RTNoiseBP**: Number of pixels detected with RTN (NBADPIX3)
    * **SnowballingBP**: Number of snowballing pixels (NBADPIX4)
    * **HotBP**: Number of Hot pixels (NBADPIX5)
    * **HLBaselineBP**: Number of High-Low baseline pixels (NBADPIX6)
    * **LowQEBP**: Number of Low Full Well pixels (NBADPIX7)
    * **SuperQEBP**: Number of Super Quantum Efficiency pixels (NBADPIX8)

The Quality Parameter section tracks the number of single flavor pixels, propagating information stored in
:ref:`NIRBadPixelFlavorMask` used for Bad Pixel Mask creation.

.. DataProductDescrEnd

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

The Bad Pixel Mask FITS file is composed by a Table to store bad pixels coordinates in pixel and the corresponding
flag value to be used.

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

The primary header contains keywords to identify FITS data type and validity range.

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

BPM Extension
****************

The BPM header contains the list of the number of single flavor bad pixels used in Bad Pixel Mask creation.

$PrintExtensionHeader fit/euc-test-nir.xml nir.badPixelMask BPM

The BPM layer has a Table with the columns

$PrintCatalog fit/euc-test-nir.xml nir.badPixelMask

.. FITSFileDescriptionEnd

.. DetailedDescEnd