README

   1 30 july 2002
   2 cmd line programs stable
   3
   4 1. INTRODUCTION
   5 ===============
   6
   7 1.1 GENERAL DESCRIPTION
   8 =======================
   9
  10 PHILOSOPHY
  11
  12 GPIV-TOOLS is a set of command-line driven programs for the
  13 so-called Digital Particle Image Velocimetry (DPIV). It contains
  14 programs for image pre-processing, image analyses (resulting in
  15 particle displacement estimations, i.e. PIV data), validation on
  16 peak-locking effects and erroneous vectors (outliers) and post-processing
  17 functions for calculating (scalar) derivatives of the PIV data, like
  18 vorticity and strain.
  19
  20 GPIV-TOOLS uses LIBGPIV intensively, that can be found in a separate
  21 distribution, where the core functions resides. Some (perl) scripts
  22 are included in the GPIV-TOOLS package, too, that control the
  23 command-line driven programs. These scripts are provided as examples
  24 that may be used and adapted for processing a defined chain of
  25 analyses, validation and post-processing or for batch-processing of a
  26 series of images/piv-data sets etc.
  27
  28 Though the command-line driven tools are mainly intended for
  29 non-graphic processing, its outputs may be visualized by displaying
  30 with the aid of GNUPLOT or PLOTMTV. A Graphic User Interface program
  31 is available in the separate package GPIV. This program controls all
  32 the processes interactively and displays its results in a more
  33 advanced way. GPIV has been written with the aid of the GTK/GNOME
  34 libraries.
  35
  36 The GPIV-TOOLS have been written in ANSI-C. It has been developed, and
  37 is operational, on a i386 computer running the LINUX Operating System
  38 and should work on any Unix-like platform, too.
  39
  40
  41
  42 2.1 LICENSE
  43 ===========
  44
  45 is Free Software licensed under the GNU
  46 Public license terms. See the COPYING file for the license.
  47
  48
  49
  50 2.2 WARRANTY
  51 ============
  52
  53 This software is constantly under development. So, often, bugs and
  54 improvements are underway.
  55       The reliability of code rr has been tested with artificially generated
  56 PIV images (home brewed as well as by others) and with images obtained
  57 from experiments. The experimental data have been compared with
  58 analyzes from third-party software (mainly DaVies from LaVision INC).
  59       Though the software has been used by the author already for different
  60 projects, no warranty can be given. I would like to emphasize that the
  61 software is constantly under development. Any remarks on malfunction,
  62 improvements, new features are welcome.
  63
  64
  65
  66 3 COMPILATION AND INSTALLATION
  67 ================================
  68 See INSTALL for a more extended description.
  69
  70 Unpacking and compilation:
  71 gzip -d gpiv-0.2.tar.gz
  72 tar -xvf gpiv-0.2.tar
  73 ./configure
  74 make
  75 make install
  76
  77 To remove the package from the system:
  78 make uninstall
  79
  80
  81
  82 4.1 USE OF THE GPIV-TOOLS
  83 ========================
  84
  85 In order to understand how the programs work, just type the program
  86 name with -h option. For the majority of the programs there are manual
  87 pages as well. Every program needs its specific parameters. The
  88 program parameters may be defined in a parameter file with its
  89 specific process key and parameter name. The image parameters of raw
  90 data images may be defined in a header file (filename.h), followed by
  91 its value. All required parameters can be defined in order of
  92 priority:
  93
  94 - as a command line option.
  95 - in the image header ./filename.h or in the local parameter file ./gpivrc.
  96 - in the personal parameter file ~/.gpivrc.
  97 - in the system-wide parameter file (mostly in /etc/gpivrc).
  98
  99
 100 5. FINAL REMARKS
 101 =================
 102
 103 I hope that the programs will work fine and that you'll enjoy
 104 them. Remarks and suggestions for improvements/additions are welcome.
 105
 106 Gerber van der Graaf
 107
 108