trusty (7) sinfo_rec_mdark.7.gz

Provided by: cpl-plugin-sinfo-doc_2.4.0+dfsg-3_all bug

NAME

       sinfo_rec_mdark - Master dark and hot pixels mask generation.

SYNOPSIS

       esorex sinfo_rec_mdark [OPTIONS] FILE.sof

DESCRIPTION

       This recipe perform raw sinfo_dark data reduction.

       The input files are raw sinfo_dark images Their associated tags should be DARK.

       The   output   are   a   master  sinfo_dark  (PRO.CATG=MASTER_DARK)  and  a  hot  pixels  bad  pixel  map
       (PRO.CATG=BP_MAP_HP) Information on relevant parameters may be found with esorex --params sinfo_rec_mdark
       esorex --help sinfo_rec_mdark

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

       --bp_noise-thresh_sigma_fct <float>
              Threshold  Sigma  Factor:  If  the  mean  noise  exceeds  this  threshold times the clean standard
              deviation of the clean mean the corresponding pixels are declared as bad  (float; default:  10.0).
              The    full    name    of    this    option    for    the    EsoRex    configuration    file    is
              sinfoni.bp_noise.thresh_sigma_factor [default = 10.0].

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

       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_wavecal(7),
       sinfo_utl_ima_line_corr(7),             sinfo_utl_cube_combine(7),              sinfo_utl_bp_mask_add(7),
       sinfo_utl_cube2spectrum(7),               sinfo_utl_cube_create(7),              sinfo_rec_distortion(7),
       sinfo_utl_spectrum_divide_by_blackbody(7),      sinfo_utl_line_oh_select(7),       sinfo_utl_cube2ima(7),
       sinfo_utl_cube_arith(7),       sinfo_rec_pupil(7),       sinfo_rec_mflat(7),      sinfo_utl_ima_arith(7),
       sinfo_utl_skycor(7), sinfo_utl_spectrum_wavelength_shift(7), sinfo_utl_skymap(7), sinfo_rec_jitter(7)

VERSION

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