The hawki_dark_combine recipe



HAWKI dark combination recipe


hawki_dark_combine – HAWKI 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 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 or stats table. If neither a bad pixel mask or a master confidence map is specified all stats are done assuming all pixels are good.



Create an object for the recipe hawki_dark_combine.

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



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


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


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


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


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


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

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

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

hawki_dark_combine.param.combtype = "median"
hawki_dark_combine.param.scaletype = "additive"
hawki_dark_combine.param.xrej = True
hawki_dark_combine.param.thresh = 5.0
hawki_dark_combine.param.ncells = 8
hawki_dark_combine.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
hawki_dark_combine = cpl.Recipe("hawki_dark_combine")
res = hawki_dark_combine( ..., param = {"combtype":"median", "scaletype":"additive"})

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.