README

   1
   2 GPIV is a graphic user interface for analyzing images obtained from a
   3 fluid flow that has been seeded with tracer particles by the so-called
   4 Particle Image Velocimetry technique. It is meant to have a quick
   5 overview of the parameters of all piv processes, easily changing them,
   6 running the processes and visualizing their results in an interactive
   7 way. It uses LIBGPIV, which contains the main routines for data in-and
   8 output, processing etc. The software is written in ANSI-C under the
   9 LINUX operating system by using the GTK/GNOME libraries.
  10
  11 GPIV is Free Software licensed under the GNU
  12 Public license terms. See the COPYING file for the license.
  13
  14 The main web page can be found at: http://gpiv.sourceforge.net/
  15
  16
  17
  18 Compilation and installation
  19 ============================
  20
  21 The General instructions of compilation and installation can be found
  22 in INSTALL.  There are some additional configuration options for this
  23 program, as well. These are:
  24 --enable-cam
  25 --enable-trig
  26 --enable-rta=RTA_DIR
  27 --enable-k=K_DIR
  28 --enable-img-width=WIDTH
  29 --enable-img-height=HEIGHT
  30 --enable-debug
  31
  32 An explanation of these options is printed with ./configure --help.
  33
  34
  35
  36 Features
  37 =========
  38
  39 General
  40 ========
  41 - Data storage in ASCII format or HDF version 5 format.
  42 - Loading of images with with file-open menu, "open" button or with "drag and
  43   drop" from the gnome file-manager "nautilus" into the buffer list.
  44 - Quick execution of all enabled process on all selected buffers.
  45
  46
  47 Display
  48 ========
  49 - Visualization of interrogation area contours and highlighting them when
  50   pointing to it.
  51 - Displays pointer position and belonging estimated values.
  52
  53
  54 Image recording
  55 ===============
  56 - Sending trigger pulses over the parallel port by using Real Time Linux and
  57   RTAI
  58 - Obtaining images from a IEEE1394 (Firewire) IIDC_Compliant CCD camera
  59
  60 Image info
  61 ===========
  62 - shows image name, dimensions and type of correlation (cross or auto).
  63 - defining of spatial and time scales, position of image within the experiment.
  64 - Adding and updating header information (date of creation, project, comment
  65   etc).
  66
  67
  68 Image evaluation
  69 =================
  70 - Interrogation at the entire image or at a defined region within the image
  71   frames, resulting into a displacement field on a rectangular grid.
  72 - Interrogation at a single arbitrary point, along a vertical or horizontal
  73   line.
  74 - Re-interrogation of a single area with, different parameters.
  75 - Dragging a single interrogation area from the rectangular grid.
  76 - Arbitrary interrogation area sizes.
  77 - Global pre-shifting.
  78 - Local pre-shifting or zero offsetting of the interrogation areas.
  79 - Forward and central interrogation scheme.
  80 - Adaptive interrogation area sizes to obtain high resolution and dynamic range.
  81 - Different interpolation schemes for sub-pixel estimation.
  82 - Cross and auto correlation.
  83 - Defining the order of correlation peak to be used as estimator.
  84 - Visualization of interrogation area's and correlation function.
  85
  86
  87 Data validation
  88 ===========
  89 - Manually enabling and disabling of PIV estimators interactively.
  90 - Checking on peak-locking effects.
  91 - Validation on outliers by snr value or median test.
  92
  93
  94 Post-processing
  95 ===============
  96 - apply time and spatial scaling
  97 - calculate statistics and subtraction of mean values from estimators
  98 - calculation of vorticity and strain.
  99