SYNOPSIS

esorex vmspflat [OPTIONS] FILE.sof

DESCRIPTION

This recipe is used to create the MOS normalised master flat field from a set of MOS flat field exposures. A _not_ normalised master flat field is also required by the recipe vmspcaldisp to determine the spectral curvature model. The recipe vmspflat does compute its own curvature model, but this is generally incompatible with the wavelength calibration and the optical distortion models computed by vmspcaldisp. For this reason this curvature model is just used internally in the process of flat field normalisation, where the compatibility with the Y component of the optical distortion model is irrelevant.

Input files:

  DO category:               Type:       Explanation:         Required:
  MOS_SCREEN_FLAT            Raw         Flat field exposures    Y
  MASTER_BIAS                Calib       Master bias             Y
  MASTER_DARK                Calib       Master dark             .

  GRISM_TABLE                Calib       Grism table             Y
  CCD_TABLE                  Calib       Bad pixel table         .

Output files:

  DO category:               Data type:  Explanation:
  MOS_MASTER_SCREEN_FLAT     FITS image  Master flat field
  MOS_COMBINED_SCREEN_FLAT   FITS image  Combined flat field
  (none)                     PAF         Distortion models

At least one raw flat field exposure should be present in the input SOF. The acquisition of input flat fields may be done using different mask shutter settings (to avoid contamination between different spectral orders in LR grisms used with multiplexed masks. The vmspflat recipe will properly combine all the input frames according to a specified method.

The bad pixel table needs to be specified only if the cleaning of bad pixels is requested.

The grism table contains necessary information to control the way spectra are extracted, and the determination of the spectral distortion models. The vmspflat recipe gets from the grism table the wavelength that should be used as reference (header entry PRO WLEN CEN), and the spectrum extension in CCD pixels above and below the position of the reference wavelength (header entries PRO SPECT LLEN LO and PRO SPECT LLEN HI).

The PAF file just contains the curvature and the optical distortion models computed in the process of spectra normalisation. Such models are available just for debug purposes, and are not to be used in further data reduction steps.

OPTIONS

--AllowSingleFrames <bool>

Frame 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].

--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].

--StackMethod <str>

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

--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: 1). The full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.minmax.minimum [default = 1].

--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].

--Fuzz <long>

Extra pixels from expected position of spectrum edge in spectral extraction. (long; default: 5). The full name of this option for the EsoRex configuration file is vimos.Parameters.extraction.fuzz [default = 5].

--FlatMethod <str>

Flat field trends removal method. (str; default: 'Median'). The full name of this option for the EsoRex configuration file is vimos.Parameters.flat.removing.trend [default = Median].

--PolyOrderX <long>

Degree of polynomial used for fitting the flat spectrum along X. (long; default: 3). The full name of this option for the EsoRex configuration file is vimos.Parameters.flat.removing.orderx [default = 3].

--PolyOrderY <long>

Degree of polynomial used for fitting the flat spectrum along Y. (long; default: 8). The full name of this option for the EsoRex configuration file is vimos.Parameters.flat.removing.ordery [default = 8].

--SmoothBoxSize <long>

Size of running box used for smoothing along the dispersion direction (currently unused). (long; default: 11). The full name of this option for the EsoRex configuration file is vimos.Parameters.flat.removing.boxsize [default = 11].

--CleanBadPixel <bool>

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

--CleanCosmic <bool>

Cosmic ray events cleaning from raw flats. (bool; default: False). The full name of this option for the EsoRex configuration file is vimos.Parameters.cosmics.clean [default = False].

--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.

VERSION

vmspflat 3.1.6

AUTHOR

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

LICENSE

This file is part of the VIMOS Instrument Pipeline Copyright (C) 2002-2005 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