Provided by: cpl-plugin-hawki-doc_2.4.3+dfsg-1_all bug

NAME

       hawki_twilight_flat_combine - HAWKI twilight combination recipe

SYNOPSIS

       esorex hawki_twilight_flat_combine [OPTIONS] FILE.sof

DESCRIPTION

       hawki_twilight_flat_combine -- HAWKI twilight flat combine recipe.

       Combine  a  list  of twilight flat frames into a mean frame. Optionally compare the output
       frame to a master twilight flat frame

       The program accepts the following files in the SOF:

           Tag                   Description

           FLAT_TWILIGHT         A list of raw twilight flat images
           MASTER_DARK           A master dark frame
           REFERENCE_TWILIGHT_FLAT Optional reference twilight flat frame
           MASTER_BPM            Optional master bad pixel map or
           MASTER_CONF           Optional master confidence map If no reference twilight flat  is
       made  available, then no comparison will be done. This means there will be no output ratio
       image. If either a masterbad pixel mask or a master confidence map is specified, this will
       be usedto help mask out bad pixels

OPTIONS

       --lthr <float>
              Low  rejection  threshold for underexpsed images (float; default: 4000.0). The full
              name    of    this    option    for    the    EsoRex    configuration    file    is
              hawki.hawki_twilight_flat_combine.lthr [default = 4000.0].

       --hthr <float>
              High rejection threshold for overexposed images (float; default: 30000.0). The full
              name    of    this    option    for    the    EsoRex    configuration    file    is
              hawki.hawki_twilight_flat_combine.hthr [default = 30000.0].

       --combtype <str>
              Combination  algorithm  (str;  default: ´median´). The full name of this option for
              the  EsoRex  configuration   file   is   hawki.hawki_twilight_flat_combine.combtype
              [default = median].

       --scaletype <str>
              Scaling  algorithm  (str;  default: ´multiplicative´). The full name of this option
              for the EsoRex configuration  file  is  hawki.hawki_twilight_flat_combine.scaletype
              [default = multiplicative].

       --xrej <bool>
              True  if  using  extra rejection cycle (bool; default: True). The full name of this
              option for the EsoRex configuration file is  hawki.hawki_twilight_flat_combine.xrej
              [default = True].

       --thresh <float>
              Rejection  threshold in sigma above background (float; default: 5.0). The full name
              of     this     option     for     the     EsoRex     configuration     file     is
              hawki.hawki_twilight_flat_combine.thresh [default = 5.0].

       --ncells <int>
              Number  of  cells  for  data channel stats (int; default: 8). The full name of this
              option       for       the        EsoRex        configuration        file        is
              hawki.hawki_twilight_flat_combine.ncells [default = 8].

       --prettynames <bool>
              Use  pretty output file names? (bool; default: False). The full name of this option
              for the EsoRex configuration file is  hawki.hawki_twilight_flat_combine.prettynames
              [default = False].

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

              ftp://ftp.eso.org/pub/dfs/pipelines/hawki/hawki-pipeline-manual-2.4.3.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 hawki pipeline  are  hawki_cal_dark(7),  hawki_cal_distortion(7),
       hawki_cal_flat(7),  hawki_cal_zpoint(7),  hawki_dark_combine(7),  hawki_detector_noise(7),
       hawki_linearity_analyse(7),       hawki_sci_jitter(7),       hawki_science_postprocess(7),
       hawki_science_process(7),       hawki_standard_process(7),       hawki_step_apply_dist(7),
       hawki_step_basic_calib(7),        hawki_step_combine(7),        hawki_step_compute_bkg(7),
       hawki_step_detect_obj(7),     hawki_step_photom_2mass(7),    hawki_step_refine_offsets(7),
       hawki_step_stats(7),           hawki_step_stitch(7),           hawki_step_subtract_bkg(7),
       hawki_tec_filtchk(7), hawki_util_gendist(7), hawki_util_stdstars(7)

VERSION

       hawki_twilight_flat_combine 2.4.3

AUTHOR

       Jim Lewis <jrl@ast.cam.ac.uk>

BUG REPORTS

       Please  report  any problems to jrl@ast.cam.ac.uk. Alternatively, you may send a report to
       the ESO User Support Department <usd-help@eso.org>.

LICENSE

       This file is part of the HAWKI Instrument Pipeline Copyright (C)  2015  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