The vimos_ima_dark recipe

vimos_ima_dark

Synopsis

Dark combination for imaging

Description

vimos_ima_dark – VIMOS dark combine recipe.

Combine a list of dark frames into a mean dark frame. Optionally compare the output frame to a reference dark frame

The program accepts the following files in the SOF:

Tag Description DARK A list of raw dark images MASTER_BIAS A master bias frame REFERENCE_DARK Optional reference dark frame MASTER_BPM Optional master bad pixel map or MASTER_CONF Optional master confidence map

If no reference dark frame is made available, then no comparison will be done. This means there will be no output difference image and no stats tableIf neither a master bad pixel map nor confidence map is provided then thestats will be done assuming all pixels are good

Constructor

cpl.Recipe("vimos_ima_dark")

Create an object for the recipe vimos_ima_dark.

import cpl
vimos_ima_dark = cpl.Recipe("vimos_ima_dark")

Parameters

vimos_ima_dark.param.combtype

Combination algorithm (str; default: ‘median’) [default=”median”].

vimos_ima_dark.param.scaletype

Scaling algorithm (str; default: ‘exptime’) [default=”exptime”].

vimos_ima_dark.param.xrej

True if using extra rejection cycle (bool; default: True) [default=True].

vimos_ima_dark.param.thresh

Rejection threshold in sigma above background (float; default: 5.0) [default=5.0].

vimos_ima_dark.param.ncells

Number of cells for diff image stats (int; default: 8) [default=8].

vimos_ima_dark.param.prettynames

Use pretty output file names? (bool; default: False) [default=False].

The following code snippet shows the default settings for the available parameters.

import cpl
vimos_ima_dark = cpl.Recipe("vimos_ima_dark")

vimos_ima_dark.param.combtype = "median"
vimos_ima_dark.param.scaletype = "exptime"
vimos_ima_dark.param.xrej = True
vimos_ima_dark.param.thresh = 5.0
vimos_ima_dark.param.ncells = 8
vimos_ima_dark.param.prettynames = False

You may also set or overwrite some or all parameters by the recipe parameter param, as shown in the following example:

import cpl
vimos_ima_dark = cpl.Recipe("vimos_ima_dark")
[...]
res = vimos_ima_dark( ..., param = {"combtype":"median", "scaletype":"exptime"})

See also

cpl.Recipe for more information about the recipe object.

Bug reports

Please report any problems to Jim Lewis. Alternatively, you may send a report to the ESO User Support Department.