man/vhisto.1

   1 .TH GPIV_VHISTO 1 "8 November 2006"
   2 .SH NAME
   3 gpiv_vhisto \- Tests PIV data by printing/displaying an histogram of
   4 the vertical particle displacements.
   5 .SH SYNOPSIS
   6 \fBgpiv_vhisto\fP
   7 [\fB-g\fR]
   8 [\fB-h\fR | \fB--help\fR]
   9 [\fB-n \fIN\fR\fR]
  10 [\fB-p\fR | \fB--print\fR]
  11 [\fB-v\fR | \fB--version\fR]
  12 [\fIfilename\fR]
  13 < \fIstdin\fR > \fIstdout\fR
  14
  15 \fP
  16
  17 .SH DESCRIPTION
  18
  19 \fBGpiv_vhisto\fP calculates the histogram of the vertical particle
  20 displacement distribution between minimum and maximum values.
  21
  22 The parameters read from the configuration resources (containing the
  23 key \fBVALID\fR) may be overruled by the command line options, as
  24 explained below.
  25
  26 .SH Options
  27 .TP
  28 \fB-g\fP
  29 Graphical visualization of the histogram with gnuplot.
  30
  31 .TP
  32 \fB-h\fR | \fB--help\fP
  33 On-line help
  34
  35 .TP
  36 \fB-n \fIN\fR
  37 Override number of bins (default 10, hard coded).
  38
  39 .TP
  40 \fB-p\fR | \fB--print\fP
  41 Print parameters, command line options and eventually used input and
  42 output filenames to stdout.  The output is
  43 identic of \fIfilename\fB.par\fR, in case \fB-f\fP is used.
  44
  45 .TP
  46 \fB-v\fR | \fB--version\fP
  47 Print version information on standard output, then exit successfully.
  48
  49 .TP
  50 \fIfilename\fR
  51 Input PIV file. Overrides stdin and stdout. Output will be written to
  52 \fIfilename\fB.pdf\fR. The parameters will be written or appended
  53 to \fIfilename\fB.par\fR and may be used for future use by including them
  54 in \fI./gpivrc\fR.
  55
  56 .SH SEE ALSO
  57 gpivtools
  58
  59 .SH NOTES
  60 stdin and stdout has still to be implemented.
  61 [\fB-f\fR \fIfilename \fR] will be added.
  62
  63 .SH AUTHOR
  64 Gerber Van der Graaf
  65
  66 .SH BUGS
  67 The program seems to work fine with real PIV data.  So far, no
  68 serious bugs have been found.