man/gpiv_t-avg.1

   1 .TH GPIV_T-AVG 1 "19 Januari 2005"
   2 .SH NAME
   3 gpiv_t-avg \- Calculates time-averaged mean and variances of PIV data.
   4 .SH SYNOPSIS
   5
   6 \fBgpiv_t-avg\fP
   7 [\fB-dn\fR | \fB--dir_name \fIdir basename\fR]
   8 [\fB-df\fR | \fB--first_dir \fIN\fR]
   9 [\fB-dl\fR | \fB--last_dir \fIN\fR]
  10 [\fB-fb\fR | \fB--file_basename \fIfile basename\fR]
  11 [\fB-ff\fR | \fB--first_file \fIN\fR]
  12 [\fB-fl\fR | \fB--last_file \fIN\fR]
  13 [\fB-fx\fR | \fB--file_prefix\fR]
  14 [\fB-h\fR | \fB--help\fR]
  15 [\fB-n\fR | \fB--none\fR]
  16 [\fB-p\fR | \fB--print\fR]
  17 [\fB-relrms\fR]
  18 [\fB-uv\fR | \fB--print\fR]
  19 [\fB-v\fR | \fB--version\fR]
  20
  21 \fP
  22
  23 .SH DESCRIPTION
  24
  25 \fBgpiv_t-avg\fP calculates mean and variances from a \fBseries\fR of piv
  26 data resulting into time-averaged values. If no parameters are defined
  27 at the command line, standard parameters will be used that are defined
  28 in the script. This program does not use the parameter resources from
  29 libgpiv.
  30
  31 .SH Options
  32 .TP
  33 \fB-dn\fR | \fB--dir_name\fR \fIdir base-name\fR
  34 The \fIdir base-name\fR represents the directory name without its last number. It is supposed that the last number in the directory name is a counter.
  35 .TP
  36 \fB-df\fR | \fB--first_dir\fR \fN\fR
  37 Defines the counter  \fIN\fR of the first directory number at which the analyses starts.
  38 .TP
  39 \fB-dl\fR | \fB--last_dir\fR \fN\fR
  40 Last directory number \fIN\fR at which the analyses ends.
  41 .TP
  42 \fB-fb\fR | \fB--file_base_name\fR \fIfile base-name\fR
  43 The \fIfilename\fR has to be given without its \fB.piv\fR
  44 extension. The \fIfile base-name\fR represents the file name without
  45 its last number, before the extension. If not \fB-fx\fR key is used,
  46 it is supposed that the last number in the file name is a counter. The
  47 output will be written to \fIdir base-name/file base-name\fB.ta_mean.piv\fR
  48 and \fIdirname/filename\fB.ta_sdev.piv\fR at which mean values and variances
  49 are written respectively or to \fIdirname/filename\fB.ta_U.piv\fR and to
  50 \fIdirname/filename\fB.ta_V.piv\fR if \fB-uv\fP is used.
  51 .TP
  52 \fB-ff\fR | \fB--first_file\fR \fN\fR
  53 Defines the counter  \fIN\fRof first file number at which the analyses starts.
  54 .TP
  55 \fB-fl\fR | \fB--last_file\fR \fN\fR
  56 Last file number \fIN\fR at which the analyses ends.
  57 .TP
  58 \fB-fx\fR | \fB--file_prefix\fR
  59 Prefix numbering to file base name.
  60 .TP
  61 \fB-h\fR | \fB--help\fR
  62 On-line help.
  63 .TP
  64 \fB-n\fR | \fB--none\fR
  65 Suppresses real execution.
  66 .TP
  67 \fB-p\fR | \fB--print\fR
  68 Prints parameters, command line options and input and output filenames
  69 to stdout.
  70 .TP
  71 \fB-relrms\fR\fR
  72 Prints relative rms, related to the absolute mean value.
  73 .TP
  74 \fB-uv\fP
  75 Writes U and v displacements/velocities to separate outputs.
  76 .TP
  77 \fB-v\fR | \fB--version\fR
  78 Prints version information to standard output, then exits successfully.
  79 .TP
  80
  81 .SH SEE ALSO
  82 gpivtools
  83
  84 .SH AUTHOR
  85 Gerber Van der Graaf
  86