[ ESO ]
HAWK-I:
Pipeline product naming scheme

CAL | HC | refs | QC
QUALITY CONTROL
    HOME
HAWK-I QC
Trending & QC1
Pipeline
   product names
Data Packages
Data Management
QC links:
general HAWK-I

LIST OF PIPELINE PRODUCTS CODES

The names of all pipeline products follow a certain naming convention. This is done to have human-readable rather than technical file names. The naming scheme has been chosen to have the type of product, its date of creation, and its pipeline-relevant parameter values all recognizable from the product name.

Since the begin of period 75 (April 2005), both science and calibration product files are renamed. (Actually, there was a transition phase extending for some instruments from April towards the end of the year 2005).

Before that date only calibration products followed the common scheme which is described here. (Some instruments had their own naming scheme which is described below, if applicable).

The general format of user-oriented product file names is the same for all VLT/VLTI instruments.

Instrument code

All pipeline product names start with two letters which are specific for the instrument. For instance: UVES product names start with 'UV', VISIR names with 'VR'.

Type of product

Next, the product type is coded. The full value is coded in the fits header key HIERARCH.ESO.PRO.CATG. A short form of this tag is coded in four characters being unique per instrument:
1st letter M or P calibration product
  S science product
  G general calibration product (as of P82)
2nd to 4th letter ... type of product

top HAWK-I INSTRUMENT CODE

All HAWK-I pipeline product names start with "HI_".

top SCIENCE PIPELINE PRODUCTS

Science products have the following scheme:

HI_S<PPP>_<OBS_ID>_<DATE_TIME>_<parameter_string>.<ext>

e.g.

HI_SCOM_327128_2008-07-30T02:59:39.441_H.fits

where:

  • S<PPP> is the four letter code uniquely describing the type of SCIENCE product (the first letter is always S for SCIENCE)
  • OBS_ID is the OB number read from the OBS.ID fits key
  • DATE_TIME is the UT date and time of the first raw frame measured for the template within the OB (e.g. 2008-07-30T02:59:39.441); this information is required since OBs can be executed several times
  • parameter_string is a string containing the instrument setup information (i.e. Filter)
  • ext is fits

The following types of science products presently exist:
CODE TYPE OF FILE PRO_CATG
SBGS Basic statitics of the image used for background subtraction for each RAW file in the stack BKG_STATS
SCOM Combined image COMBINED
SJSR Basic statistics of each RAW file used in stack JITTER_STATS
SOBP Object Parameters: basic info for each object detected in the combined frame OBJ_PARAM
SPCS P and C statitics SCIENCE_PCS
SSTI Stitched image STITCHED
top CALIBRATION PIPELINE PRODUCTS

HAWK-I calibration products come in two flavours: dynamic ones (being updated regularly, short validity), and static ones (never or rarely updated). Both product types are delivered in the data packages and stored in the archive. The static ones (also called general calibration products) are also delivered in the public pipeline releases.

top Dynamic calibrations.
The following types of dynamic calibration products of HAWK-I presently exist:
CODE TYPE OF FILE PRO_CATG VERSIONING?
MDRK Master Dark DARK_IM yes
PBPH Hot bad pixel mask BPM_HOT yes
PDSR Basic statistics of each RAW file used in stack DARK_STATS yes
 
MFLT Master Flat FLAT_IM yes
PBPC Cold bad pixel mask BPM_COLD yes
PBPM Combined (i.e. hot + cold) bad pixel mask BPM yes
PFEC Even Column OECE statistics FLAT_STATS_EVEN_COL yes
PFEM Error map FLAT_ERRMAP yes
PFER Even Row OERE statistics FLAT_STATS_EVEN_ROW yes
PFOC Odd Column OECE statistics FLAT_STATS_ODD_COL yes
PFOR Odd Row OERE statistics FLAT_STATS_ODD_ROW yes
PFRC Recomputed flat FLAT_RECOMPUTED yes
PFSR Basic statistics of each RAW file used in stack FLAT_STATS yes
POES Odd/Even Column/Row Effect statistics (Obsolete) FLAT_OE_STATS yes
 
PZIM Reduced image ZPOINT_IMA yes
PZRE Residuals ZPOINT_RES yes
PZSR Basic statistics of each RAW file used in stack ZPOINT_STATS yes

top Static calibrations.
With P82 (October 2008), the static calibration products are also named according to the standard HAWK-I naming scheme. Before that date, their names did not follow a strict naming scheme. The following table lists the codes in the new name scheme:

CODE TYPE OF FILE PRO_CATG
GSTD Standard Stars catalogue STDSTARS_CATS
GDIS Distortion map DISTORTION

The remaining part of the names follow the same convention as for the dynamic products (see below).

top Date of origin, version
The date of origin is identical to the date of the raw data measurement. It is coded as, e.g., 051015 for Oct 15, 2005.

The version of a file is indicated by capital letters always starting with A Versioning is supported for certain types of files, see the above table. In all other cases, only one version per day is created (always A).

top Instrumental parameters
The instrument parameters characterizing a setup are included in the product name. Most products have the following scheme:

<FILT>

where

  • <FILT> is INS.FILT1.NAME or INS.FILT2.NAME

Suffix

All product files have extension .fits. They have either image format or binary table format.

NOTE: HAWK-I pipeline products are either a traditional FITS file (i.e. single Header-Data Units (HDUs), e.g. the Stitched product of the hawki_img_jitter recipe) or Multi-Extensin FITS files (MEFs) with a primary HDU containing a header only and then four extension HDUs (one for each chip of the mosaic). The order is normally, but not necessarily chips 1,2,4,3.


 
[ESO][Index][Search][Help][News]