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

NAME

       sinfo_rec_mflat - Master flat determination

SYNOPSIS

       esorex sinfo_rec_mflat [OPTIONS] FILE.sof

DESCRIPTION

       This recipe reduce normal raw flat fields.

       The  input  files  are  a set of flat fields with tag FLAT_LAMP optionally one may have in
       input also several bad pixel maps to be coadded.

       The main products are a master flat field (PRO.CATG=MASTER_FLAT_LAMP) image  a  bad  pixel
       map (PRO.CATG=BP_MAP_NO), a master bad pixel map (PRO.CATG=MASTER_BP_MAP) resulting by the
       coaddition of all bad pixel maps.

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

       --bp_norm-s_factor <float>
              Threshold  Sigma  Factor: to remove the column intensity tilt only pixels which lie
              within a defined noiselimit are used to fit a straight line (float; default:  5.0).
              The   full   name   of   this   option   for   the  EsoRex  configuration  file  is
              sinfoni.bp_norm.sigma_factor [default = 5.0].

       --bp_norm-method_ind <long>
              Bad pixel Method Index1: median of nearest neighbors,2: absolute  distances  check,
              3:  mean  of  nearest  spectral neighbors (long; default: 1). The full name of this
              option for the EsoRex configuration file is sinfoni.bp_norm.method_index [default =
              1].

       --bp_norm-fct <float>
              Factor:  if  |pixel - median| > factor * standard deviation -> then the pixel value
              is replaced by the median of the 8 nearest neighbors (float;  default:  10.0).  The
              full    name    of   this   option   for   the   EsoRex   configuration   file   is
              sinfoni.bp_norm.factor [default = 10.0].

       --bp_norm-it <long>
              Iterations: number of iterations to of median filtering to find bad pixel  clusters
              (long;  default: 8). The full name of this option for the EsoRex configuration file
              is sinfoni.bp_norm.iterations [default = 8].

       --bp_norm-lo_rej <float>
              low_rejection: percentage of rejected low intensity pixels before averaging (float;
              default:  0.1).  The  full name of this option for the EsoRex configuration file is
              sinfoni.bp_norm.low_rejection [default = 0.1].

       --bp_norm-hi_rej <float>
              high_rejection: percentage of  rejected  high  intensity  pixels  before  averaging
              (float;  default:  0.1).  The full name of this option for the EsoRex configuration
              file is sinfoni.bp_norm.high_rejection [default = 0.1].

       --bp_norm-llx <long>
              llx: to compute image statistics on a rectangularzone of the image the  coordinates
              of  the rectangle are needed:lower left x coordinate (long; default: 270). The full
              name of this option  for  the  EsoRex  configuration  file  is  sinfoni.bp_norm.llx
              [default = 270].

       --bp_norm-lly <long>
              lly:  to compute image statistics on a rectangularzone of the image the coordinates
              of the rectangle are needed:lower left y coordinate (long; default: 1000). The full
              name  of  this  option  for  the  EsoRex  configuration file is sinfoni.bp_norm.lly
              [default = 1000].

       --bp_norm-urx <long>
              urx: to compute image statistics on a rectangularzone of the image the  coordinates
              of the rectangle are needed:upper right x coordinate (long; default: 310). The full
              name of this option  for  the  EsoRex  configuration  file  is  sinfoni.bp_norm.urx
              [default = 310].

       --bp_norm-ury <long>
              ury:  to compute image statistics on a rectangularzone of the image the coordinates
              of the rectangle are needed:upper right y coordinate  (long;  default:  1200).  The
              full  name  of this option for the EsoRex configuration file is sinfoni.bp_norm.ury
              [default = 1200].

       --bp_norm-thr_ind <bool>
              Threshold Index:  indicator  that  indicates  if  the  values  beyond  a  threshold
              deviation  from  the mean are flagged as bad pixels (bool; default: True). The full
              name    of    this    option    for    the    EsoRex    configuration    file    is
              sinfoni.bp_norm.threshold_index [default = True].

       --bp_norm-mean_fct <float>
              Mean  Factor:  factor  to  the  clean  standard  deviation  to define the threshold
              deviation from the clean mean (float; default: 100.0). The full name of this option
              for the EsoRex configuration file is sinfoni.bp_norm.mean_factor [default = 100.0].

       --bp_norm-min_cut <float>
              the  minimum value of real data (float; default: 0.0). The full name of this option
              for the EsoRex configuration file is sinfoni.bp_norm.min_cut [default = 0.0].

       --bp_norm-max_cut <float>
              the minimum value of real data (float; default: 50000.0). The  full  name  of  this
              option  for  the  EsoRex  configuration  file is sinfoni.bp_norm.max_cut [default =
              50000.0].

       --lamp_flats-lo_rej <float>
              lower rejection: percentage of  rejected  low  intensity  pixels  before  averaging
              (float;  default:  0.1).  The full name of this option for the EsoRex configuration
              file is sinfoni.lamp_flats.low_rejection [default = 0.1].

       --lamp_flats-hi_rej <float>
              high rejection: percentage of  rejected  high  intensity  pixels  before  averaging
              (float;  default:  0.1).  The full name of this option for the EsoRex configuration
              file is sinfoni.lamp_flats.high_rejection [default = 0.1].

       --lamp_flats-interpol_index <bool>
              Interpolation index switch: indicator if the bad pixels of the flatfield should  be
              interpolated  (bool;  default:  False). The full name of this option for the EsoRex
              configuration file is sinfoni.lamp_flats.interpol_index [default = False].

       --lamp_flats-max_rad <long>
              Max Rad: maximal pixel distance from bad pixel to take valid pixels (long; default:
              4).   The   full  name  of  this  option  for  the  EsoRex  configuration  file  is
              sinfoni.lamp_flats.max_rad [default = 4].

       --lamp_flats-bad_ind <bool>
              indicator if a bad pixel mask should be generated or not  (bool;  default:  False).
              The   full   name   of   this   option   for   the  EsoRex  configuration  file  is
              sinfoni.lamp_flats.bad_ind [default = False].

       --lamp_flats-sigma_factor <float>
              Sigma Factor: factor of the sigma noise limit; to remove the column intensity  tilt
              only  pixels which lie within a defined noise limit are used to fit a straight line
              (float; default: 5.0). The full name of this option for  the  EsoRex  configuration
              file is sinfoni.lamp_flats.sigma_factor [default = 5.0].

       --lamp_flats-factor <float>
              Factor:  if  |pixel - median| > factor * standard deviation -> then the pixel value
              is replaced by the median of the 8 nearest neighbors  (float;  default:  3.0).  The
              full    name    of   this   option   for   the   EsoRex   configuration   file   is
              sinfoni.lamp_flats.factor [default = 3.0].

       --lamp_flats-iterations <long>
              Iterations: number of iterations to of median filtering to find bad pixel  clusters
              (long;  default: 8). The full name of this option for the EsoRex configuration file
              is sinfoni.lamp_flats.iterations [default = 8].

       --lamp_flats-bad_lo_rej <float>
              low rejection: Percentage for bad pixel low rejection (float; default:  10.0).  The
              full    name    of   this   option   for   the   EsoRex   configuration   file   is
              sinfoni.lamp_flats.bad_low_rejection [default = 10.0].

       --lamp_flats-bad_hi_rej <float>
              high rejection: Percentage for bad pixel high rejection (float; default: 10.0). The
              full    name    of   this   option   for   the   EsoRex   configuration   file   is
              sinfoni.lamp_flats.bad_high_rejection [default = 10.0].

       --lamp_flats-llx <long>
              Lower Lext X corner (long; default: 1350). The full name of  this  option  for  the
              EsoRex configuration file is sinfoni.lamp_flats.llx [default = 1350].

       --lamp_flats-lly <long>
              Lower  Lext  Y  corner  (long; default: 1000). The full name of this option for the
              EsoRex configuration file is sinfoni.lamp_flats.lly [default = 1000].

       --lamp_flats-rrx <long>
              Upper right X corner (long; default: 1390). The full name of this  option  for  the
              EsoRex configuration file is sinfoni.lamp_flats.urx [default = 1390].

       --lamp_flats-ury <long>
              Upper  right  Y  corner (long; default: 1200). The full name of this option for the
              EsoRex configuration file is sinfoni.lamp_flats.ury [default = 1200].

       --lamp_flats-tresh_ind <bool>
              Treshold index:  (bool; default: False). The full  name  of  this  option  for  the
              EsoRex configuration file is sinfoni.lamp_flats.thresh_ind [default = False].

       --lamp_flats-mean_factor <float>
              Mean  Factor:  factor  to  the  clean  standard  deviation  to define the threshold
              deviation from the clean mean (float; default: 10.0). The full name of this  option
              for  the  EsoRex  configuration  file  is sinfoni.lamp_flats.mean_factor [default =
              10.0].

       --lamp_flats-qc_fpn_xmin1 <long>
              qc_fpn_xmin1 (long; default: 512). The full name of  this  option  for  the  EsoRex
              configuration file is sinfoni.lamp_flats.qc_fpn_xmin1 [default = 512].

       --lamp_flats-qc_fpn_xmax1 <long>
              qc_fpn_xmax1  (long;  default:  1536).  The full name of this option for the EsoRex
              configuration file is sinfoni.lamp_flats.qc_fpn_xmax1 [default = 1536].

       --lamp_flats-qc_fpn_ymin1 <long>
              qc_fpn_ymin1 (long; default: 512). The full name of  this  option  for  the  EsoRex
              configuration file is sinfoni.lamp_flats.qc_fpn_ymin1 [default = 512].

       --lamp_flats-qc_fpn_ymax1 <long>
              qc_fpn_ymax1  (long;  default:  1536).  The full name of this option for the EsoRex
              configuration file is sinfoni.lamp_flats.qc_fpn_ymax1 [default = 1536].

       --lamp_flats-qc_fpn_xmin2 <long>
              qc_fpn_xmin2 (long; default: 1350). The full name of this  option  for  the  EsoRex
              configuration file is sinfoni.lamp_flats.qc_fpn_xmin2 [default = 1350].

       --lamp_flats-qc_fpn_xmax2 <long>
              qc_fpn_xmax2  (long;  default:  1390).  The full name of this option for the EsoRex
              configuration file is sinfoni.lamp_flats.qc_fpn_xmax2 [default = 1390].

       --lamp_flats-qc_fpn_ymin2 <long>
              qc_fpn_ymin2 (long; default: 1000). The full name of this  option  for  the  EsoRex
              configuration file is sinfoni.lamp_flats.qc_fpn_ymin2 [default = 1000].

       --lamp_flats-qc_fpn_ymax2 <long>
              qc_fpn_ymax2  (long;  default:  1200).  The full name of this option for the EsoRex
              configuration file is sinfoni.lamp_flats.qc_fpn_ymax2 [default = 1200].

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

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

       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_pupil(7),    sinfo_rec_wavecal(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_mflat 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