kmos_illumination7

Usage

Overview

This recipe creates the spatial non-uniformity calibration frame needed for all three detectors. It must be called after the kmo_wave_cal-recipe, which generates the spectral calibration frame needed in this recipe. As input at least a sky or flat, a master dark, a master flat and the spatial and spectral calibration frames are required.

The created product, the illumination correction, can be used as input for kmo_std_star and kmo_sci_red.

Input files:

DO CATG Type Explanation Required #Frames
-------- ----- ----------- -------- -------
FLAT_SKY F2D Sky exposures Y 1-n
(at least 3 frames recommended) or FLAT_ON F2D Flat exposures Y 1-n
(at least 3 frames recommended)
MASTER_DARK F2D Master dark Y 1
MASTER_FLAT F2D Master flat Y 1
XCAL F2D x calibration frame Y 1
YCAL F2D y calibration frame Y 1
LCAL F2D Wavelength calib. frame Y 1
WAVE_BAND F2L Table with start-/end-wavelengths Y 1
FLAT_EDGE F2L Table with fitted slitlet edges N 0,1

Output files:

DO CATG Type Explanation
-------- ----- -----------
ILLUM_CORR F2I Illumination calibration frame
If FLAT_EDGE is provided:
SKYFLAT_EDGE F2L Frame containing parameters of fitted
slitlets of all IFUs of all detectors

Options

--used_flat_type <str>

Type (sky/lamp) of input to use: (only if 2 types in input) (str; default: ´sky´). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.used_flat_type [default = sky].

--imethod <str>

Method to use for interpolation: ["NN" (nearest neighbour), "lwNN" (linear weighted nearest neighbor), "swNN" (square weighted nearest neighbor), "MS" (Modified Shepard´s method), "CS" (Cubic spline)] (str; default: ´CS´). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.imethod [default = CS].

--neighborhoodRange <float>

Range (pixels) to search for neighbors (float; default: 1.001). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.neighborhoodRange [default = 1.001].

--range <str>

The spectral ranges to combine when collapsing the reconstructed cubes. e.g. "x1_start,x1_end;x2_start,x2_end" (microns) (str; default: ´´). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.range [default = ].

--flux <bool>

TRUE: Apply flux conservation. FALSE: otherwise (bool; default: False). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.flux [default = False].

--add-all <bool>

FALSE: omit 1st FLAT_SKY frame (acquisition), TRUE: don´t perform any checks, add them all (bool; default: False). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.add-all [default = False].

--pix_scale <float>

Change the pixel scale [arcsec]. Default of 0.2" results into cubes of 14x14pix, a scale of 0.1" results into cubes of 28x28pix, etc. (float; default: 0.2). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.pix_scale [default = 0.2].

--suppress_extension <bool>

Suppress filename extension. (TRUE (apply) or FALSE (don´t apply) (bool; default: False). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.suppress_extension [default = False].

--b_samples <int>

The number of samples in wavelength for the reconstructed cube (int; default: 2048). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.b_samples [default = 2048].

--cmethod <str>

Apply "average", "median", "sum", "min_max." or "ksigma". (str; default: ´ksigma´). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.cmethod [default = ksigma].

--cpos_rej <float>

The positive rejection threshold for kappa-sigma-clipping (sigma). (float; default: 3.0). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.cpos_rej [default = 3.0].

--cneg_rej <float>

The negative rejection threshold for kappa-sigma-clipping (sigma). (float; default: 3.0). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.cneg_rej [default = 3.0].

--citer <int>

The number of iterations for kappa-sigma-clipping. (int; default: 3). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.citer [default = 3].

--cmax <int>

The number of maximum pixel values to clip with min/max-clipping. (int; default: 1). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.cmax [default = 1].

--cmin <int>

The number of minimum pixel values to clip with min/max-clipping. (int; default: 1). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.cmin [default = 1].

--det <int>

Only reduce the specified detector (int; default: 0). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.detector [default = 0].

--angle <float>

Only reduce the specified angle (float; default: 370.0). The full name of this option for the EsoRex configuration file is kmos.kmos_illumination.angle [default = 370.0].

Note that it is possible to create a configuration file containing these options, along with suitable default values. Please refer to the details provided by the 'esorex --help' command.

Version

kmos_illumination 2.1.0