Provided by: cpl-plugin-vimos-doc_2.9.9+dfsg-2_all bug

NAME

       vmspcaldisp - Determine spectral distortion models from flat field and arc lamp exposure.

SYNOPSIS

       esorex vmspcaldisp [OPTIONS] FILE.sof

DESCRIPTION

       This  recipe is used to determine all the spectral distortions and transformations from an
       arc lamp exposure and a master flat field produced by the recipe vmspflat.

       Input files:

         DO category:               Type:       Explanation:         Required:
         MOS_ARC_SPECTRUM           Raw         Arc lamp exposure       Y
         MASTER_BIAS                Calib       Master bias             Y
         MASTER_DARK                Calib       Master dark             .

         MOS_MASTER_SCREEN_FLAT     Calib       Normalised flat field   .

         MOS_COMBINED_SCREEN_FLAT   Calib       Combined flat field     .

         GRISM_TABLE                Calib       Grism table             Y
         LINE_CATALOG               Calib       Line catalog            Y
         EXTRACT_TABLE              Calib       Extraction table        .

         CCD_TABLE                  Calib       Bad pixel table         .

       Output files:

         DO category:               Data type:  Explanation:
         EXTRACT_TABLE              FITS table  Extraction table
         MOS_ARC_SPECTRUM_EXTRACTED FITS image  Sky subtracted slit spectra
         (none)                     PAF         Distortion models

       At least one raw arc lamp exposure should be present in the input SOF.

       The normalised and the combined flat fields are the products of the recipe vmspflat run on
       flat field data obtained with the same mask.

       Neither  of  them is required for running vmspcaldisp, but if a combined flat field is not
       given then no spectral curvature model can be computed, and a first-guess is used  in  its
       place.  A  normalised  master  flat  field  needs  to  be  specified  only if a flat field
       correction is requested.

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

       An extraction table generated from previous runs might be input to the recipe, in order to
       iterate the modeling of the spectral distortions.

       The  grism  table  contains necessary information to control the way spectra are extracted
       and the determination of the distortion models.

       The vmspcaldisp 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). Other parameters, used in the construction of the extracted arc lamp slit
       spectra, are the start and the end  wavelength  of  the  image  containing  the  extracted
       spectra  (header  entries  PRO  WLEN START and PRO WLEN END), and the step of the sampling
       along the dispersion direction (header entry PRO WLEN INC).

       The primary recipe product is the extraction table, that contains  information  about  the
       local modelling of spectral distortions.

       A secondary product of the vmspcaldisp recipe is the image of extracted slit spectra, that
       allows a visual check of the distortion models quality. A last product  is  the  PAF  file
       carrying  all the information related to the spectral distortions. This PAF file is copied
       (or moved) to the product directory, and it is identical to  the  IWS  configuration  file
       MOS_wavecal_G_Q.cmf  where  Q  indicates  the VIMOS quadrant number, and G the grism name)
       that is created in the directory where vmspcaldisp is launched.

OPTIONS

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

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

       --RefineIDS <bool>
              Refine Inverse Dispersion Solution. (bool; default: False). The full name  of  this
              option  for the EsoRex configuration file is vimos.Parameters.ids.refine [default =
              False].

       --ExtractionWindow <long>
              Size of search window around expected arc line positions. (long; default: 10).  The
              full    name    of   this   option   for   the   EsoRex   configuration   file   is
              vimos.Parameters.extraction.window [default = 10].

       --ApplyFlatField <bool>
              Flat field correction for input arc lamp frames. (bool; default: False).  The  full
              name    of    this    option    for    the    EsoRex    configuration    file    is
              vimos.Parameters.flat.apply [default = False].

       --CleanBadPixel <bool>
              Bad pixel correction on arc lamp image. (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 in arc lamp image. (bool; default: False). The full name
              of  this option for the EsoRex configuration file is vimos.Parameters.cosmics.clean
              [default = False].

       --LineIdent <str>
              Arc line identification method. (str; default: ´FirstGuess´). The full name of this
              option  for  the  EsoRex  configuration  file is vimos.Parameters.line.ident.method
              [default = FirstGuess].

       --LineIdentLevel <float>
              Threshold for peak detection. (float; default: 500.0). The full name of this option
              for  the  EsoRex configuration file is vimos.Parameters.line.ident.level [default =
              500.0].

       --ArcExtraction <str>
              Arc lamp 2D extraction according to computed Local or Global IDS.   (str;  default:
              ´Local´).  The  full  name  of  this  option  for  the EsoRex configuration file is
              vimos.Parameters.extraction [default = Local].

       --ModelSlit <bool>
              Model wavelength solution within each slit. (bool; default: True). The full name of
              this  option  for  the  EsoRex  configuration  file  is vimos.Parameters.slit.model
              [default = True].

       --ModelSlitOrder <long>
              Order of polynomial for wavelength solution  modeling  within  each  slit.   (long;
              default:  0).  The  full  name  of this option for the EsoRex configuration file is
              vimos.Parameters.slit.order [default = 0].

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

SEE ALSO

       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),   vmifucalib(7),
       vmimflatsky(7),   vmspflat(7),   vmmosobsstare(7),  vmimflatscreen(7),  vmimpreimaging(7),
       vmimcalphot(7),  vmmoscombine(7),  vmimstandard(7),  vmmosobsjitter(7),   vmimobsstare(7),
       vmimobsjitter(7),     vmspphot(7),     vmdet(7),     vmmosscience(7),    vmmosstandard(7),
       vmifustandard(7), vmbias(7), vmmoscalib(7), vmifucombine(7), vmdark(7), vmifuscience(7)

VERSION

       vmspcaldisp 2.9.9

AUTHOR

       ESO VIMOS Pipeline Team and VIMOS Consortium <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  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