Table Of Contents

Previous topic

The KMOS 1.3.1 pipeline

Next topic

The kmo_flat recipe

This Page

The kmo_dark recipe

kmo_dark

Synopsis

Create master dark frame & bad pixel mask

Description

This recipe calculates the master dark frame.

It is recommended to provide three or more dark exposures to produce a reasonable master with associated noise.

Input files

DO CATG          Type   Explanation                     Required #Frames
-------          -----  -----------                     -------- -------
DARK             RAW    Dark exposures                     Y       1-n
                        (at least 3 frames recommended)

Output files

DO CATG          Type   Explanation
-------          -----  -----------
MASTER_DARK      F2D    Calculated master dark frames
BADPIXEL_DARK    B2D    Associated badpixel frames

Constructor

cpl.Recipe("kmo_dark")

Create an object for the recipe kmo_dark.

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

Parameters

kmo_dark.param.pos_bad_pix_rej

The positive rejection threshold for bad pixels (float; default: 50.0) [default=50.0].

kmo_dark.param.neg_bad_pix_rej

The negative rejection threshold for bad pixels (float; default: 50.0) [default=50.0].

kmo_dark.param.file_extension

Controls if EXPTIME should be appended to product filenames (bool; default: False) [default=False].

kmo_dark.param.cmethod

Apply “average”, “median”, “sum”, “min_max.” or “ksigma”. (str; default: ‘ksigma’) [default=”ksigma”].

kmo_dark.param.cpos_rej

The positive rejection threshold for kappa-sigma-clipping (sigma). (float; default: 3.0) [default=3.0].

kmo_dark.param.cneg_rej

The negative rejection threshold for kappa-sigma-clipping (sigma). (float; default: 3.0) [default=3.0].

kmo_dark.param.citer

The number of iterations for kappa-sigma-clipping. (long; default: 3) [default=3].

kmo_dark.param.cmax

The number of maximum pixel values to clip with min/max-clipping. (long; default: 1) [default=1].

kmo_dark.param.cmin

The number of minimum pixel values to clip with min/max-clipping. (long; default: 1) [default=1].

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

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

kmo_dark.param.pos_bad_pix_rej = 50.0
kmo_dark.param.neg_bad_pix_rej = 50.0
kmo_dark.param.file_extension = False
kmo_dark.param.cmethod = "ksigma"
kmo_dark.param.cpos_rej = 3.0
kmo_dark.param.cneg_rej = 3.0
kmo_dark.param.citer = 3
kmo_dark.param.cmax = 1
kmo_dark.param.cmin = 1

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

import cpl
kmo_dark = cpl.Recipe("kmo_dark")
[...]
res = kmo_dark( ..., param = {"pos_bad_pix_rej":50.0, "neg_bad_pix_rej":50.0})

See also

cpl.Recipe for more information about the recipe object.

Bug reports

Please report any problems to Alex Agudo Berbel. Alternatively, you may send a report to the ESO User Support Department.