added 'Substitute all FNAME occurrences' option
[gpivtools.git] / man / gpiv_aint.1
blob283747f34dee8da448a7c6824a047bd69ab5a3d3
1 .TH GPIV_AINT 1 "7 November 2006"
2 .SH NAME
4 gpiv_aint \- Calculates mean image intensity at each interrogation area.
6 .SH SYNOPSIS
8 \fBgpiv_aint\fP
9 [\fB-h\fR | \fB--help\fR] 
10 [\fB-p\fR | \fB--print\fR] 
11 [\fB-s\fR | \fB--second\fR]
12 [\fB-V\fR | \fB--verbose\fR]
13 [\fB-v\fR | \fB--version\fR] 
14 \fIfilename\fR
16 .SH DESCRIPTION
18 For each Interrogation Area of an image, \fBgpiv_aint\fP calculates
19 the mean image intensity. Depending on the settings of the
20 interrogation scheme, the Interrogation Area's may be shifted with
21 magnitude of the piv estimators (if they exist) or the image may be
22 deformed before the intensity is calculated.
24 This program uses the \fBIMG\fR, \fBPIV\fR and \fBPOST\fR parameters.
25 The default settings may be overruled by the command line options, as
26 explained below.
28 .SH Options 
29 .TP 
30 \fB-h\fR | \fB--help\fR
31 On-line help.
33 .TP 
34 \fB-p\fR | \fB--print\fR
35 Prints parameters to stdout.
37 .TP 
38 \fB-s\fR | \fB--second\fR
39 Calculates the image intensitites for the second image frame in case
40 of double-frame image pairs.
42 .TP
43 \fB-V\fR | \fB--verbose\fR
44 Prints data of interrogation area's and resulting mean.
46 .TP
47 \fB-v\fR | \fB--version\fR
48 Print version information on standard output, then exit successfully.
50 .TP
51 \fIfilename\fR 
52 Full name of the image file. Image format might be: png, raw binary
53 (.r), hdf5 (.hdf), gif, tif, bmp or pgm. The piv estimators are read
54 from \fIfilename\fB.piv\fR The settings are written to
55 \fIfilename\fB.par\fR. output will be stored in \fIfilename\fB.ain\fR.
58 .TP
60 .SH SEE ALSO
61 gpivtools
63 .SH NOTES
64 The program uses \fBnetpbm\fR.
66 .SH AUTHOR
67 Gerber Van der Graaf