Libpiv API documentation

 Search for 

Documentation of Libgpiv API

Introduction

LIBGPIV is a software library for the so-called Digital Particle Image Velocimetry (DPIV). It contains the core functions for image recording, image processing, image interrogation (resulting into estimators of particle image displacements, i.e. PIV data), validation of PIV data (on peak-locking effects, erroneous vectors (outliers), velocity gradient), post-processing (functions for calculating (scalar) derivatives of the PIV data, like vorticity and strain), input/output functions, memory allocation etc.

The library has been implemented in several command-line driven programs that can be found in the Gpivtools distribution. A Graphic User Interface (Gpiv) is available, too, that controls all processes and its parameters and displays its results graphically in a more advanced way. Gpiv has been implemented with the Gtk/GNOME libraries and resides in Gpiv package.

This library has been written in ANSI-C and has been developed on a GNU/LINUX box and should work on any UNIX-like system. The main web page can be found at: http://gpiv.sourceforge.net/

License

LIBGPIV is Free Software licensed under the GNU Public license terms. See the COPYING file for the license.

Installation

Unpacking and compilation:

gzip -d libgpiv-*.tar.gz
tar -xvf libgpiv-*.tar
./configure
make
make install

Some features will only work when they are enabled before the building process. An IEEE1394 (Firewire) camera, using the IIDC specifications protocol, is enabled with:

./configure --enable-cam

Triggering, currently only with RealTime Linux (RTA) and TealTime Aplication Interface (RTAI), is enabled with:

./configure --enable-dac

Libgpiv is included in the GNU/Debian system for most of the supported (currently 11) CPU architectures and is probably also included in Linux distro's that have been derived from GNU/Debian, like Ubuntu and Knoppix. This may drasticly ease the installation, as one has not to be bothered about library dependencies etc.

Final remarks

We hope that the software will work fine and that you'll enjoy it during using and developing. Remarks, suggestions and patches for improvements/additions are welcome.

---