.TH HAWKI_DARK_COMBINE "7" "2.4.11" "hawki_dark_combine" "hawki recipes"
.SH NAME
hawki_dark_combine \- HAWKI dark combination recipe

.SH SYNOPSIS
esorex
.B hawki_dark_combine
[OPTIONS] FILE.sof

.SH DESCRIPTION
hawki_dark_combine \-\- HAWKI dark combine recipe.
.PP

Combine a list of dark frames into a mean dark frame. Optionally compare 
the output frame to a reference dark frame

The program accepts the following files in the SOF:

    Tag                   Description
    
    DARK                  A list of raw dark images
    REFERENCE_DARK        Optional reference dark frame
    MASTER_BPM            Optional master bad pixel map or
    MASTER_CONF           Optional master confidence map
If no reference dark frame is made available, then no comparison will be
done. This means there will be no output difference image or stats table. If
neither a bad pixel mask or a master confidence map is specified all stats
are done assuming all pixels are good.
.PP


.SH OPTIONS
.TP
\fB\-\-combtype\fR \fI<str>\fR
Combination algorithm (str; default: \'median\'). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_dark_combine.combtype\fR [default = \fImedian\fR].
.TP
\fB\-\-scaletype\fR \fI<str>\fR
Scaling algorithm (str; default: \'additive\'). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_dark_combine.scaletype\fR [default = \fIadditive\fR].
.TP
\fB\-\-xrej\fR \fI<bool>\fR
True if using extra rejection cycle (bool; default: True). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_dark_combine.xrej\fR [default = \fITrue\fR].
.TP
\fB\-\-thresh\fR \fI<float>\fR
Rejection threshold in sigma above background (float; default: 5.0). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_dark_combine.thresh\fR [default = \fI5.0\fR].
.TP
\fB\-\-ncells\fR \fI<int>\fR
Number of cells for data channel stats (int; default: 8). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_dark_combine.ncells\fR [default = \fI8\fR].
.TP
\fB\-\-prettynames\fR \fI<bool>\fR
Use pretty output file names? (bool; default: False). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_dark_combine.prettynames\fR [default = \fIFalse\fR].

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

.SH SEE ALSO
The full documentation for the hawki pipeline can be downloaded as 
a PDF file using the following URL:
.IP
.B ftp://ftp.eso.org/pub/dfs/pipelines/hawki/hawki\-pipeline\-manual\-2.4.11.pdf
.PP
An overview over the existing ESO pipelines can be found on the web page
\fBhttps://www.eso.org/sci/software/pipelines/\fR.
.PP
Basic documentation about the EsoRex program can be found at the esorex (1) 
man page.
.PP
It is possible to call the pipelines from python using the python\-cpl package.
See \fBhttps://packages.python.org/python\-cpl/index.html\fR for further
information.
.PP
The other recipes of the hawki pipeline are
.IR hawki_cal_dark (7),
.IR hawki_cal_distortion (7),
.IR hawki_cal_flat (7),
.IR hawki_cal_zpoint (7),
.IR hawki_detector_noise (7),
.IR hawki_linearity_analyse (7),
.IR hawki_sci_jitter (7),
.IR hawki_science_postprocess (7),
.IR hawki_science_process (7),
.IR hawki_standard_process (7),
.IR hawki_step_apply_dist (7),
.IR hawki_step_basic_calib (7),
.IR hawki_step_combine (7),
.IR hawki_step_compute_bkg (7),
.IR hawki_step_detect_obj (7),
.IR hawki_step_photom_2mass (7),
.IR hawki_step_refine_offsets (7),
.IR hawki_step_stats (7),
.IR hawki_step_stitch (7),
.IR hawki_step_subtract_bkg (7),
.IR hawki_tec_filtchk (7),
.IR hawki_twilight_flat_combine (7),
.IR hawki_util_gendist (7),
.IR hawki_util_stdstars (7)

.SH VERSION
hawki_dark_combine 2.4.11

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

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

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