The vmifucalib recipe

vmifucalib

Synopsis

Generate IFU calibrations from a set of flat and arc lamp exposures.

Description

This recipe produces the extraction mask, the wavelength calibration, and the relative transmission correction, from a set of flat field and one arc lamp exposures (IFU mode).

Input files

DO category:                 Type:       Explanation:       Required:
IFU_SCREEN_FLAT              Raw         Flat field            Y
IFU_ARC_SPECTRUM             Raw         Arc spectrum          .

LINE_CATALOG                 Calib       Arc line catalog      .

MASTER_BIAS                  Calib       Master bias           Y
IFU_IDENT                    Calib       Fiber identification  .

CCD_TABLE                    Calib       Bad pixel table       .

Output files

DO category:                 Data type:  Explanation:
IFU_MASTER_SCREEN_FLAT       FITS image  Stack of all raw flat fields
IFU_ARC_SPECTRUM_EXTRACTED   FITS image  Extracted arc spectra
IFU_FLAT_SPECTRUM_EXTRACTED  FITS image  Extracted flat field spectra
IFU_TRACE                    FITS table  Extraction mask
IFU_IDS                      FITS table  Wavelength calibration
IFU_TRANSMISSION             FITS table  Transmission correction

An arc spectrum exposure may not be specified in input, but in that case no wavelength calibration nor fiber relative transmission correction will be computed, and further reduction of associated scientific data will not be possible; the only products in this case will be the stack of all the input raw flat field exposures, and the extraction mask. If the arc spectrum exposure is specified in input, then also a line catalog must be given. The fiber identification table, if given, ensures that all spectra will be safely identified and assigned to the correct spatial position, but in most cases it will be possible to reduce the data even without specifying this table in the input SOF. A CCD table must be specified only if a bad pixel cleaning is requested.

For more details, please refer to the VIMOS Pipeline User’s Guide.

Constructor

cpl.Recipe("vmifucalib")

Create an object for the recipe vmifucalib.

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

Parameters

vmifucalib.param.AllowSingleFrames

Flat fields combination method is ignored. (bool; default: True) [default=True].

vmifucalib.param.StackMethod

Flat fields combination method. (str; default: ‘MinMax’) [default=”MinMax”].

vmifucalib.param.KSigmaLow

Low threshold for K-sigma clipping method. (float; default: 5.0) [default=5.0].

vmifucalib.param.KSigmaHigh

High threshold for K-sigma clipping method. (float; default: 5.0) [default=5.0].

vmifucalib.param.MinRejection

Number of lowest rejected values for rejection method. (int; default: 0) [default=0].

vmifucalib.param.MaxRejection

Number of highest rejected values for rejection method. (int; default: 1) [default=1].

vmifucalib.param.BiasMethod

Bias removal method. (str; default: ‘Zmaster’) [default=”Zmaster”].

vmifucalib.param.CleanBadPixel

Bad pixel correction on master flat field. (bool; default: False) [default=False].

vmifucalib.param.ApplyTransmission

Apply transmission correction to extracted arc lamp spectra (bool; default: True) [default=True].

vmifucalib.param.MaxIdsRms

Maximum tolerated RMS of residuals in IDS fit (float; default: 2.0) [default=2.0].

vmifucalib.param.LineIdent

Arc line identification method. (str; default: ‘Blind’) [default=”Blind”].

vmifucalib.param.MaxTraceRejection

Maximum percentage of rejected positions in fiber spectra tracing (int; default: 33) [default=33].

vmifucalib.param.ComputeQC

Compute QC1 parameters (bool; default: True) [default=True].

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

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

vmifucalib.param.AllowSingleFrames = True
vmifucalib.param.StackMethod = "MinMax"
vmifucalib.param.KSigmaLow = 5.0
vmifucalib.param.KSigmaHigh = 5.0
vmifucalib.param.MinRejection = 0
vmifucalib.param.MaxRejection = 1
vmifucalib.param.BiasMethod = "Zmaster"
vmifucalib.param.CleanBadPixel = False
vmifucalib.param.ApplyTransmission = True
vmifucalib.param.MaxIdsRms = 2.0
vmifucalib.param.LineIdent = "Blind"
vmifucalib.param.MaxTraceRejection = 33
vmifucalib.param.ComputeQC = True

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

import cpl
vmifucalib = cpl.Recipe("vmifucalib")
[...]
res = vmifucalib( ..., param = {"AllowSingleFrames":True, "StackMethod":"MinMax"})

See also

cpl.Recipe for more information about the recipe object.

Bug reports

Please report any problems to ESO VIMOS Pipeline Team and VIMOS Consortium. Alternatively, you may send a report to the ESO User Support Department.