The PIVMat Toolbox for Matlab contains a set of command-line functions to import, post-process and analyse 2D vector fields from various file formats, including DaVis files from LaVision (PIV and Synthetic Schlieren applications).

It enables to handle and perform complex operations over large amount of vector fields, and to produce high-quality 2D and 3D outputs based on standard Matlab visualization tools.

The PIVMat Toolbox in itself does not perform any PIV computations.

Version 1.90 - 28 august 2009.

Online help   -  What's new?

Alternate download site here

Frederic Moisy
Laboratory FAST, University Paris Sud, CNRS.
moisy@fast.u-psud.fr


Main Features

  • Import vector fields from PIV (Particle Image Velocimetry) or other related technics, such as DIC (Digital Image Correlation), SS and BOS (Synthetic Schlieren and Background-oriented Schlieren), from DaVis 6 and 7, MatPIV and Optical Flow.

  • Standard vector field operations: interpolation, filtering (median, Butterworth...), averaging (temporal, spatial, azimuthal...), derivatives computation (vorticity, divergence, strain, Q-factor...)

  • Fully vectorized: all operations directly apply on arrays of fields (no for loops)

  • More than 60 functions with full on-line documentation; sample fields included.

  • High-quality vector and scalar output based on Matlab visualization tools: 2D and 3D fields (meshes, surfaces...), movies (AVI), contour plots...

  • Advanced statistics: Histograms, correlation functions, vector and scalar structure functions, power spectra, integral scales, joint probability density functions...

  • Support for FS-SS (Free-Surface Synthetic Schlieren) applications for surface wave reconstructions (including production of random dot patterns)

  • Full support of DaVis files (VEC, VC7, IMX, IM7, EXP, SET) and file attributes (Acquisition times, PIV parameters...)

  • Works on all platforms: Windows/Unix/Mac (once the original fields have been converted into Mat-files).


What is DaVis?

DaVis is a commercial software for imaging applications developed by LaVision.

For PIV or Synthetic Schlieren applications, DaVis computes vector fields (velocity or displacement fields) from correlations of images of particles. These fields can be saved in a specific DaVis file format (VEC or VC7 files), which can be imported in Matlab using the ReadIMX Loader package provided by LaVision. Based on this package, the PIVMat Toolbox offers a number of command-line functions to further post-process and analyze those vector fields.


Compatibility

The PIVMat Toolbox works with MATLAB 7 or higher, on every plateform (PC, UNIX, Mac).

Files from DaVis 6 and 7 (formats VEC, VC7, IMG, IMX, IM7, SET and EXP), files from MatPIV (format MAT) and Optical Flow files (formats UW0 and CM0) are supported.

Note that the import of DaVis files works only on Windows (32-bits version only), and requires to install first the MATLABIMX package (version 1.4 or higher) provided by LaVision: see the installation procedure below. If you have a 64-bits Windows XP edition, you will need to install the 32-bits version of Matlab to run the PIVMat toolbox. Once imported, the files can be converted into standard MAT files and further used under all plateform (PC, UNIX, Mac).

Some functions require the Image Processing Toolbox.


Installation procedure

1. Download the PIVMat Toolbox and extract the ZIP file in a folder, for example /My documents/Matlab/toolbox/pivmat (make sure the subdirectories html, sample and private are correctly unzipped as well). If you upgrade from an older version, first empty the previous directory.

2. If you wish to import DaVis files (Windows only), download also the latest version of MATLABIMX ('ReadIMX Loader package for MATLAB'), either from the 'Download' area of the LaVision web site www.lavision.de, or simply here, and extract the ZIP file in another folder, for example /My documents/Matlab/toolbox/readimx. Note that you need to sign up first and login to access to the LaVision download area.

3. From the menu 'File > Set Path', click on 'Add Folder' (not Add with Subfolders) and select the directory pivmat (and also the directory readimx if needed). Click on 'Save' and 'Close'.

4. Restart MATLAB. To get started, type docpivmat, or select Toolboxes > PIVMat from the Start button.


Getting started

The first step is to import some vector fields into a MATLAB structure array. The simplest way to import data is to double-click on a file on the Current Directory Browser. You can also import data using the function loadvec. Each element of this structure array contains the two matrices of the velocity components, the coordinate system, and some additional informations (units, axe names, PIV parameters...)

Once imported, the velocity fields can be displayed using showf, or converted into various scalar fields using vec2scal.

A sample directory, named sample, with 3 experimental series of PIV fields, is provided with the toolbox to test the following example. The example given below is based on DaVis 7 files (format VC7), but can be followed for other formats.

    v = loadvec('*.vc7');                % loads all the VC7 files
    showf(v);                            % displays the vector field movie
    showf(averf(v));                     % displays the ensemble-average
    plot(v(1).vy(:,20));                 % plots a horizontal profile of vy
    curl = vec2scal(filterf(v,2),'rot'); % computes the filtered vorticity
    showf(curl);                         % displays the vorticity movie
    movie2avi(showf(curl),'mymovie.avi');% saves it as an AVI movie
    histscal_disp(curl);                 % displays the vorticity histogram
    statf(v)                             % computes some statistics
    specf(v)                             % displays the power spectra
    

See the Online help and the FAQ for more examples, or type  docpivmat  in Matlab.


How to acknowledge?

Go to the PIVMat page on the Matlab Central and offer a 5-stars rating!


User Community

This toolbox is used by several laboratories and universities worldwide. If you want to submit suggestions, comments, bug reports, or if you wand to receive upgrade informations, please feel free to send an email to the author.


Earlier versions

pivmat1.50.zip (21 jul 2006).
pivmat1.51.zip (8 nov 2006).
pivmat1.60.zip (17 apr 2007).
pivmat1.70.zip (18 apr 2008).
pivmat1.80.zip (17 oct 2008).


Links

PIVMat page on the Matlab Central.

Author's home page.

Author's Matlab page.


This page is hosted by FAST
Last update: 28 aug 2009.

Free counter and web stats