Provided by: cpl-plugin-sinfo-doc_3.0.0+dfsg-1_all bug

NAME

       sinfo_rec_wavecal - Wavelength calibration and slitpos determination

SYNOPSIS

       esorex sinfo_rec_wavecal [OPTIONS] FILE.sof

DESCRIPTION

       This recipe performs wavelength calibration.

       The  input  files  are  on/off arc lamp frames with tag WAVE_LAMP Master calibration frame
       input  is:  A  corresponding  (band)  reference  line  table  with  tag   REF_LINE_ARC   A
       corresponding  (band) distortion table with tag DISTORTION A corresponding (band,preoptic)
       master flat with tag MASTER_FLAT_LAMP A corresponding (band,preoptics)  master  bad  pixel
       map  with  tag  MASTER_BP_MAP  If wcal-estimate_ind=TRUE, a corresponding (band,preoptics)
       slitlet position guess table SLIT_POS_GUESS (for example a copy of the  SLIT_POS  product)
       If wcal-calib_indicator=FALSE, a corresponding (band,preoptics) parabolic fit coefficients
       table        WAVE_COEF_SLIT        If        sinfoni.wavecal.slitpos_boostrap_switch=FALSE
       (wcal-calib-slitpos_bootstrap=0), a corresponding (band,preoptics) slitlets position table
       with tag SLIT_POS The main products are: The master flat field corrected  for  distortions
       (PRO.CATG=MFLAT_STACKED_DIST) The arc lamp frames stacked (PRO.CATG=WAVE_LAMP_STACKED) The
       wavelength map  (PRO.CATG=WAVE_MAP)  The  slitlet  position  table  (PRO.CATG=SLIT_POS)  A
       parabolic fit coefficients table (PRO.CATG=WAVE_COEF_SLIT) Parameters relative to arc lamp
       line fit: (PRO.CATG=WAVE_FIT_PARAMS)

