Provided by: cpl-plugin-fors-doc_5.3.32+dfsg-1_all bug

NAME

       fors_pmos_calib - Determination of the extraction mask

SYNOPSIS

       esorex fors_pmos_calib [OPTIONS] FILE.sof

DESCRIPTION

       This  recipe is used to identify reference lines on PMOS arc lamp exposures, and trace the
       spectral edges on the corresponding flat field exposures.  This  information  is  used  to
       determine  the  spectral  extraction  mask to be applied in the scientific data reduction,
       performed with the recipe fors_science.

       This recipe accepts both FORS1 and FORS2 frames.  The  input  arc  lamps  and  flat  field
       exposures are assumed to be obtained quasi-simultaneously, so that they would be described
       by exactly the same instrument distortions.

       A line catalog must be specified, containing the wavelengths of  the  reference  arc  lamp
       lines  used  for  the  wavelength  calibration.  A grism table (typically depending on the
       instrument mode, and in particular on the grism used) may also be  specified:  this  table
       contains a default recipe parameter setting to control the way spectra are extracted for a
       specific instrument mode, as it is used for automatic run of the pipeline on  Paranal  and
       in  Garching.  If  this  table  is  specified, it will modify the default recipe parameter
       setting, with the exception of those parameters which have been explicitly modifyed on the
       command line.

       If  a grism table is not specified, the input recipe parameters values will always be read
       from the command line, or from an esorex configuration file  if  present,  or  from  their
       generic  default  values (that are rarely meaningful). Finally a master bias frame must be
       input to this recipe.

       The products SPECTRA_DETECTION_PMOS,  SLIT_MAP_PMOS,  and  DISP_RESIDUALS_PMOS,  are  just
       created if the --check parameter is set to true.

       The  MASTER_DISTORTION_TABLE  is  marked  as  required, but it is not so if all slits have
       different offsets, and in the case of FORS1 observations made  with  the  old  TK2048EB4-1
       1604 chip read in windowed mode (2048x400)

       Input files:

         DO category:              Type:       Explanation:          Required:
         SCREEN_FLAT_PMOS          Raw         Flat field exposures     Y
         LAMP_PMOS                 Raw         Arc lamp exposure        Y
         MASTER_BIAS or BIAS       Calib       Bias frame               Y
         MASTER_LINECAT            Calib       Line catalog             Y
         GRISM_TABLE               Calib       Grism table              .

         MASTER_DISTORTION_TABLE   Calib       Master distortions table Y

       Output files:

         DO category:              Data type:  Explanation:
         MASTER_SCREEN_FLAT_PMOS   FITS image  Combined (sum) flat field
         MASTER_NORM_FLAT_PMOS     FITS image  Normalised flat field
         MAPPED_SCREEN_FLAT_PMOS   FITS image  Wavelength calibrated flat field
         MAPPED_NORM_FLAT_PMOS     FITS image  Wavelength calibrated normalised flat
         REDUCED_LAMP_PMOS         FITS image  Wavelength calibrated arc spectrum
         DISP_COEFF_PMOS           FITS table  Inverse dispersion coefficients
         DISP_RESIDUALS_PMOS       FITS image  Residuals in wavelength calibration
         DISP_RESIDUALS_TABLE_PMOS FITS table  Residuals in wavelength calibration
         DELTA_IMAGE_PMOS          FITS image  Offset vs linear wavelength calib
         WAVELENGTH_MAP_PMOS       FITS image  Wavelength for each pixel on CCD
         SPECTRA_DETECTION_PMOS    FITS image  Check for preliminary detection
         SLIT_MAP_PMOS             FITS image  Map of central wavelength on CCD
         CURV_TRACES_PMOS          FITS table  Spectral curvature traces
         CURV_COEFF_PMOS           FITS table  Spectral curvature coefficients
         SPATIAL_MAP_PMOS          FITS image  Spatial position along slit on CCD
         SPECTRAL_RESOLUTION_PMOS  FITS table  Resolution at reference arc lines
         SLIT_LOCATION_PMOS        FITS table  Slits on product frames and CCD

