XMM-Newton Science Analysis System


odfingest (odfingest-3.33.1) [xmmsas_20230412_1735-21.0.0]

Housekeeping parameters

This section lists the names of the housekeeping parameters extracted by odfingest. They are grouped by instrument and type of housekeeping file. For each parameter there are up to five entries:

• The parameter name.

  Example: FILTER_WHEEL_POSITION.

  This is the name used in the SOSF. This name should be used with the OAL routines hasIppv, getIppvString, getIppvReal.

• The DAL data type of the parameter.

  Example: string.

  String parameters should be retrieved with getIppvString, all numeric parameters should be retrieved with getIppvReal.

• The name of the column in the housekeeping file from which the parameter is read.

  Example: E1257.

  Most column names match the housekeeping parameter names in the XMM-Newton telemetry data base, but a few don't. Refer to the ODF Interface Control Document for the details [1].

• An additional filter expression.

  Example: subject to HBRID == 1.

  The filter expression is applied to the housekeeping data before the parameter value is read. This expression is used when a simple filter in time is not sufficient to uniquely identify the parameter value. This is in general true for the so-called non periodic housekeeping data. Again, consult [1] for the details.

• The details of the translation between housekeeping values and the values used in the SOSF.

  Example:

  FILTER Uint16 [E1317]
  This parameter is translated as follows:
  Translator's name: EMOS1 Filter
  0 = Closed
  247 = CalThin1
  267 = Thin1
  514 = CalThin2
  534 = Thin2
  781 = CalMedium
  801 = Medium
  1047 = CalThick
  1067 = Thick
  1314 = CalOpen
  1334 = Open
  1580 = CalClosed
  

  The parameter FILTER is extracted from the housekeeping column E1317. Its value is translated according to a lookup table mapping housekeeping values to strings.