man/gpiv_s-avg.1

   1 .TH GPIV_S-AVG 1 "8 November 2006"
   2 .SH NAME
   3 gpiv_s-avg \- Spatial statistics of PIV data.
   4 .SH SYNOPSIS
   5
   6 \fBgpiv_s-avg\fP
   7 [\fB-h\fR | \fB--help\fR]
   8 [\fB-p\fR | \fB--print\fR]
   9 [\fB-s\fR]
  10 [\fB-no_s\fR]
  11 [\fB-v\fR | \fB--version\fR]
  12 [\fIfilename\fP]
  13 < \fIstdin\fR > \fIstdout\fR
  14
  15 \fP
  16
  17 .SH DESCRIPTION
  18
  19 \fBgpiv_s-avg\fP reports the spatial global mean velocities and
  20 variances in x and y-direction of a PIV data stream. Only input data
  21 of which the peak number is not equal to -1 are taken into
  22 account.
  23
  24 The parameters read from the configuration resources (containing the
  25 key \fBPOST\fR) may be overruled by the command line options, as
  26 explained below.
  27
  28
  29 .SH Options
  30 .TP
  31 \fB-h\fR | \fB--help\fP
  32 On-line help.
  33
  34 .TP
  35 \fB-p\fR | \fB--print\fP
  36 Prints parameters, command line options and input and eventually filenames
  37 to stdout.  The output is identic of \fIfilename\fB.par\fR, in case
  38 \fB-f\fP is used.
  39 .TP
  40 \fB-s\fR
  41 Subtracts the mean x-and y-particle displacements from the input data.
  42
  43 .TP
  44 \fB-no_s\fR
  45 Suppresses subtracting the mean values from the input data.
  46
  47 .TP
  48 \fB-v\fR | \fB--version\fP
  49 Prints version information on standard output, then exits successfully.
  50
  51 .TP
  52 [\fB-z \fIdx0 dy0\fR]
  53 zero offset of displacement or velocity estimators.
  54
  55 .TP
  56 \fIfilename\fR
  57 Input PIV file. Overrides stdin and stdout. The output will be
  58 written to \fIfilename\fB.sa.piv\fR. Parameters are stored in
  59 \fIfilename\fB.par\fR and may be used for future use by including them
  60 in \fI./gpivrc\fR.
  61
  62 .TP
  63
  64 .SH SEE ALSO
  65 gpivtools
  66
  67 .SH NOTES
  68
  69 .SH AUTHOR
  70 Gerber Van der Graaf
  71
  72 .SH BUGS
  73 The program has been tested for PIV data. So far, no bugs have been
  74 found.