Version 89 (modified by sommeria, 8 years ago) (diff)


--- UVMAT ---

UVMAT is a set of Matlab functions and graphic user interfaces for Particle Imaging Velocimetry with tools for scanning images and data files (vectors and scalars in 2D and 3D), geometric calibrations, image pre-processing and analysis of time series. It is designed to favor data management, relying on the standard NetCDF file format and xml documentation files.

This free Matlab toolbox (GNU licence) contains a PIV program under Matlab and a graphic user interface to run other programs, like the Correlation Image Velocimetry software CivX. Tools are provided to run programs on a computer cluster with different file administration systems (sge or oar).

This free Matlab toolbox contains a graphic user interface to scan and visualize series of images and data fields (vectors and scalars). It provides statistics and various processing for these data. It also contains a graphic user interface to run the Correlation Image Velocimetry software CIVx and analyze its results.


This toolbox requires Matlab, release R 2009 or more recent. It can be run with any computer system on which Matlab is installed (in particular Linux, MacOS and Windows). No additional toolbox from Matlab is requested. The Matlab compiler is however useful to dispatch processing functions on a computer cluster.

Help and documentation

Online help is available at UvmatHelp.


Download the .zip archive at

This package contains specific Matlab functions updated on a SVN server, as well as a 'fixed' archive containing the toolboxes

An upgrade of these toolboxes from their source web site may be needed depending on the system and Matlab version.

A set of xml schemas, updated by SVN, is also provided as templates for editing xml files within uvmat.

The package contains a template file PARAM.xml.default, updated by SVN, which specifies system parameters needed for the use of a computer cluster. After proper editing, it must be transformed into PARAM.xml, unchanged by further SVN updates.

Finally the archive contains binary files compiled from the Fortran programs CivX. This is not mandatory as it is now replaced by Matlab functions within uvmat. These binaries depend on the operating system, unlike the Matlab toolboxes, so that archives are provided for different systems. To recompile these programs, see CivxDevelloperInstallation?.

Windows installation

To further update the package with SVN, perform a checkout in this directory using Tortoise SVN. The repository is available for download at

Linux automated installation

The procedure under linux requires the svn and wget commands from a shell. See LinuxInstallation?.

MacOS automated installation

The procedure under MacOs requires the svn and curl commands from a shell. See MacOsInstallation?.

LEGI Cluster Installation

If you wish to install UVMAT in your home of the LEGI cluster, please see LegiClusterInstallation?.

CivX developper installation (Fortran programs for advanced users)

If you also wish to have the last version of CIV and compile it on your machine, please see CivxDevelloperInstallation?


For use at LEGI, use the path '/fsnet/soft/eres/UVMAT/UVMAT_DEMO_FILES', else download the .zip archive of demo files.

Then follow the instructions for the different examples. Each folder contains both a sub-folder of raw images and processing results. It is advised to work on a copy of the image folders to keep the untouched processed data as a reference. An alternative way is to create a mirror data folder, as explained in Tutorial: processing image series?.

Attachments (6)