debian/gpiv.1

   1 .TH GPIV 1 "10 July 2003"
   2 .SH NAME
   3 gpiv \- Analyzes images obtained from a fluid flow by Particle Image
   4 Velocimetry.
   5
   6 .SH SYNOPSIS
   7
   8 \fBgpiv\fP
   9 [\fB-? | --help\fR]
  10 \fB--usage\fR]
  11 [\fB-b\fR | \fB--bins \fIBINS\fR]
  12 [\fB-c\fR | \fB--columns \fINCOLUMNS\fR]
  13 [\fB-r\fR | \fB--rows \fINROWSS\fR]
  14 [\fB-r\fR | \fB--rows \fINROWSS\fR]
  15 [\fB--display_img1\fR]
  16 [\fB--display_img2\fR]
  17 [\fB--display_intregs\fR]
  18 [\fB--display_piv\fR]
  19 [\fB--display_vor\fR]
  20 [\fB--display_sstrain\fR]
  21 [\fB--display_nstrain\fR]
  22 [\fB--hdf\fR]
  23 [\fB--hdf_img\fR]
  24 [\fB-p\fR | \fB--print\fR]
  25 [\fB--proc_piv\fR]
  26 [\fB--proc_gradient\fR]
  27 [\fB--proc_resstatst\fR]
  28 [\fB--proc_errvec\fR]
  29 [\fB--proc_peaklock\fR]
  30 [\fB--proc_average\fR]
  31 [\fB--proc_scale\fR]
  32 [\fB--proc_substract\fR]
  33 [\fB--proc_vorstra\fR]
  34 [\fB-z\fR | \fB--zoomscale \fISCALE\fR]
  35 [\fB-t\fR | \fB--tooltips\fR]
  36 [\fB--view_gpivbuttons\fR]
  37 [\fB--view_tabulator\fR]
  38
  39 \fP
  40
  41 .SH DESCRIPTION
  42
  43 \fBgpiv\fP is a graphic user interface program for analyzing images
  44 obtained from a fluid flow that has been seeded with tracer particles
  45 by the so-called Particle Image Velocimetry (PIV) technique. It allows
  46 to have a quick overview of the process settings, easily changing
  47 them, running the processes, visualizing and optimizing their results
  48 in an interactive way. The processes that may be performed are image
  49 evaluation or interrogation (resulting into PIV estimators),
  50 validation and post-processing of the PIV estimators.
  51
  52 The settings for the PIV processes are subsequently searched in
  53 \fI/etc/gpivrc\fP (system wide) or in \fI~/.gpivrc\fR. Each PIV
  54 process setting is described by the process key (EVAL, VALID or
  55 POST) and the parameter name, separated by a dot (.), followed by its
  56 value. Some of the parameters are optional. The parameters may be
  57 defined in arbitrary order. Blank lines and comment (starting with a
  58 pound sign (#) at the first column) may be included in the parameter
  59 files.
  60
  61 The parameters and options to be used for \fBgpiv\fP are retrieved
  62 from ~/.gnome/gpiv or default settings are to be used if absent. The
  63 settings may be changed or updated by menu->settings->preferences and
  64 pressing the OK-button. The parameter settings of \fBgpiv\fP (not the
  65 PIV process settings) may be overruled by the command line options, as
  66 explained below.
  67
  68 .SH Options
  69 .TP
  70 \fB-? | --help\fR
  71 On-line help. Besides the options of \fBgpiv\fP it also shows
  72 the additional GNOME, GTK and GNOME GUI options.
  73
  74 .TP
  75 \fB--usage\fR
  76 Display a brief usage message.
  77
  78 .TP
  79 \fB-b | --bins \fIBINS\fR
  80 Number of bins for histograms of estimators at sub-pixel level,
  81 performed by the peaklock process and of the median residues,
  82 performed by the errvec process.
  83
  84 .TP
  85 \fB-c\fR | \fB--columns \fINCOLUMNS\fR
  86 Number of columns in the images. \fINCOLUMNS\fR is limited by the
  87 program as defined in gpiv_gtk.h or by ./configure during the building
  88 of \fBgpiv\fR. Its maximum setting can be found in the Preferences.
  89
  90 .TP
  91 \fB-r\fR | \fB--rows \fINROWSS\fR
  92 Number of rows in the images. \fINROWS\fR is limited by the program as
  93 defined in gpiv_gtk.h or by ./configure during the building of
  94 \fBgpiv\fR. Its maximum setting can be found in the Preferences.
  95
  96 .TP
  97 \fB--display_img1\fR
  98 Enables displaying of the first image of a PIV image pair (not working
  99 in the current version!).
 100
 101 .TP
 102 \fB--display_img2\fR
 103 Enables displaying of the second image of a PIV image pair (not working
 104 in the current version!).
 105
 106 .TP
 107 \fB--display_intregs\fR
 108 Enables displaying of interrogation regions.
 109
 110 .TP
 111 \fB--display_piv\fR
 112 Enables displaying of PIV data.
 113
 114 .TP
 115 \fB--display_vor\fR
 116 Enables displaying of vorticity data.
 117
 118 .TP
 119 \fB--display_sstrain\fR
 120 Enables displaying of shear strain data.
 121
 122 .TP
 123 \fB--display_nstrain\fR
 124 Enables displaying of normal strain data.
 125
 126 .TP
 127 \fB--hdf\fR
 128 Save data in HDF5 format with .gpi extension.
 129
 130 .TP
 131 \fB--hdf_img\fR
 132 Include image data in .gpi file (HDF5 format).
 133
 134 .TP
 135 \fB-p\fR | \fB--print\fR
 136 Print process parameter settings to stdout.
 137
 138 .TP
 139 \fB--proc_piv\fR
 140 Includes piv in the chain-process.
 141
 142 .TP
 143 \fB--proc_gradient\fR
 144 Includes gradient in the chain-process.
 145
 146 .TP
 147 \fB--proc_resstatst\fR
 148 Includes resstats in the chain-process.
 149
 150 .TP
 151 \fB--proc_errvec\fR
 152 Includes validate in the chain-process.
 153
 154 .TP
 155 \fB--proc_peaklock\fR
 156 Includes peaklock in the chain- process.
 157
 158 .TP
 159 \fB--proc_average\fR
 160 Includes average in the chain-process.
 161
 162 .TP
 163 \fB--proc_scale\fR
 164 Includes scaling in the chain-process.
 165
 166 .TP
 167 \fB--proc_substract\fR
 168 Includes substract in the chain-process.
 169
 170 .TP
 171 \fB--proc_vorstra\fR
 172 Includes vorticity in the chain-process.
 173
 174 .TP
 175 \fB-z\fR | \fB--zoomscale \fISCALE\fR
 176
 177 Display zoom index:
 178 \fISCALE\fR = 0: magnification factor = 0.5,
 179 \fISCALE\fR = 1: magnification factor = 0.83,
 180 \fISCALE\fR = 2: magnification factor = 1.0,
 181 \fISCALE\fR = 3: magnification factor = 1.3,
 182 \fISCALE\fR = 4: magnification factor = 1.6,
 183 \fISCALE\fR = 5: magnification factor = 2.0.
 184
 185 .TP
 186 [\fB-t\fR | \fB--tooltips\fR]
 187
 188 Show tooltips.
 189
 190 .TP
 191 [\fB--view_gpivbuttons\fR]
 192
 193 View the \fBgpiv\fR buttons of the application.
 194
 195 .TP
 196 [\fB--view_tabulator\fR]
 197
 198 View the tabulator of the application containing all PIV process
 199 settings.
 200
 201 .SH SEE ALSO
 202 On-line documentation from the help-menu
 203
 204 .SH AUTHOR
 205 Gerber Van der Graaf
 206