This is a python extension module of the libgpiv library obtained using
the Swig software. It provides functions for reading and writing
images, PIV and scalar data and parameters, for image processing,
image PIV interrogation, PIV data validation and PIV data
post-processing.

unpacking is done with:
'tar -xzf pygpiv-*.tar.gz'

building the package is done with:
'python setup.py build_ext'

and installing the module with:
'python setup.py install'

An example script and image is provided in the example/ directory.
Documentation about the functions can be found at 
http://libgpiv.sourceforge.net/doc/

Only variables of int, char or float that have been wrapped by Swig
are recognized from a python script. Other variables, like arrays,
structures, are mapped into a pointer of type Swigobj. So, these
variables are opage when used from a python script and can only be
used by the functions of the wrapped C code internally, in this case
libgpiv. Therefore, some additional functions have been added in the
wrapper to access the individual array members.  These have _i_get and
_i_set or _ij_get and _ij_set in their name. For example to get the
array member dx (from the GpivPivData struct) at index (i,j):
GpivPivData_dx_ij_get(gpiv_data, i, j)
GpivPivData_dx_ij_set(gpiv_data, i, j, value).

Gerber van der Graaf
