man/gpiv.1

   1 .TH GPIV 1 "14 December 2007"
   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--console_bins \fIBINS\fR]
  12 [\fB--console_tooltips\fR]
  13 [\fB--console_view_gpivbuttons\fR]
  14 [\fB--console_view_tabulator\fR]
  15 [\fB--display_background  \fIINT\fR]
  16 [\fB--display_intregs\fR]
  17 [\fB--display_piv\fR]
  18 [\fB--display_stretch\fR]
  19 [\fB--display_scalar  \fIINT\fR]
  20 [\fB--display_vectorscale \fISCALE\fR]
  21 [\fB--display_view_menubar\fR]
  22 [\fB--display_view_rulers\fR]
  23 [\fB--display_zoomscale \fISCALE\fR]
  24 [\fB--hdf\fR]
  25 [\fB--img_fmt\fR]
  26 [\fB--mpi_nodes]
  27 [\fB-p\fR | \fB--print\fR]
  28 [\fB--process_imgproc\fR]
  29 [\fB--process_piv\fR]
  30 [\fB--process_gradient\fR]
  31 [\fB--process_resstatst\fR]
  32 [\fB--process_errvec\fR]
  33 [\fB--process_peaklock\fR]
  34 [\fB--process_average\fR]
  35 [\fB--process_scale\fR]
  36 [\fB--process_substract\fR]
  37 [\fB--process_vorstra\fR]
  38 [\fIIMAGE1\fR, \fIIMAGE2\fR, \fI...\fR]
  39 \fP
  40
  41 .SH DESCRIPTION
  42
  43 \fBGpiv\fP is a Graphic User Interface program for recording and
  44 analyzing images obtained from a fluid flow that has been seeded with
  45 tracer particles by the so-called Particle Image Velocimetry (PIV)
  46 technique. It allows to have a quick overview of the process settings,
  47 easily changing them, executing the processes, visualizing and
  48 optimizing their results in an interactive way. The processes that may
  49 be performed are image recording, interrogation (resulting into PIV
  50 estimators), validation and post-processing of the PIV estimators.
  51
  52 The settings for the PIV processes are subsequently searched in
  53 \fI~/.gpivrc\fR or in \fIgpiv.conf\fP (system wide), which is provided
  54 by libgpiv.
  55
  56 For recording images, \fBgpiv\fP recognizes (CCD) cameras that are
  57 IIDC-compliant and connected to the Computer with the IEEE1394
  58 or Firewire protocol.
  59
  60 In case \fBgpiv\fP will trigger a camera and lasers, it uses a kernel
  61 module gpivtrig_rtl from the gpivtrig package that depends on the Real
  62 Time Application Interface (RTAI) and RealTimeLinux. Trigger pulses
  63 are send to the parallel port of the Computer (/dev/lpt0 or /dev/lpt1;
  64 see the configure script of the gpivtrig package) at bins #1 (camera),
  65 #2 and #3 (first and second laser respectively). The program may be
  66 started directly if all modules have been loaded or by the
  67 gpiv_control script, also included in the gpivtrig package, which
  68 takes care of the loading and unloading of the needed kernel
  69 modules. Currently, the trigger system is tested with RTAI-3.1 and the
  70 linux kernel-2.4.27.
  71
  72 The parameters and options to be used for \fBgpiv\fP are obtained from
  73 ~/.gnome2/gpiv or default settings are to be used if absent. The
  74 settings may be changed or updated by menu->settings->preferences. The
  75 parameters of \fBgpiv\fP (not the PIV process settings) may be
  76 overruled by the command line options, as explained below.
  77
  78 When \fBgpiv\fR is used on a (Beowulf, distributed memory) cluster,
  79 the MPI-parallelised program \fBgpiv_rr\fR from the gpivtools package
  80 is invoked using \fBmpirun\fR. The \fBgpiv\fR program, however, is
  81 launched in the normal way, without invoking\fB mpirun\fR.
  82
  83 .SH Options
  84 .TP
  85 \fB-? | --help\fR
  86 On-line help. Besides the options of \fBgpiv\fP it also shows
  87 the additional GNOME, GTK and GNOME GUI options.
  88
  89 .TP
  90 \fB--usage\fR
  91 Display a brief usage message.
  92
  93 .TP
  94 \fB--console_bins \fIBINS\fR
  95 Number of bins for histograms of estimators at sub-pixel level,
  96 performed by the peaklock process and of the median residues,
  97 performed by the errvec process.
  98
  99 .TP
 100 \fB-t\fR | \fB--console_tooltips\fR
 101 Show tooltips.
 102
 103 .TP
 104 \fB--console_view_gpivbuttons\fR
 105 View the \fBgpiv\fR buttons of the application.
 106
 107 .TP
 108 \fB--console_view_tabulator\fR
 109 View the tabulator of the application containing all PIV process
 110 settings.
 111
 112
 113 .TP
 114 \fB--display_background \fIINT\fR
 115 Displaying of background: \fIINT\fR = 0: darkblue \fIINT\fR = 1: black
 116 \fIINT\fR = 2: first frame of image \fIINT\fR = 3: second frame of image
 117
 118 .TP
 119 \fB--display_intregs\fR
 120 Enables displaying of interrogation regions.
 121
 122 .TP
 123 \fB--display_piv\fR
 124 Displaying of PIV data.
 125
 126 .TP
 127 \fB--display_stretch\fR
 128 Enables automatic stretching of the display when zooming.
 129
 130 .TP
 131 \fB--display_scalar \fIINT\fR
 132 Display derived quantities from PIV data: \fIINT\fR = 0: none \fIINT\fR = 1:
 133 vorticity \fIINT\fR = 2: shear strain \fIINT\fR = 3: normal strain
 134
 135 .TP
 136 \fB--display_view_menubar\fR
 137 Enables displaying of the menubar.
 138
 139 .TP
 140 \fB--display_view_rulers\fR
 141 Enables displaying of the ruler.
 142
 143 .TP
 144 \fB--display_vectorscale \fISCALE\fR
 145 Display vector with index:
 146 \fISCALE\fR = 0: magnification factor = 1,
 147 \fISCALE\fR = 1: magnification factor = 2,
 148 \fISCALE\fR = 2: magnification factor = 4,
 149 \fISCALE\fR = 3: magnification factor = 8,
 150 \fISCALE\fR = 4: magnification factor = 16,
 151 \fISCALE\fR = 5: magnification factor = 32,
 152 \fISCALE\fR = 3: magnification factor = 64,
 153 \fISCALE\fR = 4: magnification factor = 128,
 154 \fISCALE\fR = 5: magnification factor = 256.
 155
 156 .TP
 157 \fB-z\fR | \fB--display_zoomscale \fISCALE\fR
 158 Display zoom with index:
 159 \fISCALE\fR = 0: magnification factor = 0.5,
 160 \fISCALE\fR = 1: magnification factor = 0.83,
 161 \fISCALE\fR = 2: magnification factor = 1.0,
 162 \fISCALE\fR = 3: magnification factor = 1.3,
 163 \fISCALE\fR = 4: magnification factor = 1.6,
 164 \fISCALE\fR = 5: magnification factor = 2.0.
 165
 166 .TP
 167 \fB--hdf\fR
 168 Save data in HDF5 format with \fB.gpi\fR extension.
 169
 170 .TP
 171 \fB--img_fmt \fIINT\fR
 172 store (modified) image data and header in:
 173 \fIINT\fR = 0: PNG format,
 174 \fIINT\fR = 1: raw format,
 175 \fIINT\fR = 2: HDF5 format, included with the resulting PIV and
 176 post-processing data with \fB.gpi\fR extension.
 177
 178 .TP
 179 \fB--mpi_nodes \fIINT\fR
 180 \fIINT\fR defines the number of nodes when used on a cluster.
 181
 182 .TP
 183 \fB-p\fR | \fB--print\fR
 184 Print process parameter settings to stdout.
 185
 186 .TP
 187 \fB--process_imgproc\fR
 188 Includes image processing in the chain-process.
 189
 190 .TP
 191 \fB--process_piv\fR
 192 Includes piv interrogation in the chain-process.
 193
 194 .TP
 195 \fB--process_gradient\fR
 196 Includes testing on the displacement gradient within interrogation area in the chain-process.
 197
 198 .TP
 199 \fB--process_resstatst\fR
 200 Includes calculation of statistics of displacement residuals in the chain-process.
 201
 202 .TP
 203 \fB--process_errvec\fR
 204 Includes validation on PIV data in the chain-process.
 205
 206 .TP
 207 \fB--process_peaklock\fR
 208 Includes peak lock in the chain- process.
 209
 210 .TP
 211 \fB--process_average\fR
 212 Includes calculation of the whole field average PIV displacements in the chain-process.
 213
 214 .TP
 215 \fB--process_scale\fR
 216 Includes scaling in the chain-process.
 217
 218 .TP
 219 \fB--process_subtract\fR
 220 Includes substracting of the whole field average PIV displacements in the chain-process.
 221
 222 .TP
 223 \fB--process_vorstra\fR
 224 Includes calculation of vorticity in the chain-process.
 225
 226 .TP
 227 \fIIMAGE1\fR, \fIIMAGE2\fR, \fI...\fR
 228 Loads \fIIMAGE1\fR, \fIIMAGE2\fR, ... from a file or from an URI
 229 using the Gnome Virtual File System.  The maximum allowed image
 230 dimensions and quantity to be loaded are defined by the program as
 231 described in gpiv_gui.h or by the 'configure' script during the
 232 building of \fBgpiv\fR.
 233
 234
 235
 236 .SH SEE ALSO
 237 On-line documentation at
 238 http://gpiv.sourceforge.net/gpiv_doc/index.html
 239 or from the help-menu of \fBgpiv\fR, gpiv_control(1) and gpivtools(1).
 240
 241 .SH AUTHOR
 242 Gerber Van der Graaf
 243