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 *** home page ***
  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-img-width=WIDTH
  25 --enable-img-height=HEIGHT
  26 --enable-debug
  27 --enable-demo
  28 An explanation of these options is printed with ./configure --help.
  29
  30
  31
  32 Features
  33 =========
  34
  35 General
  36 ========
  37 - Data storage in ASCII format or HDF version 5 format.
  38 - Loading of images with with file-open menu, "open" button or with "drag and
  39   drop" from the gnome file-manager "nautilus" into the buffer list.
  40 - Quick execution of all enabled process on all selected buffers.
  41
  42
  43 Display
  44 ========
  45 - Visualization of interrogation area contours and highlighting them when
  46   pointing to it.
  47 - Displays pointer position and belonging estimated values.
  48
  49
  50 Image info
  51 ===========
  52 - shows image name, dimensions and type of correlation (cross or auto).
  53 - defining of spatial and time scales, position of image within the experiment.
  54 - Adding and updating header information (date of creation, project, comment
  55   etc).
  56
  57
  58 Image evaluation
  59 =================
  60 - Interrogation at the entire image or at a defined region within the image
  61   frames, resulting into a displacement field on a rectangular grid.
  62 - Interrogation at a single arbitrary point, along a vertical or horizontal
  63   line.
  64 - Re-interrogation of a single area with, different parameters.
  65 - Dragging a single interrogation area from the rectangular grid.
  66 - Arbitrary interrogation area sizes.
  67 - Global pre-shifting.
  68 - Local pre-shifting or zero offsetting of the interrogation areas.
  69 - Forward and central interrogation scheme.
  70 - Adaptive interrogation area sizes to obtain high resolution and dynamic range.
  71 - Different interpolation schemes for sub-pixel estimation.
  72 - Cross and auto correlation.
  73 - Defining the order of correlation peak to be used as estimator.
  74 - Visualization of interrogation area's and correlation function.
  75
  76
  77 Data validation
  78 ===========
  79 - Manually enabling and disabling of PIV estimators interactively.
  80 - Checking on peak-locking effects.
  81 - Validation on outliers by snr value or median test.
  82
  83
  84 Post-processing
  85 ===============
  86 - apply time and spatial scaling
  87 - calculate statistics and subtraction of mean values from estimators
  88 - calculation of vorticity and strain.
  89
  90
  91 Currently the images can not be visualized, yet, as the code is written
  92 with the GNOME 1.4 libraries. It is planned to visualize the images in
  93 the window that displays the data when the program will be ported to
  94 GNOME-2.  In that case the gnome-config allows to include pixmap images
  95 into the gnome canvas. Any help, especially on the visualization of
  96 images, on porting the program to GNOME-2 is welcome.