The gimasterbias recipe

gimasterbias

Synopsis

Creates a master bias image from a set of raw biases.

Description

For detailed information please refer to the GIRAFFE pipeline user manual.

It is available at http://www.eso.org/pipelines.

Constructor

cpl.Recipe("gimasterbias")

Create an object for the recipe gimasterbias.

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

Parameters

gimasterbias.param.stack_method

Stacking method: average, median, minmax or ksigma (str; default: ‘average’) [default=”average”].

gimasterbias.param.stack_ksigmalow

Lower threshold multiplier for method ksigma (float; default: 5.0) [default=5.0].

gimasterbias.param.stack_ksigmahigh

Upper threshold multiplier for method ksigma (float; default: 5.0) [default=5.0].

gimasterbias.param.stack_minreject

Minimum rejection level for method minmax (int; default: 1) [default=1].

gimasterbias.param.stack_maxreject

Maximum rejection level for method minmax (int; default: 1) [default=1].

gimasterbias.param.mbias_oscremove

Remove pre- and over-scan regions from the created master bias image. (bool; default: False) [default=False].

gimasterbias.param.mbias_bpxclean

Correct master bias image for bad pixels (bool; default: False) [default=False].

gimasterbias.param.bpm_create

Create bad pixel map using a simple thresholding algorithm. (temporary!) (bool; default: True) [default=True].

gimasterbias.param.bpm_factor

Readout noise multiplier defining the valid range of pixel values for searching bad pixels. (float; default: 5.0) [default=5.0].

gimasterbias.param.bpm_frac

Maximum fraction of pixels which may be flagged as ‘bad. If more pixels are found to be ‘bad a warning is issued. (float; default: 0.15) [default=0.15].

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

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

gimasterbias.param.stack_method = "average"
gimasterbias.param.stack_ksigmalow = 5.0
gimasterbias.param.stack_ksigmahigh = 5.0
gimasterbias.param.stack_minreject = 1
gimasterbias.param.stack_maxreject = 1
gimasterbias.param.mbias_oscremove = False
gimasterbias.param.mbias_bpxclean = False
gimasterbias.param.bpm_create = True
gimasterbias.param.bpm_factor = 5.0
gimasterbias.param.bpm_frac = 0.15

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

import cpl
gimasterbias = cpl.Recipe("gimasterbias")
[...]
res = gimasterbias( ..., param = {"stack_method":"average", "stack_ksigmalow":5.0})

See also

cpl.Recipe for more information about the recipe object.

Bug reports

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