Provided by: cpl-plugin-uves-doc_6.1.8+dfsg-2build3_all bug

NAME

       flames_cal_mkmaster - Creates a master flat frame to support FIBER mode data reduction

SYNOPSIS

       esorex flames_cal_mkmaster [OPTIONS] FILE.sof

DESCRIPTION

       This recipe creates a composite master flat frame to reduce FIBER mode data by: 1) Group each input raw
       flat frame per grating setting. Then for each set: 1a) subtracts the master bias frame from each flat
       field frame, 1b) divides each flat field frame by the exposure time for that frame, 1c) takes the median
       of all bias subtracted, normalized raw flat frames, 1d) optionally subtracts the master dark frame, and
       1e) subtracts the background to get the bias subtracted, optionally dark subtracted, normalized,
       background subtracted master flat-field frame.

       2) Creates a synthetic master frame resulting from the coaddition of each master flat frame obtained by
       each set Symbolically,
        masterflat = median( (flat_i - masterbias)/exptime_i ) - masterdark/exptime
                   - background.

       The input flat field frames must have same tag which must match (SFLAT_(BLUE|RED), for example SFLAT_BLUE
       or FLAT_RED. Also, a master bias (MASTER_BIAS_xxxx) and ordertable (ORDER_TABLE_xxxx) must be provided
       for each chip (xxxx = BLUE, REDL, REDU). A master dark frame (MASTER_(P)DARK_xxxx) may optionally be
       provided. On blue input the recipe computes one master flat field frame; on red input the recipe produces
       a master flat field frame for each chip (MASTER_SFLAT_xxxx).

OPTIONS

       --backsub.mmethod <str>
              Background  measuring method. If equal to ´median´ the background is sampled using the median of a
              subwindow. If ´minimum´, the subwindow minimum value is used. If ´no´, no  background  subtraction
              is done.  (str; default: ´median´). The full name of this option for the EsoRex configuration file
              is flames_cal_mkmaster.backsub.mmethod [default = median].

       --backsub.npoints <int>
              This  is  the  number of columns in interorder space used to sample the background. (int; default:
              82).   The   full   name   of   this   option   for   the    EsoRex    configuration    file    is
              flames_cal_mkmaster.backsub.npoints [default = 82].

       --backsub.radiusy <int>
              The height (in pixels) of the background sampling window is (2*radiusy + 1). This parameter is not
              corrected  for  binning.  (int;  default:  2).  The  full  name  of  this  option  for  the EsoRex
              configuration file is flames_cal_mkmaster.backsub.radiusy [default = 2].

       --backsub.sdegree <int>
              Degree of interpolating splines. Currently only degree = 1 is supported  (int;  default:  1).  The
              full  name of this option for the EsoRex configuration file is flames_cal_mkmaster.backsub.sdegree
              [default = 1].

       --backsub.smoothx <float>
              If spline interpolation is used to measure the background,  the  x-radius  of  the  post-smoothing
              window  is  (smoothx  *  image_width).   Here,  ´image_width´ is the image width after binning. If
              negative, the default values are used: (25.0/4096) for blue flat-field frames, (50.0/4096) for red
              flat-field frames, (300.0/4096) for blue science frames and (300.0/4096) for red  science  frames.
              (float;  default:  -1.0).  The  full  name  of  this  option  for the EsoRex configuration file is
              flames_cal_mkmaster.backsub.smoothx [default = -1.0].

       --backsub.smoothy <float>
              If spline interpolation is used to measure the background,  the  y-radius  of  the  post-smoothing
              window  is  (smoothy  * image_height).  Here, ´image_height´ is the image height after binning. If
              negative, the default values are used: (100.0/2048) for blue flat-field frames,  (300.0/2048)  for
              red  flat-field  frames,  (200.0/2048)  for  blue  science frames and (500.0/2048) for red science
              frames. (float; default: -1.0). The full name of this option for the EsoRex configuration file  is
              flames_cal_mkmaster.backsub.smoothy [default = -1.0].

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

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

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

       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-6.1.8.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_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_mdark(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

       flames_cal_mkmaster 6.1.8

AUTHOR

       Andrea Modigliani <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

flames_cal_mkmaster                                   6.1.8                               FLAMES_CAL_MKMASTER(7)