man/gpivtools.1

   1 .TH GPIVTOOLS 1 "26 March 2008"
   2 .SH NAME
   3 gpivtools \- The PIV tool suite.
   4
   5 \fP
   6
   7 .SH DESCRIPTION
   8
   9 \fBgpivtools\fP is a set of command-line driven programs for the
  10 so-called Digital Particle Image Velocimetry (DPIV). It contains
  11 programs for image recording, processing and analysing (resulting into
  12 estimators of particle displacement, i.e. PIV data), PIV data
  13 validation programs and post-processing tools for manipulating and
  14 calculating (scalar) derivatives of the PIV data.
  15
  16 Though the command-line driven tools are mainly intended for
  17 non-interactive processing, its outputs may directly be visualized in
  18 a graphical way with the aid of gnuplot.
  19
  20 The parameters and options to be used for most of the \fBgpivtools\fP
  21 are provided by Libgpiv. They are subsequently searched in
  22 \fI./gpivrc\fP at local directory, at \fI$HOME/.gpivrc\fR (hidden) or
  23 at the system-wide configuration file \fIgpiv.conf\fR, which is mostly
  24 found at \fI/etc\fR for UNIX-like operating systems. Each parameter is
  25 described by the process key: \fBGENPAR\fR (general parameters),
  26 \fBCAM\fR (camera settings), \fBTRIG\fR (trigger settings), \fBIMG\fR
  27 (image header), \fBIMGPROC\fR (image processing), \fBPIV\fR (piv
  28 interrogation), \fBVALID\fR (piv data validation) or \fBPOST\fR (piv
  29 post processing) and the parameter name, separated by a dot (.),
  30 followed by its value. Some of the parameters are optional. The
  31 parameters may be defined in arbitrary order. Blank lines and comment
  32 (starting with a pound sign (#) at the first column) may be included
  33 in the parameter files.  The parameters may be overruled by the
  34 command line options of each tool. Libgpiv provides default parameter
  35 values if they are not defined in one of the configuration files or by
  36 an option key at the command line.
  37
  38 In case stdin and stdout is used, verbose output of the programs is
  39 suppressed in order to avoid contamination of the output data. If
  40 \fIfilename\fR is used for overruling \fIstdin\fR and \fIstdout\fR,
  41 the parameters are written to \fIfilename\fB.par\fR. By renaming this
  42 file to \fI./gpivrc\fR or \fI$HOME/.gpivrc\fR, the parameters may
  43 directly be re-used for identic processing of other images and PIV
  44 data. The parameters defined in \fI$HOME/.gpivrc\fR and in
  45 \fI/etc/gpiv.conf\fR are also used by the Graphic User Interface
  46 program \fBgpiv\fR.
  47
  48 The programs understand different image formats: Portable Network
  49 Graphics (\fIfilename\fB.png\fR), HDF5 (\fIfilename\fB.hdf\fR), raw
  50 binary data (\fIfilename\fB.r\fR) that is accompanied by an ASCII
  51 header file (\fIfilename\fB.h\fR), and LaVision's (tm) uncompressed
  52 image format (\fIfilename\fB.img\fR). Other formats that use lossless
  53 compression (TIF, GIF, PGM, BMP) are converted to PNG on the fly. For
  54 interrogation of double-framed images using cross-correlation, the
  55 second image has to be concatenated after the first one, if this has
  56 not already been done by the recording camera. This might be performed
  57 by \fBgpiv_combing\fR. Image parameters are read from the header or
  58 from the configuration resources (containing the \fBIMG\fR key).
  59
  60
  61 .SH GPIV-TOOLS COMMANDS
  62
  63 Here is the complete list of available \fBgpivtools\fP programs. See their
  64 individual man pages for a more extended description.
  65
  66
  67 .TP
  68 \fBgpiv_aint\fR
  69 Calculates mean image intensity at each interrogation area.
  70 This program uses the \fBIMG\fR, \fBPIV\fR and \fBPOST\fR parameters.
  71
  72 .TP
  73 \fBgpiv_combing\fR
  74 Combines two images into one image file for cross-correlation.
  75 This program uses the \fBIMG\fR parameters.
  76
  77 .TP
  78 \fBgpiv_errvec\fR
  79 Searches the erroneous vectors in a PIV data file and eventually
  80 substitutes them with new values.
  81 This program uses the \fBPIV\fR and \fBVALID\fR parameters.
  82
  83 .TP
  84 \fBgpiv_fi-keyline\fR
  85 Filters each line that starts with a keyword.
  86 This program does not use the parameter resources from Libgpiv.
  87
  88 .TP
  89 \fBgpiv_hdf2piv\fR
  90 Converts hdf5 PIV data (extension .hdf) to ASCII data.
  91 This program does not use the parameter resources from Libgpiv.
  92
  93 .TP
  94 \fBgpiv_imgproc\fR, \fBgpiv_mktestimg\fR, \fBgpiv_smooth\fR, \fBgpiv_hilo\fR, \fBgpiv_clip\fR, \fBgpiv_fft\fR, \fBgpiv_invfft\fR, \fBgpiv_lowpass\fR, \fBgpiv_highpass\fR, \fBgpiv_getbit\fR, \fBgpiv_mktestimg\fR
  95 (PIV) image processing programs.
  96 These programs use the \fBIMGPROC\fR parameters.
  97
  98 .TP
  99 \fBgpiv_img2gpiv\fR
 100 Depreciated: use \fBgpiv_combing\fR instead. Converts images into raw
 101 data (extension \fB.r\fR) format with the belonging ASCII header
 102 (extension \fB.h\fR) or into hdf format (with extension
 103 \fB.hdf\fR). This program does not use the parameter resources from
 104 Libgpiv.
 105
 106 .TP
 107 \fBgpiv_manipiv\fR, \fBgpiv_fasty\fR, \fBgpiv_flipx\fR, \fBgpiv_flipy\fR, \fBgpiv_revert\fR, \fBgpiv_rot\90\fR, \fBgpiv_rot\180\fR
 108 Simple data manipulation tool for PIV data.
 109 These programs use the \fBPOST\fR parameters.
 110
 111 .TP
 112 \fBgpiv_peaklck\fR
 113 Tests PIV data on the so-called peak-locking effect by
 114 printing/displaying an histogram of the particle displacements at
 115 sub-pixel level.
 116 This program uses the \fBVALID\fR parameters.
 117
 118 .TP
 119 \fBgpiv_piv2gnuplt\fR
 120 Converts PIV data gnuplot data. Besides this, image interrogation and
 121 post-processing programs are able to display their results directly
 122 (mostly with the \fB-g\fR option). This program does not use the
 123 parameter resources from Libgpiv.
 124
 125 .TP
 126 \fBgpiv_piv2grid\fR
 127 Converts PIV data to grid data for generating contour plots with Plotmtv.
 128 This program does not use the parameter resources from Libgpiv.
 129
 130 .TP
 131 \fBgpiv_piv2hdf\fR
 132 Converts ASCII PIV data to hdf5 formatted data (extension \fB.hdf\fR).
 133 This program does not use the parameter resources from Libgpiv.
 134
 135 .TP
 136 \fBgpiv_piv2vec \fR
 137 Adds header to PIV data for a vector plot with Plotmtv.
 138 This program does not use the parameter resources from Libgpiv.
 139
 140 .TP
 141 \fBgpiv_process-chain\fR
 142 Processes a pipeline of Gpiv-tool command's, forming process a chain
 143 from image recording, image processing, image interrogation, data
 144 validation, data post-processing.  This program does not use the
 145 parameter resources from Libgpiv.
 146
 147 .TP
 148 \fBgpiv_recimg\fR
 149 captures images from a IIDC-compliant CCD camera with IEE1394 connection.
 150 This program uses the \fBIMG\fR parameters.
 151
 152 .TP
 153 \fBgpiv_rr\fR
 154 Interrogates images in order to obtain displacement estimators
 155 of particles for (Digital) Particle Image Velocimetry.
 156 This program uses the \fBPIV\fR and \fBVALID\fR parameters.
 157
 158 .TP
 159 \fBgpiv_sca2gri\fR
 160 Converts scalar data from gpiv to grid data for contour plotting with Plotmtv
 161 This program does not use the parameter resources from Libgpiv.
 162
 163 .TP
 164 \fBgpiv_scale\fR
 165 Spatial and time scaling program for PIV data.
 166 This program uses the \fBIMG\fR and \fBPOST\fR parameters.
 167
 168 .TP
 169 \fBgpiv_series\fR
 170 Script for (parallel) processing a series of numbered files.
 171 This program does not use the parameter resources from Libgpiv.
 172
 173 .TP
 174 \fBgpiv_suta\fR
 175 Subtracts time-avaraged velocities (local mean) from the PIV estimators.
 176 This program does not use the parameter resources from Libgpiv.
 177
 178 .TP
 179 \fBgpiv_s-avg\fR
 180 Spatial statistics of PIV data.
 181 This program uses the \fBPOST\fR parameters.
 182
 183 .TP
 184 \fBgpiv_t-avg \fR
 185 Calculates time-avaraged mean and rms from a series of PIV data.
 186 This program does not use the parameter resources from Libgpiv.
 187
 188 .TP
 189 \fBgpiv_t-avg-img\fR
 190 Calculates time-averaged values from a series of images at each pixel.
 191 This program uses the \fBGENPAR\fR parameters.
 192
 193 .TP
 194 \fBgpiv_t-corr\fR
 195 Calculates the velocity correlation as function of time
 196 (Eulerian correlation) from a series PIV data sets
 197 This program does not use the parameter resources from Libgpiv.
 198
 199 .TP
 200 \fBgpiv_trig\fR
 201 Triggers a (double Nd_YAGG) laser on a CCD camera.
 202 This program uses the \fBTRIG\fR parameters.
 203
 204 .TP
 205 \fBgpiv_uhisto\fR
 206 Tests PIV data by printing/displaying an histogram of
 207 the horizontal particle displacements.
 208 This program uses the \fBVALID\fR parameters.
 209
 210 .TP
 211 \fBgpiv_vhisto\fR
 212 Tests PIV data by printing/displaying an histogram of
 213 the vertical particle displacements.
 214 This program uses the \fBVALID\fR parameters.
 215
 216 .TP
 217 \fBgpiv_vorstra\fR, \fBgpiv_vorty\fR, \fBgpiv_nstrain\fR, \fBgpiv_sstrain\fR
 218 Calculates the differential quantities vorticity, shear strain and
 219 normal strain from PIV data.
 220 These programs use the \fBPOST\fR parameters.
 221
 222 .SH SEE ALSO
 223 gpiv, pygpiv, gpiv_control
 224
 225 .SH AUTHOR
 226 Gerber Van der Graaf