.. _NIRStackedFrameCatalog:

NIR Stacked Frame Catalog
=========================

$SetSchemaPath nir/euc-nir-StackedFrameCatalog.xsd

  
Data product name
_________________
.. DataProductNameStart
   
$PrintDataProductName
   
.. DataProductNameEnd
   
Data product custodian
______________________
.. DataProductCustodianStart
   
$PrintDataProductCustodian
   
.. DataProductCustodianEnd


Name of the Schema File
________________________
.. NameSchemaStart

$PrintSchemaFilename

.. NameSchemaEnd

Last Edited for DPDD Version
____________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd
   

Processing Elements Creating / Updating / Using the Product
___________________________________________________________

.. PECreatorStart

**Creators:**

* The `NIR_Catalog_Extraction <https://gitlab.euclid-sgs.uk/PF-NIR/NIR_CatalogExtraction>`_ 


**Consumers:**

* :ref:`NIRPipeline` 

.. PECreatorEnd


Processing Function using the products
______________________________________
.. PFUsingStart

* PF-NIR 

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in the SAS: **yes**

This is one of the main PF-NIR products and it is the catalog extracted from the :ref:`NIRStackedFrame` image. 


.. IncludeInSASEnd

Data Product Elements
_____________________
.. DataProductElementsStart

$PrintDataProductElements

.. DataProductElementsEnd


Detailed Description of the Data Product
________________________________________

.. DetailedDescStart


The **DpdNirStackedFrameCatalog** is one of the output of the *NIR_ProcessField_Pipeline* applied to wide survey observations
and in general to "scientific" images (i.e. it could be executed also on Self Calibration images).

The catalog is extracted from :ref:`NIRStackedFrame` images. A single catalog is, therefore, provided at the end of each
*NIR_ProcessField_Pipeline* run.

The **DpdNirStackedFrameCatalog** data product contains the link to a FITS file.


.. _NIR_stacked_frame_catalog:
.. figure:: ../figures/nirStackedCatalog.png
   :scale: 100 %
   :align: center
   :figclass: align-center

   : Graphical representaton of ``Data`` section structure for **DpdNirStackedFrameCatalog**


The main elements inside the *Data* section are:

* **SpatialCoverage**
* **CatalogDescription**
* **SpectralCoverage**
* **CatalogDescription**
* **ObservationId**: Observation Id of origin stacked image
* **DataStorage**: Element that links to a FITS file containing the Stacked image FITS file
* **TargetPointing**: Coordinates of target pointing
* **QualityParams** (optional): Data Quality Parameters
    * **ObjectCount**: Number of object in the catalog
    * **MagAper**: Basic statistics for Magnitude APER extraction (mag)
    * **MagAuto**: Basic statistics for Magnitude AUTO extraction (mag)
    * **MagPSF**: Basic statistics for Magnitude PSF extraction (mag)
    * **Bright**: Basic statistics on errors for brighter sources
    * **Faint**: Basic statistics on errors for fainter sources



Scientific FITS File
^^^^^^^^^^^^^^^^^^^^
.. FITSFileDescriptionStart

The FITS type *nir.stkCatalog* has a structure aligned with the image from which the catalog is extracted and



Primary layer 
"""""""""""""

The primary header of scientific catalog reflects basic information of staked image source of the catalog.

$PrintPrimaryHeader fit/euc-nir.xml nir.stkCatalog


**LDAC_OBJECTS** Extension header
"""""""""""""""""""""""""""""""""

The FITS type *nir.stkCatalog* contains a binary table HDU named **LDAC_OBJECTS** with the next columns list

$PrintCatalog fit/euc-nir.xml nir.stkCatalog

.. $PrintHDUTableContents fit/euc-test-nir.xml nir.stkCatalog LDAC_OBJECTS


.. FITSFileDescriptionEnd

.. DetailedDescEnd