The kmo_make_image recipe

kmo_make_image

Synopsis

Collapse a cube to create a spatial image

Description

This recipe collapses a cube along the spectral axis using rejection. By default all spectral slices are averaged.

Errors are propagated for the same spectral ranges as for the input data if a noise map is provided.

Input files

DO CATG           Type   Explanation                    Required #Frames
-------           -----  -----------                    -------- -------
<none or any>     F3I    data frame                         Y       1
<none or any>     F1S    OH line spectrum                   N      0,1

Output files

DO CATG           Type   Explanation
-------           -----  -----------
MAKE_IMAGE        F2I    Collapsed data cubes

Constructor

cpl.Recipe("kmo_make_image")

Create an object for the recipe kmo_make_image.

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

Parameters

kmo_make_image.param.range

The spectral ranges to combine. e.g.”x1_start,x1_end;x2_start,x2_end” (microns) (str; default: ‘’) [default=”“].

kmo_make_image.param.threshold

The OH threshold level (%) (float; default: 0.1) [default=0.1].

kmo_make_image.param.cmethod

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

kmo_make_image.param.cpos_rej

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

kmo_make_image.param.cneg_rej

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

kmo_make_image.param.citer

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

kmo_make_image.param.cmax

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

kmo_make_image.param.cmin

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

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

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

kmo_make_image.param.range = ""
kmo_make_image.param.threshold = 0.1
kmo_make_image.param.cmethod = "ksigma"
kmo_make_image.param.cpos_rej = 3.0
kmo_make_image.param.cneg_rej = 3.0
kmo_make_image.param.citer = 3
kmo_make_image.param.cmax = 1
kmo_make_image.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_make_image = cpl.Recipe("kmo_make_image")
[...]
res = kmo_make_image( ..., param = {"range":"", "threshold":0.1})

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.