cleanup autotools and CVS directories
[gpivtools.git] / man / gpiv_hdf2piv.1
blob980b9b7c91fa08ccda9f464fddb77901c1c183f9
1 .TH GPIV_HDF2PIV 1 "19 Januari 2005"
2 .SH NAME
3 gpiv_hdf2piv \- Converts HDF5 PIV-data to ASCII data.
4 .SH SYNOPSIS
6 \fBgpiv_hdf2piv\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 \fIfilename\fR
13 \fP
15 .SH DESCRIPTION
17 \fBgpiv_hdf2piv\fP converts a HDF5 formatted file
18 \fIfilename\fB.hdf\fR, containing PIV-data, PIV derived data, like
19 vorticities, strain etc to (ASCII formatted) \fIfilename\fB.piv\fR.,
20 \fIfilename\fB.vor\fR, \fIfilename\fB.sstr\fR, \fIfilename\fB.nstr\fR
21 and, eventually, image(s) to (PNG formatted) \fIfilename\fB.png\fR
22 files. The parameters that have been used for the analysis and post
23 processing are written to \fIfilename\fB.par\fR
25 This program does not use the parameter resources from libgpiv. The
26 parameters may be defined by the command line options as explained
27 below.
29 .SH Options 
30 .TP
31 \fB-e\fR
32 Exclude PIV data and data from post-processes. Only convert image data.
34 .TP
35 \fB-h\fR | \fB--help\fR
36 On-line help.
38 .TP
39 \fB-p\fR | \fB--print\fR
40 Prints parameters, command line options and input and output filenames
41 to stdout. The output may be used as parameters of \fBfasty\fP for
42 future use by re-directing stdout to \fIfasty.par\fR.
44 .TP
45 \fB-v\fR | \fB--version\fR
46 Print version information on standard output, then exits successfully.
48 .TP
49 \fIfilename\fR
50 Full input file name, hdf formatted (including \fB.hdf\fR extension)
52 .TP
53 .SH SEE ALSO
54 gpivtools
57 .SH AUTHOR
58 Gerber Van der Graaf