added 'Substitute all FNAME occurrences' option
[gpivtools.git] / man / gpiv_t-corr.1
blobac7c9622ccc50ac8f83a658420c65416fa02e4a8
1 .TH GPIV_T-CORR 1 "19 Januari 2005"
2 .SH NAME
3 gpiv_t-corr \- calculates the Eulerian correlation from a series of
4 PIV data sets
5 .SH SYNOPSIS
7 \fBgpiv_t-corr\fP 
8 [\fB-h\fR | \fB--help\fR] 
9 [\fB-p\fR | \fB--print\fR] 
10 [\fB-v\fR | \fB--version\fR] 
11 [\fB-f\fR | \fB--file_first\fR \fIN\fR]  
12 [\fB-l\fR | \fB--file_last\fR \fIN\fR]
13 [\fB-x\fR | \fB--point_x\fR \fIF\fR] 
14 [\fB-y\fR | \fB--point_y\fR \fIF\fR] 
15 \fIfile_basename\fR
17 \fP
19 .SH DESCRIPTION
21 \fBgpiv_t-corr\fP calculates the Eulerian correlation from a series of
22 PIV data sets.
24 The parameters may be defined by the command line options as explained
25 below.
27 .SH Options 
28 \fB-h\fR | \fB--help\fR
29 On-line help.
30 .TP
31 \fB-p\fR | \fB--print\fR
32 Prints parameters to stdout.
33 .TP
34 \fB-v\fR | \fB--version\fR
35 Print version information on standard output, then exits successfully.
36 .TP
37 \fB-f\fR | \fB--file_first\fR \fIN\fR
38 First file number of the series (default: 0).
39 .TP
40 \fB-l\fR | \fB--file_last\fR \fIN\fR
41 Last file number of the series (default: 0).
42 .TP
43 \fB-x\fR | \fB--point_x\fR \fIF\fR
44 X-position of data set to be analysed (default: 0.0).
45 .TP
46 \fB-y\fR | \fB--point_y\fR \fIF\fR
47 Y-position of data set to be analysed (default: 0.0).
48 .TP
49 \fIfile_basename\fR
50 File _basename of a numbered series of PIV data sets.
52 .SH SEE ALSO
53 gpivtools
56 .SH AUTHOR
57 Gerber Van der Graaf