.TH HAWKI_STEP_COMBINE "7" "2.4.11" "hawki_step_combine" "hawki recipes"
.SH NAME
hawki_step_combine \- (OBSOLETE) Jitter image combination recipe

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

.SH DESCRIPTION
(OBSOLETE) hawki_step_combine \-\- hawki combine jitter images.
.PP
The files listed in the Set Of Frames (sof\-file) must be tagged:
science\-file.fits DIST_CORRECTED or
science\-file.fits BKG_SUBTRACTED or
bpm\-file.fits BPM (optional) 
bkg_bpm\-file.fits BKG_BPM (optional) 
offsets\-file.fits OFFSETS_REFINED (optional) 
The recipe creates as an output:
hawki_step_combine.fits (COMBINED): 
The recipe does the following steps:
\-Allocate an image with the proper combined size 
   (depends on parameters \-\-comb_meth and \-\-borders)
\-Retrieve the offsets either from the offsets\-file.fits or from the header
\-For each combined pixel, the contribution of each individual frame 
   is added using a resampling kernel. If any of the pixels involved in
   the resampling is a bad pixel (defined in bpm\-file.fits), it is not
   taken into account.
.PP
   With the remaining pixels a minmax rejection is performed
Return code:
esorex exits with an error code of 0 if the recipe completes successfully
or 1 otherwise

.SH OPTIONS
.TP
\fB\-\-offset_max\fR \fI<int>\fR
Maximum offset allowed (int; default: 1500). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_step_combine.offset_max\fR [default = \fI1500\fR].
.TP
\fB\-\-comb_meth\fR \fI<str>\fR
Final size of combination (union / inter / first) (str; default:
\'union\'). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_step_combine.comb_meth\fR [default = \fIunion\fR].
.TP
\fB\-\-rej\fR \fI<str>\fR
Low and high number of rejected values (str; default: \'1,1\'). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_step_combine.rej\fR [default = \fI1,1\fR].
.TP
\fB\-\-borders\fR \fI<int>\fR
Border pixels trimmed (int; default: 4). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_step_combine.borders\fR [default = \fI4\fR].
.TP
\fB\-\-resamp_kernel\fR \fI<str>\fR
Resampling kernel (default/tanh/sinc/sinc2/lanczos/hamming/hann) (str;
default: \'default\'). The full name of this option for the EsoRex configuration
file is \fBhawki.hawki_step_combine.resamp_kernel\fR [default = \fIdefault\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_dark_combine (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_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_step_combine 2.4.11

.SH AUTHOR
ESO Pipeline Group <https://support.eso.org>

.SH BUG REPORTS
Please report any problems to https://support.eso.org. 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) 2002,2011 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 Street, Fifth Floor, Boston, 
MA 02110\-1301 USA