OPTIONS

       --dispersion <float>
              Expected  spectral dispersion (Angstrom/pixel) (float; default: 0.0). The full name
              of this option for the EsoRex configuration file is fors.fors_pmos_calib.dispersion
              [default = 0.0].

       --peakdetection <float>
              Initial peak detection threshold (ADU) (float; default: 0.0). The full name of this
              option for the  EsoRex  configuration  file  is  fors.fors_pmos_calib.peakdetection
              [default = 0.0].

       --wdegree <int>
              Degree  of  wavelength  calibration  polynomial (int; default: 0). The full name of
              this option for  the  EsoRex  configuration  file  is  fors.fors_pmos_calib.wdegree
              [default = 0].

       --wradius <int>
              Search  radius if iterating pattern-matching with first-guess method (int; default:
              4).  The  full  name  of  this  option  for  the  EsoRex  configuration   file   is
              fors.fors_pmos_calib.wradius [default = 4].

       --wreject <float>
              Rejection  threshold  in dispersion relation fit (pixel) (float; default: 0.7). The
              full   name   of   this   option   for   the   EsoRex   configuration    file    is
              fors.fors_pmos_calib.wreject [default = 0.7].

       --wcolumn <str>
              Name of line catalog table column with wavelengths (str; default: ´WLEN´). The full
              name    of    this    option    for    the    EsoRex    configuration    file    is
              fors.fors_pmos_calib.wcolumn [default = WLEN].

       --cdegree <int>
              Degree  of  spectral  curvature polynomial (int; default: 0). The full name of this
              option for the EsoRex configuration file is fors.fors_pmos_calib.cdegree [default =
              0].

       --cmode <int>
              Interpolation  mode of curvature solution (0 = no interpolation, 1 = fill gaps, 2 =
              global model) (int; default: 1). The full  name  of  this  option  for  the  EsoRex
              configuration file is fors.fors_pmos_calib.cmode [default = 1].

       --startwavelength <float>
              Start  wavelength  in  spectral  extraction (float; default: 0.0). The full name of
              this      option      for      the      EsoRex      configuration      file      is
              fors.fors_pmos_calib.startwavelength [default = 0.0].

       --endwavelength <float>
              End  wavelength in spectral extraction (float; default: 0.0). The full name of this
              option for the  EsoRex  configuration  file  is  fors.fors_pmos_calib.endwavelength
              [default = 0.0].

       --stack_method <str>
              Frames  combination  method (str; default: ´average´). The full name of this option
              for the EsoRex configuration file is fors.fors_pmos_calib.stack_method  [default  =
              average].

       --minrejection <int>
              Number  of  lowest  values  to be rejected (int; default: 1). The full name of this
              option for  the  EsoRex  configuration  file  is  fors.fors_pmos_calib.minrejection
              [default = 1].

       --maxrejection <int>
              Number  of  highest  values to be rejected (int; default: 1). The full name of this
              option for  the  EsoRex  configuration  file  is  fors.fors_pmos_calib.maxrejection
              [default = 1].

       --klow <float>
              Low  threshold in ksigma method (float; default: 3.0). The full name of this option
              for the EsoRex configuration file is fors.fors_pmos_calib.klow [default = 3.0].

       --khigh <float>
              High threshold in ksigma method (float; default: 3.0). The full name of this option
              for the EsoRex configuration file is fors.fors_pmos_calib.khigh [default = 3.0].

       --kiter <int>
              Max  number  of  iterations  in ksigma method (int; default: 999). The full name of
              this  option  for  the  EsoRex  configuration  file  is  fors.fors_pmos_calib.kiter
              [default = 999].

       --ddegree <int>
              Degree  of  flat field fitting polynomial along dispersion direction (int; default:
              -1).  The  full  name  of  this  option  for  the  EsoRex  configuration  file   is
              fors.fors_pmos_calib.ddegree [default = -1].

       --dradius <int>
              Smooth box radius for flat field along dispersion direction (int; default: 10). The
              full   name   of   this   option   for   the   EsoRex   configuration    file    is
              fors.fors_pmos_calib.dradius [default = 10].

       --qc <bool>
              Compute  QC1 parameters (bool; default: True). The full name of this option for the
              EsoRex configuration file is fors.fors_pmos_calib.qc [default = True].

       --check <bool>
              Create intermediate products (bool; default: False). The full name of  this  option
              for the EsoRex configuration file is fors.fors_pmos_calib.check [default = False].

       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.

SEE ALSO

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

              ftp://ftp.eso.org/pub/dfs/pipelines/fors/fors-pipeline-manual-4.9.pdf

       An  overview  over  the  existing  ESO  pipelines  can  be   found   on   the   web   page
       https://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
       https://packages.python.org/python-cpl/index.html for further information.

       The other recipes of  the  fors  pipeline  are  fors_align_sky(7),  fors_align_sky_lss(7),
       fors_bias(7),   fors_calib(7),   fors_config(7),   fors_dark(7),   fors_detect_objects(7),
       fors_detect_spectra(7), fors_extract(7),  fors_extract_objects(7),  fors_extract_slits(7),
       fors_flatfield(7),   fors_img_science(7),  fors_img_screen_flat(7),  fors_img_sky_flat(7),
       fors_normalise_flat(7),  fors_photometry(7),  fors_pmos_extract(7),  fors_pmos_science(7),
       fors_remove_bias(7),      fors_resample(7),      fors_science(7),      fors_spec_mflat(7),
       fors_subtract_sky(7),   fors_subtract_sky_lss(7),   fors_sumflux(7),   fors_trace_flat(7),
       fors_wave_calib(7), fors_wave_calib_lss(7), fors_zeropoint(7)

VERSION

       fors_pmos_calib 5.3.32

AUTHOR

       Carlo Izzo <usd-help@eso.org>

BUG REPORTS

       Please  report  any  problems to usd-help@eso.org. Alternatively, you may send a report to
       the ESO User Support Department <usd-help@eso.org>.

LICENSE

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