OPTIONS

       --gen-overpar <bool>
              Overwrite DRS ini parameters:  (bool; default: True). The full name of this  option
              for  the EsoRex configuration file is sinfoni.general.overwrite_parameters [default
              = True].

       --lc_sw <bool>
              Correct for bad lines introduced by instrument software:  (bool;  default:  False).
              The   full   name   of   this   option   for   the  EsoRex  configuration  file  is
              sinfoni.general.lc_sw [default = False].

       --lc_kappa <long>
              Kappa sigma value (long; default: 18). The full name of this option for the  EsoRex
              configuration file is sinfoni.general.lc_kappa [default = 18].

       --lc_filt_rad <long>
              Filtering  radii  applied during median filter. Should be small (long; default: 3).
              The  full  name  of  this   option   for   the   EsoRex   configuration   file   is
              sinfoni.general.lc_filt_rad [default = 3].

       --product-density <long>
              Density   of   pipeline   products:   0   (low),  1  (low+skycor),  2  (med-QC),  3
              (high-debug+skycor) (long; default: 2). The full name of this option for the EsoRex
              configuration file is sinfoni.product.density [default = 2].

       --stack-lo_rej <float>
              lower  rejection (float; default: 0.1). The full name of this option for the EsoRex
              configuration file is sinfoni.stacked.low_rejection [default = 0.1].

       --stack-hi_rej <float>
              higher rejection (float; default: 0.1). The full name of this option for the EsoRex
              configuration file is sinfoni.stacked.high_rejection [default = 0.1].

       --stack-flat_ind <bool>
              Flat  Index:   (bool;  default:  True). The full name of this option for the EsoRex
              configuration file is sinfoni.stacked.flat_index [default = True].

       --stack-mflat_norm_smooth <long>
              Normalize master flat to its smoothed value (to remove lamp response curve). 0  (no
              smooth).  1  (apply  fft  filter  along y).2 (apply running median filter along y).
              (long; default: 0). The full name of this option for the EsoRex configuration  file
              is sinfoni.stacked.mflat_norm_smooth [default = 0].

       --stack-mflat_smooth_rad <long>
              Normalization  smoothing  radii   (long; default: 16). The full name of this option
              for the EsoRex configuration file is  sinfoni.stacked.mflat_smooth_rad  [default  =
              16].

       --stack-mask_ind <long>
              BP Mask Interpolation Switch: indicates if the bad pixel mask should be applied (1)
              or not (0)  (long; default: 1). The  full  name  of  this  option  for  the  EsoRex
              configuration file is sinfoni.stacked.mask_index [default = 1].

       --stack-ind_ind <bool>
              indicates  if  the bad pixels should be indicated (yes) or interpolated (no) (bool;
              default: False). The full name of this option for the EsoRex configuration file  is
              sinfoni.stacked.ind_index [default = False].

       --stack-mask_rad <long>
              Max  distance  bad-good  pix:  (long; default: 4). The full name of this option for
              the EsoRex configuration file is sinfoni.stacked.mask_rad [default = 4].

       --stack-gauss_ind <bool>
              Gaussian Convolution Switch:  (bool; default: False). The full name of this  option
              for the EsoRex configuration file is sinfoni.stacked.gauss_index [default = False].

       --stack-khw <long>
              Kernel  Half  Width (long; default: 2). The full name of this option for the EsoRex
              configuration file is sinfoni.stacked.kernel_half_width [default = 2].

       --stack-warpfix_ind <bool>
              Warp Fix Index:  (bool; default: True). The full name of this option for the EsoRex
              configuration file is sinfoni.stacked.warpfix_ind [default = True].

       --stack-warpfix_kernel <str>
              Warpfix  kernel:   (str;  default:  ´tanh´).  The  full name of this option for the
              EsoRex configuration file is sinfoni.stacked.warpfix_kernel [default = tanh].

       --stack-qc_thresh_min <long>
              qc_thresh_min (long; default: 0). The full name  of  this  option  for  the  EsoRex
              configuration file is sinfoni.stacked.qc_thresh_min [default = 0].

       --stack-qc_thresh_max <long>
              qc_thresh_max  (long;  default: 49000). The full name of this option for the EsoRex
              configuration file is sinfoni.stacked.qc_thresh_max [default = 49000].

       --stack-sub_raw_sky <bool>
              indicates if the raw sky frame  should  be  subtracted  (TRUE)  or  (FALSE)  (bool;
              default:  True).  The full name of this option for the EsoRex configuration file is
              sinfoni.stacked.sub_raw_sky [default = True].

       --wcal-slitpos_bootstrap <bool>
              Switch to get a new slitpos without a reference:  (bool; default: False). The  full
              name    of    this    option    for    the    EsoRex    configuration    file    is
              sinfoni.wavecal.slitpos_boostrap [default = False].

       --wcal-calib_indicator <bool>
              Calib Indicator: FALSE: if the dispersion relation is already  known,  the  routine
              can  jump  to the sinfo_waveMap section TRUE: if the dispersion relation must first
              be determined (bool; default: True). The full name of this option  for  the  EsoRex
              configuration file is sinfoni.wavecal.calib_indicator [default = True].

       --wcal-min_diff <float>
              Minimum Of Difference: minimum difference of mean and sinfo_median column intensity
              to carry out the cross sinfo_correlation (float; default: 1.0). The  full  name  of
              this  option for the EsoRex configuration file is sinfoni.wavecal.min_diff [default
              = 1.0].

       --wcal-hw <long>
              Half Width: half width of a box  within  which  the  line  must  be  placed  (long;
              default:  7).  The  full  name  of this option for the EsoRex configuration file is
              sinfoni.wavecal.half_width [default = 7].

       --wcal-sigma <float>
              Sigma: sigma of Gaussian which is convolved with the artificial spectrum  generated
              using  the  line  list  (float; default: 2.0). The full name of this option for the
              EsoRex configuration file is sinfoni.wavecal.sigma [default = 2.0].

       --wcal-fwhm <float>
              FWHM: initial guess value for the fwhm of  the  Gaussian  used  for  the  line  fit
              (float;  default:  2.83). The full name of this option for the EsoRex configuration
              file is sinfoni.wavecal.fwhm [default = 2.83].

       --wcal-min_amplitude <float>
              Minimum Of Amplitude: of the Gaussian to do the fit (float; default: 5.0). The full
              name    of    this    option    for    the    EsoRex    configuration    file    is
              sinfoni.wavecal.min_amplitude [default = 5.0].

       --wcal-max_residual <float>
              Maximum Residuals value: beyond this value the fit  is  rejected  (float;  default:
              0.5).  The  full  name  of  this  option  for  the  EsoRex  configuration  file  is
              sinfoni.wavecal.max_residual [default = 0.5].

       --wcal-n_a_coeffs <long>
              Number of A coefficients: number of  polynomial  coefficients  for  the  dispersion
              relation  (long;  default:  4).  The  full  name  of  this  option  for  the EsoRex
              configuration file is sinfoni.wavecal.n_a_coefficients [default = 4].

       --wcal-n_b_coeffs <long>
              Number of B coefficients: number of polynomial coefficients for the polynomial  fit
              of the dispersion coefficients (long; default: 2). The full name of this option for
              the EsoRex configuration file is sinfoni.wavecal.n_b_coefficients [default = 2].

       --wcal-sigma_factor <float>
              Sigma Factor: Factor of the standard deviation of the  polynomial  coefficients  of
              the  dispersion  relation  beyond  which  the coefficients are not used for the fit
              (float; default: 1.5). The full name of this option for  the  EsoRex  configuration
              file is sinfoni.wavecal.sigma_factor [default = 1.5].

       --wcal-wcoeff_ind <bool>
              Write  Coefficients  Index:  indicates if the coefficients should be written into a
              file or not (bool; default: True). The full name of  this  option  for  the  EsoRex
              configuration file is sinfoni.wavecal.write_coeffs_ind [default = True].

       --wcal-par_ind <bool>
              Write  Parameter  Index:  indicates  if the fit parameters should be written into a
              file or not  (bool; default: True). The full name of this  option  for  the  EsoRex
              configuration file is sinfoni.wavecal.write_par_ind [default = True].

       --wcal-pixel_dist <long>
              Minimal  Slitlets´s  Distance  in  spectral direction (long; default: 15). The full
              name of this option for the EsoRex configuration file is sinfoni.wavecal.pixel_dist
              [default = 15].

       --wcal-pixel_tol <float>
              Pixel Tolerance: allowed pixel position tolerance between estimated and fitted line
              position (float; default: 5.0). The  full  name  of  this  option  for  the  EsoRex
              configuration file is sinfoni.wavecal.pixel_tol [default = 5.0].

       --wcal-wave_map_ind <bool>
              Wavelength  Map  Indicator:  indicates  if the wavelength calibration map should be
              generated (TRUE) or not (FALSE) (bool; default:  False).  The  full  name  of  this
              option for the EsoRex configuration file is sinfoni.wavecal.wave_map_ind [default =
              False].

       --wcal-mag_factor <long>
              Magnificator Factor: magnifying factor for the number  of  pixels  in  the  columns
              needed  for  FFT  (long;  default:  8). The full name of this option for the EsoRex
              configuration file is sinfoni.wavecal.mag_factor [default = 8].

       --wcal-slit_pos_ind <bool>
              Slit Position Indicator: indicates if the fits of the slitlet edge positions should
              be  carried  through or not (bool; default: True). The full name of this option for
              the EsoRex configuration  file  is  sinfoni.wavecal.slit_pos_indicator  [default  =
              True].

       --wcal-fit_boltz_ind <bool>
              Fit  Boltzmann  Indicator:  indicates  if the fits of the slitlet edge positions is
              carried trough by using a Boltzmann function  as  model  function  (bool;  default:
              True).  The  full  name  of  this  option  for  the  EsoRex  configuration  file is
              sinfoni.wavecal.fit_boltz_indicator [default = True].

       --wcal-fit_edge_ind <bool>
              Fit Edge Indicator: indicates if the fits of the slitlet edge positions is  carried
              through  by  using a simple edge function as model function (bool; default: False).
              The  full  name  of  this   option   for   the   EsoRex   configuration   file   is
              sinfoni.wavecal.fit_edge_indicator [default = False].

       --wcal-estimate_ind <bool>
              Estimate  Indicator: indicates if the fits of the slitlet edge positions is carried
              through by using a list of estimated guess positions in  a  file  (TRUE)or  if  the
              initial positions are calculated automatically (FALSE). The estimation case is more
              stable (bool; default: False).  The  full  name  of  this  option  for  the  EsoRex
              configuration file is sinfoni.wavecal.estimate_indicator [default = False].

       --wcal-box_len <long>
              Box  Length: pixel length of the row box within which the fit is carried out (long;
              default: 32). The full name of this option for the  EsoRex  configuration  file  is
              sinfoni.wavecal.box_length [default = 32].

       --wcal-y_box <float>
              Y  Box:  half  width  of a small box in spectral direction within which the maximal
              intensity pixel is searched (float; default: 5.0). The full name of this option for
              the EsoRex configuration file is sinfoni.wavecal.y_box [default = 5.0].

       --wcal-diff_toll <float>
              Difference  Tolearance: maximal tolerable difference of the resulting fit positions
              of the slitlet edges with respect to the expected positions (float; default:  2.0).
              The   full   name   of   this   option   for   the  EsoRex  configuration  file  is
              sinfoni.wavecal.diff_tol [default = 2.0].

       --wcal-qc_thresh_min <long>
              qc_thresh_min (long; default: 0). The full name  of  this  option  for  the  EsoRex
              configuration file is sinfoni.wavecal.qc_thresh_min [default = 0].

       --wcal-qc_thresh_max <long>
              qc_thresh_max  (long;  default: 49000). The full name of this option for the EsoRex
              configuration file is sinfoni.wavecal.qc_thresh_max [default = 49000].

       --wcal-no_coeffs <long>
              number of coefficients for the polynomial interpolation  (long;  default:  3).  The
              full    name    of   this   option   for   the   EsoRex   configuration   file   is
              sinfoni.wavecal.n_coeffs [default = 3].

       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 sinfo pipeline can be downloaded as a PDF  file  using  the
       following URL:

              ftp://ftp.eso.org/pub/dfs/pipelines/sinfoni/sinfo-pipeline-manual-19.0.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 sinfo pipeline are sinfo_rec_detlin(7), sinfo_rec_distortion(7),
       sinfo_rec_jitter(7),    sinfo_rec_mdark(7),    sinfo_rec_mflat(7),     sinfo_rec_pupil(7),
       sinfo_utl_bp_mask_add(7),        sinfo_utl_cube2ima(7),        sinfo_utl_cube2spectrum(7),
       sinfo_utl_cube_arith(7),       sinfo_utl_cube_combine(7),        sinfo_utl_cube_create(7),
       sinfo_utl_ima_arith(7),      sinfo_utl_ima_line_corr(7),      sinfo_utl_line_oh_select(7),
       sinfo_utl_skycor(7),    sinfo_utl_skymap(7),    sinfo_utl_spectrum_divide_by_blackbody(7),
       sinfo_utl_spectrum_wavelength_shift(7)

VERSION

       sinfo_rec_wavecal 3.0.0

AUTHOR

       Andrea Modigliani <Andrea.Modigliani@eso.org>

BUG REPORTS

       Please  report  any  problems  to Andrea.Modigliani@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 SINFONI Instrument  Pipeline  Copyright  (C)  2002,2003  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., 59 Temple Place, Suite  330,  Boston,
       MA  02111-1307  USA