doc/C/s-avg.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5 [\fB-h\fR]
   6 [\fB-p\fR]
   7 [\fB-s | \fB--s\fR]
   8 [\fB-v\fR]
   9 < \fIstdin\fR &gt; \fIstdout\fR
  10
  11 \fP
  12
  13 .SH DESCRIPTION
  14
  15 \fBs-avg\fP s-avg reports the spatial global mean velocities and
  16 variances in x and y-direction of a PIV data stream. Only input data
  17 of which the peak number is not equal to -1 are taken into
  18 account.
  19
  20 The parameters and options to be used for \fBs-avg\fP are subsequently
  21 searched in \fgpivrc\fP at local directory
  22 , at
  23 \fI~/.gpivrc\fR or at \fI/etc/gpivrc\fR. Each parameter is described by the program key
  24 (POST) and the parameter name, separated by a dot (.), followed by its
  25 value. The parameters may be defined in arbitrary order. Blank lines
  26 and comment (starting with a pound sign (#) at the first column) may
  27 be included in the parameter files.  The parameters may be overruled
  28 by the command line options, as explained below.
  29
  30 .SH Options
  31 .TP
  32 \fB-f \fIfilename\fR
  33 Overrides stdin and stdout with \fIfilename\fR. The \fIfilename\fR has
  34 to be given without its \fB.piv\fR extension. The output will be
  35 written to \fIfilename\fB.sa.piv\fR. The parameters will be written or
  36 appended to \fIfilename\fB.par\fR.
  37 .TP
  38 \fB-h\fP
  39 On-line help.
  40 .TP
  41 \fB-p\fP
  42 Prints parameters, command line options and input and output filenames
  43 to stdout. The output may be used as parameters of \fBs-avg\fP for
  44 future use by re-directing stdout to \fIs-avg.par\fR.
  45 .TP
  46 \fB-s\fR
  47 Subtracts the mean x-and y-particle displacements from the input data.
  48 .TP
  49 \fB--s\fR
  50 Suppresses subtracting the mean values from the input data.
  51 .TP
  52 \fB-v\fP
  53 Prints version information on standard output, then exits successfully.
  54 .TP
  55 [\fB-z \fIdx0 dy0\fR]
  56 zero offset of displacement or velocity estimators.
  57 </PRE>
  58 <HR>
  59 <ADDRESS>
  60 Man(1) output converted with
  61 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  62 </ADDRESS>
  63 </BODY>
  64 </HTML>