SYNOPSIS

esorex vmifucalib [OPTIONS] FILE.sof

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.

OPTIONS

--AllowSingleFrames <bool>

Flat fields combination method is ignored. (bool; default: True). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.singleframes [default = True].

--StackMethod <str>

Flat fields combination method. (str; default: \'MinMax\'). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.method [default = MinMax].

--KSigmaLow <float>

Low threshold for K-sigma clipping method. (float; default: 5.0). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.ksigma.low [default = 5.0].

--KSigmaHigh <float>

High threshold for K-sigma clipping method. (float; default: 5.0). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.ksigma.high [default = 5.0].

--MinRejection <long>

Number of lowest rejected values for rejection method. (long; default: 0). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.minmax.minimum [default = 0].

--MaxRejection <long>

Number of highest rejected values for rejection method. (long; default: 1). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.minmax.maximum [default = 1].

--BiasMethod <str>

Bias removal method. (str; default: \'Zmaster\'). The full name of this option for the EsoRex configuration file is vimos.Parameters.bias.removing.method [default = Zmaster].

--CleanBadPixel <bool>

Bad pixel correction on master flat field. (bool; default: False). The full name of this option for the EsoRex configuration file is vimos.Parameters.badpixel.clean [default = False].

--ApplyTransmission <bool>

Apply transmission correction to extracted arc lamp spectra (bool; default: True). The full name of this option for the EsoRex configuration file is vimos.Parameters.apply.transmission [default = True].

--MaxIdsRms <float>

Maximum tolerated RMS of residuals in IDS fit (float; default: 2.0). The full name of this option for the EsoRex configuration file is vimos.Parameters.ids.maxrms [default = 2.0].

--LineIdent <str>

Arc line identification method. (str; default: \'Blind\'). The full name of this option for the EsoRex configuration file is vimos.Parameters.line.ident.method [default = Blind].

--MaxTraceRejection <long>

Maximum percentage of rejected positions in fiber spectra tracing (long; default: 33). The full name of this option for the EsoRex configuration file is vimos.Parameters.trace.failed [default = 33].

--ComputeQC <bool>

Compute QC1 parameters (bool; default: True). The full name of this option for the EsoRex configuration file is vimos.Parameters.quality.enable [default = True].

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.

RELATED TO vmifucalib…

The full documentation for the vimos pipeline can be downloaded as a PDF file using the following URL:

  • ftp://ftp.eso.org/pub/dfs/pipelines/vimos/vimos-pipeline-manual-6.9.pdf

An overview over the existing ESO pipelines can be found on the web page http://www.eso.org/sci/software/pipelines/.

Basic documentation about the EsoRex program can be found at the esorex (1) man page.

It is possible to call the pipelines from python using the python-cpl package. See http://packages.python.org/python-cpl/index.html for further information.

The other recipes of the vimos pipeline are vmifucombinecube(7), vmimflatsky(7), vmspflat(7), vmmosobsstare(7), vmimflatscreen(7), vmimpreimaging(7), vmimcalphot(7), vmmoscombine(7), vmimstandard(7), vmmosobsjitter(7), vmifucombine(7), vmimobsjitter(7), vmspphot(7), vmdet(7), vmmosscience(7), vmmosstandard(7), vmspcaldisp(7), vmifustandard(7), vmbias(7), vmmoscalib(7), vmimobsstare(7), vmdark(7), vmifuscience(7)

VERSION

vmifucalib 2.9.15

AUTHOR

ESO VIMOS Pipeline Team and VIMOS Consortium <[email protected]>

BUG REPORTS

Please report any problems to [email protected] Alternatively, you may send a report to the ESO User Support Department <[email protected]>.

LICENSE

This file is currently part of the VIMOS Instrument Pipeline Copyright (C) 2002-2011 European Southern Observatory

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA