make printable	new:	see also:
	- v1.0 first release	- qc_rawdisp.py

rawdisp2reference

Description

This tool can be called after moveProducts for selecting RAWDISP plots as reference plots. It works on a specified date: ABs can be selected interactively, the RAWDISP plots from the chosen ABs are then copied to $DFS_PRODUCT/RAWDSIP/REFERENCE/, renamed, and published on the web server at /observing/dfo/quality/<INSTRUMENT>/reports/RAWDISP/REFERENCE. Thereafter, the reference plots are found by getStatusAB when creating the RAWDISP web pages and are linked to the current plots for comparison. For possible usage in overview pages, also the thumbnail images are renamed and saved (but not published).

The tool expects ABs in $DFO_LOG_DIR/<DATE>. Therefore, it can only be called after moveProducts. It only offers certified ABs and ABs from pipeline-unsupported modes for selecting reference plots. The RAWDISP plots are expected to be on the operational machine in $DFS_PRODUCT/RAWDSIP/<DATE>/. If this directory was already removed by finishNight, the user is asked whether the needed plots shall be re-created.

The naming scheme for the reference plots is

<RAWTYPE>_<DO_CLASS>_<SETUP>_<EXT>.gif

<RAWTYPE>, <DO_CLASS>, and <SETUP> are taken from the RAW_TYPE, RAWFILE, and RAW_MATCH_KEY sections of the relevant AB. Header key names in the RAW_MATCH_KEYs are removed, any existing '/' in the set up is replaced by '_'. <EXT> is the fits extension number (0 for the primary header unit) in the raw file. Newly created reference plots replace automatically any existing references with the same name.

Output

The renamed reference plots exist locally at

$DFS_PRODUCT/RAWDISP/REFERENCE/

and on the web server at

/observing/dfo/quality/<INSTRUMENT>/reports/RAWDISP/REFERENCE/ .

Thumbnail images are locally at

$DFS_PRODUCT/RAWDISP/THUMBS/.

A listing with of all reference plots exists as $DFO_MON_DIR/RAWDISP/list_RAWDISP_references. It matches the plots with their original names, raw types, DO classes, instrument set-ups, and DFO dates.

How to use

Type rawdisp2reference -h for on-line help, rawdisp2reference -v for the version number.

The standard usage is

rawdisp2reference -d <DATE>

for selecting plots from <DATE> as references. It may eventually be useful to re-create the RAWDISP plots even in the case that the local directory still exists. This can be enforced with the -F option:

rawdisp2reference -F -d <DATE>

Configuration file

The configuration file config.rawdisp (same as for qc_rawdisp.py) must exist in $DFO_CONFIG_DIR. It can contain optionally any number of

NO_REFERENCE <RAW_TYPE>

lines for marking those raw types which RAWDISP plots are never considered as reference plots.

Installation

The tool comes as part of the utilPack.

Operational aspects

• Reference plots are only useful for raw types and set-ups that are more or less regularly measured. Health check set-ups and the most frequently used instrument settings should have references, a set-up that was used only once by a user should not.
• Reference plots should be restricted to raw types that are comparable from one measurement to the other. Raw types that produce highly individual raw files like standard star observations or calibrations using science-dependent MOS masks should be de-configured via the NO_REFERENCE mechanism in config.rawdisp.
• Once a set of reference plots for all relevant raw types and set-ups has been created, it is not necessary to update these regularly. An update is normally only necessary when an instrument intervention changed significantly the appearance of the raw files. It is absolutely okay when reference plots are more than a year old, provided that the references are still representative of the current instrument status.