.. include:: ../../idsubstitutions.txt
.. _VMPZIDParamsInfoMap:

Input Product: Information Map Parameters
============================================


Data Product Name
__________________
.. DataProductNameStart

DpdInfoMapParamsVMPZ

.. DataProductNameEnd

Data Product Custodian
_______________________
.. DataProductCustodianStart

IDVMPZ

.. 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/le3/id/vmpz/inp/euc-le3-id-vmpz-ParamsInfoMap.xsd" target="_blank">euc-le3-id-vmpz-ParamsInfoMap.xsd</a>

.. NameSchemaEnd

Last Edited for DPDD Version
____________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd

Processing Elements Creating / Updating / Using the Product
___________________________________________________________
.. PECreatorStart

**Creators:**

* SWG and OU-LE3 specify the configuration

**Consumers:**

* VMPZ_Main (LE3_VMPZ_ID_Main)

.. PECreatorEnd

Processing function using the data product
_____________________________________________
.. PFUsingStart

VMPZ-ID

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in SAS: yes

This is an input configuration file that should be made available for verification purposes.

.. IncludeInSASEnd

Data Product Elements
______________________
.. DataProductElementsStart

:Header: object of type sys:genericHeader
:Data: object of type vmpzid:infoMapParamsVMPZ
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters: object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This product contain parameters describing how the algorithm is run to produce the
Information maps and should specify:

*spatial/temporal and instrumental information to know which information to collect*:

* **DateObs**: Starting time of observations considered [string,
  "\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(\.\d{1,6})?Z", optional]
* **DateEnd**: End time of observations considered [string,
  "\d\d\d\d-\d\d-\d\dT\d\d:\d\d:d\d(\.\d{1,6})?Z", optional]
* **Telescope**: Name of telescope [string, choice among ins:telescopeName,
  optional]
* **Instrument**: Name of instrument [string, choice among ins:instrumentName,
  optional]
* **Filter**: Name of filter considered if a single filter is considered
  [string, choice among ins:filterName, optional]
* **FilterList**: Name of filters considered if several filters are considered
  [string, choice among ins:filterList, optional]
* **TileIndex**: Tile ID as described by MER if single tile processed (stage 1)
  [long, optional]
* **MerTileListID**: Product ID of a list of MER tiles, as set by MER if several
  tiles processed (stage 2) [sys:objectId, given,  optional]

*Processing/IO parameters:*

* **NsideWork**: Nside used to convert frames/mosaic-> HEALPix [sys:objectId, given,  optional]
* **OutputFormat**: whether partial HEALPix or weighted MOC are used:

  * **MOCParams**: Parameters for weighted MOCs [optional]

    * **MOCOrder**: MOC resolution parameter (best order) [long]

  * **PartialHealpixParams**: Parameters for partial HEALPix [optional]

    * **NsideOut**: Nside resolution parameter for the partial HEALPix map
      product [long]


* **InformationMap**: Information to collect and store in the map [string among
  "Noise","Weights", "Exposures","PSF","Seeing", "Background", "Airmass",
  "AtmosphericExtinction","SAA" or "OTHER"]

* **Statistics**: statistics to report [string, optional]

.. note::
   We could potentially have a list of information to collect as well, and end up with a
   single product for all (e.g. having a variable length column for the WeightStorage
   to allow for different selection in this product without breaking the DM).
   However, I think these products cover multiple use cases and therefore we need
   to keep some flexibility because not all of them will be needed in the different use cases.

.. DetailedDescEnd