.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HUGIN_STACKER ""1"""
.TH HUGIN_STACKER """1""" 2024-03-20 """Version: 2023.0.0""" HUGIN
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
hugin_stacker \- stack overlapping images to a single image
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBhugin_stacker\fR [options] \-\-mode=STRING images
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBhugin_stacker\fR acts on a stack of overlapping images and produces a combined image
and/or a set of masked output images.
.PP
\&\fBhugin_stacker\fR is useful for e.g.
.IP \(bu 4
automatic tourist removal (not only tourists, also other moving
objects ;\-))
.IP \(bu 4
noise reduction
.IP \(bu 4
visualize movement
.IP \(bu 4
multiplicity
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-mode\fR 4
.IX Item "--mode"
Select stack mode:
.RS 4
.IP \fBmin|minimum|darkest\fR 4
.IX Item "min|minimum|darkest"
Select the darkest pixel.
.IP \fBmax|maximum|brightest\fR 4
.IX Item "max|maximum|brightest"
Select the brightest pixel.
.IP \fBavg|average|mean\fR 4
.IX Item "avg|average|mean"
Calculate the mean for each position.
.IP \fBmedian\fR 4
.IX Item "median"
Calculate the median for each position.
.IP \fBwinsor\fR 4
.IX Item "winsor"
Calculate the Winsor trimmed mean for each position.
The parameter can be set with \fB\-\-winsor\-trim=NUMBER\fR (default: 0.2).
.IP \fBsigma\fR 4
.IX Item "sigma"
Calculate the sigma clipped mean for each position.
Fine-tune with \fB\-\-max\-sigma=NUMBER\fR (default: 2)
and \fB\-\-max\-iterations=NUMBER\fR (default: 5).
.RE
.RS 4
.RE
.SS "Further parameters"
.IX Subsection "Further parameters"
.IP \fB\-\-output=FILE\fR 4
.IX Item "--output=FILE"
Set the filename for the output file (if not given final.tif is used).
.IP \fB\-\-compression=value\fR 4
.IX Item "--compression=value"
Set the compression of the output files.
For jpeg files use values between 0 and 100.
For tiff files valid values are: PACKBITS, DEFLATE, LZW.
.IP \fB\-\-bigtiff\fR 4
.IX Item "--bigtiff"
Write output in BigTIFF format (only with TIFF output).
.SS "Mask input images"
.IX Subsection "Mask input images"
.IP \fB\-\-mask\-input\fR 4
.IX Item "--mask-input"
Beside the stacked output hugin_stacker can also mask the
input images (available only for stacking modes median|winsor|clip). This mode
is activated with \-\-mask\-input. In this case the stacked image is first
calculated. Then each pixel in each image is checked: if the value of this
pixel differs more then mask sigma * standard deviation from the mean/median,
this pixel is made visible. If it is in the mentioned range the pixel is masked
out.
.IP \fB\-\-mask\-sigma=NUMBER\fR 4
.IX Item "--mask-sigma=NUMBER"
sets the sigma parameter for \-\-mask\-input. Default is 2.
.IP \fB\-\-mask\-suffix=STRING\fR 4
.IX Item "--mask-suffix=STRING"
Output a separate mask image for each input image named \fIinputfilenameSTRING\fR.
Default value is "_mask".
.IP \fB\-\-multi\-layer\-output\fR 4
.IX Item "--multi-layer-output"
Output a layered TIFF with the name specified
with \fB\-\-output\fR. The file contains the averaged image as layer 0 and all input images
as additional layers with the mask as described above.
.SH AUTHORS
.IX Header "AUTHORS"
POD-format documentation converted from <https://wiki.panotools.org/Hugin_stacker> by
Andreas Metzler