added 'Substitute all FNAME occurrences' option
[gpivtools.git] / man / gpiv_recimg.1
blob02f7e7ca27f147531d994c7b6470a0d592971be2
1 .TH GPIV_RECIMG 1 "19 Januari 2005"
2 .SH NAME
3 gpiv_recimg \- captures images from a IIDC-compliant camera with IEE1394 
4 connection.
5 .SH SYNOPSIS
7 \fBgpiv_recimg\fP 
8 [\fB-f \fIfilename\fR]
9 [\fB-h\fR | \fB--help\fR]
10 [\fB-v\fR | \fB--version\fR]  
11 [\fB-V\fR | \fB--verbose\fR]  
12 [\fB-x\fR | \fB--x_corr\fR]  
13 < \fIstdin\fR > \fIstdout\fR
15 \fP
17 .SH DESCRIPTION
19 \fBgpiv_recimg\fP records image pairs for Particle Image velocimetry
20 (PIV). The code supports IIDC-compliant cameras that are connected to
21 the computer with IEEE1394.  Such an image pair may be analysed by
22 gpiv_rr in the cross-correlation mode for PIV.
24 This program uses the \fBIMG\fR parameters. The command line options
25 are explained below.
27 .SH Options 
28 \fB-f \fIfilename\fR 
29 Overrides stdin and stdout with \fIfilename\fR. The filename has to be
30 given without its \fB.r\fR extension. Output will be written to
31 \fIfilename\fB.r\fR.
32 .TP
33 \fB-h\fR | \fB--help\fP 
34 On-line help.
35 .TP
36 \fB-v\fR | \fB--version\fP
37 Print version information on standard output, then exit successfully.
38 .TP
39 \fB-V\fR | \fB--verbose\fP
40 program behaves more verbose during operation showing what is going on
41 .TP
42 \fB-x\fR | \fB--x_corr\fR
43 Records two succesive image frames for cross-correlation and stores as
44 a single image. In this case, \fBgpiv_combing\fR is not needed.
46 .SH SEE ALSO
47 gpivtools
49 .SH AUTHOR
50 Gerber Van der Graaf
52 .SH BUGS
53 The program is still in a very prelimary state.