Provided by: cpl-plugin-uves-doc_5.9.1+dfsg-1build2_all bug

NAME

       uves_cal_mdark - Creates the master dark frame

SYNOPSIS

       esorex uves_cal_mdark [OPTIONS] FILE.sof

DESCRIPTION

       This recipe creates a master dark frame by taking the median of all input frames which
       should have identical exposure times. Symbolically,
          masterdark = median( dark_i ) - masterbias

       The input dark frames must have same tag and size and must be either (P)DARK_BLUE or
       (P)DARK_RED. Also, a master bias (MASTER_BIAS_xxxx) must be provided for each chip (xxxx =
       BLUE, REDL, REDU).

       On blue input the recipe computes one master dark frame; on red input the recipe produces
       a master dark frame for each chip (MASTER_(P)DARK_xxxx).

OPTIONS

       --stack_method <str>
              Method used to build master frame  (str; default: ´median´). The full name of this
              option for the EsoRex configuration file is uves_cal_mdark.stack_method [default =
              median].

       --klow <float>
              Kappa used to clip low level values, when method is set to ´mean´ (float; default:
              5.0). The full name of this option for the EsoRex configuration file is
              uves_cal_mdark.klow [default = 5.0].

       --khigh <float>
              Kappa used to clip high level values, when method is set to ´mean´ (float; default:
              5.0). The full name of this option for the EsoRex configuration file is
              uves_cal_mdark.khigh [default = 5.0].

       --niter <int>
              Number of kappa sigma iterations, when method is set to ´mean´  (int; default: 5).
              The full name of this option for the EsoRex configuration file is
              uves_cal_mdark.niter [default = 5].

       --debug <bool>
              Whether or not to save intermediate results to local directory (bool; default:
              False). The full name of this option for the EsoRex configuration file is
              uves.debug [default = False].

       --plotter <str>
              Any plots produced by the recipe are redirected to the command specified by this
              parameter. The plotting command must contain the substring ´gnuplot´ and must be
              able to parse gnuplot syntax on its standard input. Valid examples of such a
              command may include ´gnuplot -persist´ and ´cat > mygnuplot$$.gp´. A finer control
              of the plotting options can be obtained by writing an executable script, e.g.
              my_gnuplot.pl, that executes gnuplot after setting the desired gnuplot options
              (e.g. set terminal pslatex color). To turn off plotting, set this parameter to ´no´
              (str; default: ´no´). The full name of this option for the EsoRex configuration
              file is uves.plotter [default = no].

       --process_chip <str>
              For RED arm data process the redl, redu, or both chip(s) (str; default: ´both´).
              The full name of this option for the EsoRex configuration file is uves.process_chip
              [default = both].

       --stack_method <str>
              Method used to build master frame  (str; default: ´median´). The full name of this
              option for the EsoRex configuration file is uves_cal_mdark.stack_method [default =
              median].

       --klow <float>
              Kappa used to clip low level values, when method is set to ´mean´ (float; default:
              5.0). The full name of this option for the EsoRex configuration file is
              uves_cal_mdark.klow [default = 5.0].

       --khigh <float>
              Kappa used to clip high level values, when method is set to ´mean´ (float; default:
              5.0). The full name of this option for the EsoRex configuration file is
              uves_cal_mdark.khigh [default = 5.0].

       --niter <int>
              Number of kappa sigma iterations, when method is set to ´mean´  (int; default: 5).
              The full name of this option for the EsoRex configuration file is
              uves_cal_mdark.niter [default = 5].

       --qc_dark.reg.num_x <int>
              Number of regions along the X axis (where mean/med/rms are computed).  (int;
              default: 4). The full name of this option for the EsoRex configuration file is
              uves_cal_mdark.qc_dark.reg.num_x [default = 4].

       --qc_dark.reg.num_y <int>
              Number of regions along the Y axis(where mean/med/rms are computed).  (int;
              default: 4). The full name of this option for the EsoRex configuration file is
              uves_cal_mdark.qc_dark.reg.num_y [default = 4].

       --qc_dark.reg.box_sx <int>
              Region X size [pix] (int; default: 100). The full name of this option for the
              EsoRex configuration file is uves_cal_mdark.qc_dark.reg.box_sx [default = 100].

       --qc_dark.reg.box_sy <int>
              Region Y size [pix] (int; default: 100). The full name of this option for the
              EsoRex configuration file is uves_cal_mdark.qc_dark.reg.box_sy [default = 100].

       --qc_dark.reg.border_x <int>
              X distance between the left hand side of the detector and the left hand side of the
              region [pix] (int; default: 100). The full name of this option for the EsoRex
              configuration file is uves_cal_mdark.qc_dark.reg.border_x [default = 100].

       --qc_dark.reg.border_y <int>
              X distance between the left hand side of the detector and the left hand side of the
              region [pix] (int; default: 100). The full name of this option for the EsoRex
              configuration file is uves_cal_mdark.qc_dark.reg.border_y [default = 100].

       --qc_dark.reg.when <int>
              When QC analysis is performed. 0: on each raw frame or 1: on the master frame (int;
              default: 0). The full name of this option for the EsoRex configuration file is
              uves_cal_mdark.qc_dark.reg.when [default = 0].

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

              ftp://ftp.eso.org/pub/dfs/pipelines/uves/uves-pipeline-manual-5.9.1.pdf

       An overview over the existing ESO pipelines can be found on the web page
       https://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
       https://packages.python.org/python-cpl/index.html for further information.

       The other recipes of the uves pipeline are flames_cal_mkmaster(7), flames_cal_orderpos(7),
       flames_cal_predict(7), flames_cal_prep_sff_ofpos(7), flames_cal_wavecal(7),
       flames_obs_redchain(7), flames_obs_scired(7), flames_utl_unpack(7), uves_cal_cd_align(7),
       uves_cal_mbias(7), uves_cal_mflat(7), uves_cal_mflat_combine(7), uves_cal_mkmaster(7),
       uves_cal_orderpos(7), uves_cal_predict(7), uves_cal_response(7), uves_cal_tflat(7),
       uves_cal_wavecal(7), uves_obs_redchain(7), uves_obs_scired(7), uves_utl_ima_arith(7),
       uves_utl_remove_crh_single(7)

VERSION

       uves_cal_mdark 5.9.1

AUTHOR

       Jonas M. Larsen <cpl@eso.org>

BUG REPORTS

       Please report any problems to cpl@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 FLAMES/UVES Pipeline Copyright (C) 2004, 2005, 2006, 2007
       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  02111-1307  USA