.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH FICOMBINE "1" "January 2021" "ficombine 0.9.4 (2021.01.24)" "User Commands"
.SH NAME
ficombine \- combining (most frequently, averaging) a set of images
.SH SYNOPSIS
.B ficombine
[\fI\,options\/\fR] \fI\,<input images> \/\fR[\fI\,-o|--output <output>\/\fR]
.SH DESCRIPTION
The purpose of this program is to combine the input images (with the same sizes) to a single image. This combination refers to a kind of "averaging" for the images, however, other modes are also available.
.SH OPTIONS
.SS "General options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Gives general summary about the command line options.
.TP
\fB\-\-long\-help\fR, \fB\-\-help\-long\fR
Gives a detailed list of command line options.
.TP
\fB\-\-wiki\-help\fR, \fB\-\-help\-wiki\fR, \fB\-\-mediawiki\-help\fR, \fB\-\-help\-mediawiki\fR
Gives a detailed list of command line options in Mediawiki format.
.TP
\fB\-\-version\fR, \fB\-\-version\-short\fR, \fB\-\-short\-version\fR
Gives some version information about the program.
.TP
\fB\-o\fR, \fB\-\-output\fR <fits>
The name of the output file (omitting or specifing '\-' yields the output to be written to stdout).
.TP
\fB\-\-history\fR, \fB\-\-no\-history\fR
Incude or exclude the command line of the invoking `ficombine` call. By default, the command line is added into the FITS headers (FI_HSTRY) but if there are enormous amount of input files, one can use \fB\-\-no\-history\fR to omit the respective lengthy keywords.
.TP
\fB\-\-data\fR <spec>
Output pixel data format specification.
.TP
\fB\-b\fR, \fB\-\-bitpix\fR <bitpix>
Standard FITS output bitpix value.
.TP
\fB\-M\fR, \fB\-\-input\-mask\fR <fits>
Input mask file to co\-add to output image.
.SS "Generic combination specification:"
.TP
\fB\-m\fR, \fB\-\-mode\fR <mode>
Use the specified mode to combine images.
.TP
\fB\-n\fR, \fB\-\-ignore\-negative\fR
Ignore (i.e. mask) pixels with negative values.
.TP
\fB\-\-logical\-or\fR
Use logical "or" combination between masks.
.TP
\fB\-\-logical\-and\fR
Use logical "and" combination between masks.
.SS "Combination modes (a comma-separated list of these should follow -m|--mode):"
.TP
mean
The mean value of the pixels.
.TP
median
The median value of the pixels.
.TP
min, minimum
The minimum value of the pixels.
.TP
max, maximum
The maximum value of the pixels.
.TP
rejmed, rejection
Median value after rejecting outliers.
.TP
rejmean
Mean value after rejecting outliers.
.TP
iterations=<n>
Number of iterations to reject outliers.
.TP
lower=<l>, upper=<u>, sigma=<s>
Outlier limit (lower, upper, both) in standard deviation. Note that setting sigma to some value is equivalent to setting 'lower' and 'upper' to the same value simultaneously.
.TP
truncated
Truncated mean.
.TP
winsorized
Winsorized mean.
.TP
lowest=<cnt>, highest=<cnt>, discard=<cnt>
Reject the 'lowest' and 'highest' count of points when computing truncated or winsorized mean. Setting 'discard' to some value is equivalent to setting 'lowest' and 'highest' to this value simultaneously.
.TP
sum
Sum of the pixel values.
.TP
squaresum
Sum for the squarers of the pixel values.
.TP
scatter, stddev
Pixel scatter (standard deviation).
.TP
or
Use logical "or" combination between masks.
.TP
and
Use logical "and" combination between masks.
.TP
ignorenegative
Ignore (i.e. mask) pixels with negative values.
.TP
ignorezero
Ignore (i.e. mask) pixels with a zero value.
.TP
ignorenegative
Ignore (i.e. mask) pixels with positive values.
.SH "REPORTING BUGS"
Report bugs to <apal@szofi.net>, see also https://fitsh.net/.
.SH COPYRIGHT
Copyright \(co 1996, 2002, 2004\-2008, 2010\-2016, 2018\-2020; Pal, Andras <apal@szofi.net>