.. _SIMSsoCatalogProduct:
  
SSO Catalog Product
===================

$SetSchemaPath sim/euc-sim-SsoCatalogProduct.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:**

These catalogs are created by the LU SWG, outside of the SIM PF.

**Consumers:**

Processing elements using the data product:

* SIM_Tools/EuclidTU
* SIM_Tools/ComputeFluxes
* SIM_ELViS_Simulator/EuclidVis
* SIM_TIPS_Simulator/EuclidNis
* SIM_Imagem/EuclidNip
* SIM_EXT/EuclidExt

.. PECreatorEnd


Processing Function using the products
______________________________________
.. PFUsingStart

SIM_Tools, SIM_ELViS_Simulator, SIM_TIPS_Simulator, SIM_Imagem, SIM_EXT

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in the SAS: no

This data product is for PF_SIM internal use only.

.. IncludeInSASEnd

Data Product Elements
_____________________
.. DataProductElementsStart

$PrintDataProductElements

.. DataProductElementsEnd

Detailed Description of the Data Product
----------------------------------------
.. DetailedDescStart

A SsoCatalogProduct contains the following elements that describe a sky patch and associated information required to reconstruct SSO magnitudes:

* **SsoCatalog**: SSO catalogue filename, associated with the area it covers on the sky, and a period of observation
* **SedLibrary**: Library identifier, and data container to a the star SED library. SSO spectra are scaled from a G2V template FEH=0 dex, Teff=5750K and Logg=4.4 (template ID `3632 <https://gitlab.euclid-sgs.uk/PF-SIM/SIM_Tools/-/blob/4.3.1/SimCatalogs/python/SimCatalogs/catalog_lib.py?ref_type=tags#L1025>`_).
* **ReferenceFilterFile**: Data container with the filter throughput filename, used to renormalize the star templates to apparent flux. 

The reference column name is **REF_MAG**.

The name of the release is given by the **DataSetRelease** element in **Header** section of the data product.

StarCatalog FITS format
+++++++++++++++++++++++

The format of the input star catalogue is specified by the FITS format `sim.ssoCatalog 0.1 <https://gitlab.euclid-sgs.uk/ST-DM/ST_FitsDataModel/-/blob/9.2.0/ST_DM_FitsSchema/auxdir/ST_DM_FitsSchema/instances/fit/euc-sim.xml?ref_type=tags#L173>`_. A catalogue contains the following columns:

**Catalog columns**

$PrintCatalog fit/euc-sim.xml sim.ssoCatalog

.. DetailedDescEnd