cleanup autotools and CVS directories
[gpivtools.git] / man / gpiv_piv2hdf.1
blobf7ba0ac97f78724927839882030f9326dc111ed9
1 .TH GPIV_PIV2HDF 1 "10 November 2006"
2 .SH NAME
3 gpiv_piv2hdf \- Converts PIV-data HDF5 format.
4 .SH SYNOPSIS
6 \fBgpiv_piv2hdf\fP 
7 [\fB-e\fR]
8 [\fB-h\fR | \fB--help\fR] 
9 [\fB-p\fR | \fB--print\fR] 
10 [\fB-v\fR | \fB--version\fR] 
11 [\fB-V\fR | \fB--verbose\fR] 
12 \fIfilename\fR
14 \fP
16 .SH DESCRIPTION
18 \fBgpiv_piv2hdf\fP converts ASCII-formattd PIV-data
19 (\fIfilename\fB.piv\fR), derived data, like vorticities
20 (\fIfilename\fB.vor\fR), strain (\fIfilename\fB.sstr\fR,
21 \fIfilename\fB.nstr\fR) and, eventually, raw data images
22 (\fIfilename\fB.r\fR), to a HDF5 formatted file
23 \fIfilename\fB.hdf\fR. The parameters that have been used for the
24 analysis and post processing are included in \fIfilename\fB.hdf\fR.
26 This program does not use the parameter resources from libgpiv. The
27 parameters may be defined by the command line options as explained
28 below.
30 .SH Options 
32 .TP
33 \fB-e\fR
34 Exclude PIV data and data from post-processes.
36 .TP
37 \fB-h\fR | \fB--help\fR
38 On-line help.
40 .TP
41 \fB-i\fR
42 Includes image data.
44 .TP
45 \fB-p\fR | \fB--print\fR
46 Prints parameters, command line options and input and output filenames
47 to stdout. The output may be used as parameters of \fBfasty\fP for
48 future use by re-directing stdout to \fIfasty.par\fR.
50 .TP
51 \fB-v\fR | \fB--version\fR
52 Print version information on standard output, then exits successfully.
54 .TP
55 \fB-V\fR | \fB--verbose\fR
56 Program behaves more verbose by printing messages to stdout.
58 .TP
59 \fIfilename\fR
60 Input PIV data filename, including .piv extension.
62 .SH SEE ALSO
63 gpivtools
66 .SH AUTHOR
67 Gerber Van der Graaf