bionic (7) kmos_dark.7.gz

Provided by: cpl-plugin-kmos-doc_1.4.3+dfsg-1_all bug

NAME

       kmos_dark - Create master dark frame & bad pixel mask

SYNOPSIS

       esorex kmos_dark [OPTIONS] FILE.sof

DESCRIPTION

       This recipe calculates the master dark frame.

       It  is recommended to provide three or more dark exposures to produce a reasonable master with associated
       noise.

       Input files:
          DO CATG          Type   Explanation                     Required #Frames
          -------          -----  -----------                     -------- -------
          DARK             RAW    Dark exposures                     Y       1-n
                                  (at least 3 frames recommended)

       Output files:
          DO CATG          Type   Explanation
          -------          -----  -----------
          MASTER_DARK      F2D    Calculated master dark frames
          BADPIXEL_DARK    B2D    Associated badpixel frames

OPTIONS

       --oscan <bool>
              Apply Overscan Correction (bool; default: True). The full name  of  this  option  for  the  EsoRex
              configuration file is kmos.kmos_dark.oscan [default = True].

       --pos_bad_pix_rej <float>
              The  positive  rejection  threshold  for  bad pixels (float; default: 50.0). The full name of this
              option for the EsoRex configuration file is kmos.kmos_dark.pos_bad_pix_rej [default = 50.0].

       --neg_bad_pix_rej <float>
              The negative rejection threshold for bad pixels (float; default: 50.0).  The  full  name  of  this
              option for the EsoRex configuration file is kmos.kmos_dark.neg_bad_pix_rej [default = 50.0].

       --file_extension <bool>
              Controls  if EXPTIME should be appended to product filenames (bool; default: False). The full name
              of this option for the EsoRex  configuration  file  is  kmos.kmos_dark.file_extension  [default  =
              False].

       --cmethod <str>
              Apply  "average", "median", "sum", "min_max." or "ksigma". (str; default: ´ksigma´). The full name
              of this option for the EsoRex configuration file is kmos.kmos_dark.cmethod [default = ksigma].

       --cpos_rej <float>
              The positive rejection threshold for kappa-sigma-clipping (sigma).   (float;  default:  3.0).  The
              full  name  of this option for the EsoRex configuration file is kmos.kmos_dark.cpos_rej [default =
              3.0].

       --cneg_rej <float>
              The negative rejection threshold for kappa-sigma-clipping (sigma).   (float;  default:  3.0).  The
              full  name  of this option for the EsoRex configuration file is kmos.kmos_dark.cneg_rej [default =
              3.0].

       --citer <long>
              The number of iterations for kappa-sigma-clipping. (long; default:  3).  The  full  name  of  this
              option for the EsoRex configuration file is kmos.kmos_dark.citer [default = 3].

       --cmax <long>
              The  number  of  maximum pixel values to clip with min/max-clipping.  (long; default: 1). The full
              name of this option for the EsoRex configuration file is kmos.kmos_dark.cmax [default = 1].

       --cmin <long>
              The number of minimum pixel values to clip with min/max-clipping.  (long; default:  1).  The  full
              name of this option for the EsoRex configuration file is kmos.kmos_dark.cmin [default = 1].

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

              ftp://ftp.eso.org/pub/dfs/pipelines/kmos/kmos-pipeline-manual-2.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  kmos  pipeline  are  kmo_arithmetic(7),  kmo_copy(7),   kmo_fit_profile(7),
       kmo_fits_strip(7),  kmo_make_image(7),  kmo_noise_map(7),  kmo_rotate(7),  kmo_shift(7), kmo_sky_mask(7),
       kmo_stats(7),     kmos_combine(7),     kmos_extract_spec(7),     kmos_flat(7),      kmos_gen_reflines(7),
       kmos_gen_telluric(7),   kmos_illumination(7),  kmos_reconstruct(7),  kmos_sci_red(7),  kmos_sky_tweak(7),
       kmos_std_star(7), kmos_test(7), kmos_wave_cal(7)

VERSION

       kmos_dark 1.4.3

AUTHOR

       Alex Agudo Berbel, Yves Jung <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 CRIRES 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