.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH LIMEREG "1" "November 2018" "limereg 1.4.1" "User Commands"
.SH NAME
limereg \- Lightweight Image Registration
.SH SYNOPSIS
.B limereg
\fI\,--rfile <reference image> --tfile <template image> \/\fR[\fI\,OPTIONS\/\fR]
.SH DESCRIPTION
limereg 1.4.1
.PP
limereg \- Lightweight Image Registration
Performs a simple rigid image registration. The image files must have equal size.
Supported image formats: *.bmp, *.dib, *.jpeg, *.jpg, *.jpe, *.jp2, *.png, *.pbm,
*.pgm, *.ppm, *.sr, *.ras, *.tiff, *.tif.
.SH OPTIONS
.TP
\fB\-\-help\fR
Show usage information.
.TP
\fB\-\-version\fR
Show application version and copyright information.
.TP
\fB\-\-rfile\fR arg
Template image file (will be transformed). The
template and reference images must be equal in size.
.TP
\fB\-\-tfile\fR arg
Reference image file (will be matched against). The
template and reference images must be equal in size.
.TP
\fB\-\-outfile\fR arg
Output image file (optional). Gives the option to save
the registered template image as grayscale result.
.TP
\fB\-\-maxiter\fR arg
Max. amount of iterations.
[Optional parameter, default: 150]
.TP
\fB\-\-levels\fR arg
Amount of levels in the multilevel pyramid of shrinked
image copies. 0 means autodetect by the formula
log2(ImageWidth/32).
[Optional parameter, default: 0]
.TP
\fB\-\-maxrot\fR arg
Max. expected rotation in degrees. Used for internal
optimizations in DSP calculation mode. If a rotation
value will become necessary that is higher than
specified here, the algorithm will still succeed but
the calculation speed will slow down).
[Optional parameter, default: 20]
.TP
\fB\-\-maxtrans\fR arg
Max. expected translation in percent. Used for
internal optimizations in DSP calculation mode. If a
translation value will become necessary that is higher
than specified here, the algorithm will still succeed
but the calculation speed will slow down).
[Optional parameter, default: 30]
.TP
\fB\-\-invert\fR
Invert the internal grayscale representation. Best
registration results are usually obtained with bright
content on a dark background, consider setting this
parameter, if you have dark content on a bright
background. This setting affects only the internal
operation, it will not be visible on GUI or file
output images.
[Flag parameter]
.TP
\fB\-\-stopsens\fR arg
Sensitivity of the STOP criteria for the gauss\-newton
algorithm.
[Optional parameter, use ranges between 1 (not
sensitive, stops early) to 0.0001 (very sensitive)
default: 0.1]
.TP
\fB\-\-cdn\fR arg
Clip dark pixels until (including) the given luminance
to zero. This reduces image sensor noise in the
usually uninteresting dark pixels. A high value
optimizes data compression and calculation performance
at the cost of calculation accuracy.
[Optional parameter, range 0...255, 0 disables any
clipping, default: 10]
.TP
\fB\-\-nogui\fR
If active no GUI output will be shown. Use this for
batch registration of several images.
[Flag parameter]
.SH EXAMPLES
limereg \-\-tfile t.jpg \-\-rfile r.png
Shifts/Rotates t.jpg for alignment with r.png and displays the result.
.PP
limereg \-\-tfile t.bmp \-\-rfile r.tif \-\-nogui \-\-outfile o.jpg
Outputs the result to o.jpg, no GUI display.
:
.SH COPYRIGHT
Copyright 2014, Roelof Berg, Licensed under the 3\-clause BSD license at http://berg\-solutions.de/limereg\-license.html. Credit goes to Lars Koenig and Jan Ruehaak from Fraunhofer MEVIS in Germany.
.SH "SEE ALSO"
The full documentation for
.B limereg
is maintained as a Texinfo manual.  If the
.B info
and
.B limereg
programs are properly installed at your site, the command
.IP
.B info limereg
.PP
should give you access to the complete manual.