OMP bugrepair
[gpivtools.git] / man / getbit.1
blob4e01d9758b76ad26d6eaaafa39b1bbbfe71f667c
1 .TH GPIV_GETBIT 1 "7 November 2006"
2 .SH NAME
3 gpiv_getbit \- Image processing program for PIV images.
4 .SH SYNOPSIS
6 \fBgpiv_getbit\fP
7 [\fB-b \fIN\fR] 
8 [\fB-h\fR | \fB--help\fR] 
9 [\fB-p\fR | \fB--print\fR] 
10 [\fB-v\fR | \fB--version\fR] 
11 [\fIfilename\fR] 
12 < \fIstdin\fR > \fIstdout\fR
14 \fP
16 .SH DESCRIPTION
18 \fBgpiv_getbit\fP get the N least significant bits and moves them to
19 most the significant bits. This results that a weak image signal
20 (pixels of low value) is amplified while the high signal within the
21 image will be removed.
23 The parameters read from the configuration resources (containing the
24 key \fBGPIV_IMGPROC\fR) may be overruled by the command line options, as
25 explained below.
27 .SH Options 
28 .TP 
29 \fB-b \fIN\fP
30 Defines the bit number [0, .., 7]. Signal from 0 to \fIN\fP will be
31 shifted.
33 .TP
35 \fB-h\fR | \fB--help\fP
36 On-line help
37 .TP
39 \fB-v\fR | \fB--version\fP
40 Print version information on standard output, then exit successfully.
41 .TP 
43 \fIfilename\fR 
44 Input image filename. Overrides \fIstdin\fR and \fIstdout\fR with the full \fIfilename\fR of
45 the image. Output will be written to \fIfilename\fB.png\fR. Parameters
46 are stored in \fIfilename\fB.par\fR and may be used for future use by
47 including them in \fI./gpivrc\fR. If \fIstdin\fR and \fIstdout\fR are
48 used, the input is expected to be a PNG formatted image.
49 .TP
52 .SH SEE ALSO
53 gpivtools
55 .SH AUTHOR
56 Gerber Van der Graaf