Version 35 (modified by sommeria, 9 years ago) (diff)


Tutorial / Correlation Image Velocimetry: a simple example

Open again the first example of image pair in UVMAT_DEMO01_pair (accessible on

Starting PIV

Visual check

Particle Image Velocimetry (PIV) measures the displacement of features in a pair of images. Visual evidence of feature displacement between the two images is a prerequisite for the success of the computation. To observe this motion, write the file indices 1 and 2 in the boxes [i1] and [i2] respectively, in the frame [File Indices] on the left. Then push the red button [<-->] in the frame [Navigate], see figure. The image then alternatively switches from 1 to 2. The speed of motion can be adjusted with the slider [speed]. Press [STOP] to stop the motion.

Launching PIV

The PIV computation is accessed from uvmat by the upper bar command [Run/PIV], or from series by selecting the function civ_series. The name 'CIV' means Correlation Imaging Velocity to stress that the method relies on image correlation, which evaluates the displacement of image textures, not necessarily from particles. Note that an older GUI 'civ' is also available, but it is obsolete and not used here.

A new GUI civ_input now appears. In the menu [ListCompareMode], keep the default option 'PIV'. Keep also the default option 'Di=0|1' for the image pair (menu tag [!ListPairCiv1]). Keep also the default parameters in the frame CIV1 and press [OK], so the GUI civ_input desappears. Then press [RUN] in the GUI series to run the calculation. The button [RUN] is then colored to yellow until the computation is finished.

The operation produces a file with format netcdf, named with extension .nc, in a folder called Images.civ. This can be viewed by pressing [STATUS] in the GUI series, which displays the result file The index string '_1-2' indicates that it results from images 1 and 2. Select the file name and press [OPEN] to open it directly with uvmat, or use the browser of uvmat.

Monitoring PIV results

Visualizing the velocity fields

In uvmat velocity vectors are displayed in the central window, while the histograms of each component are in the lower left windows. The arrow length is automatically set by default. It can be adjusted by the edit box [num_VecScale] in the frame [Vectors] on the right hand side.

The vector color indicates the quality of the image correlation maximum leading to each vector, blue is excellent, green average, red poor. The thresholds for such color display can be adjusted from 0 to 1 (perfect image correlation) in the frame [Vectors], using the boxes [!ColCode1] and [!ColCode2], or equivalently by the corresponding sliders [Slider1] and [Slider2] .

The black color indicates warning in the PIV calculation process. In this example, black vectors are indeed located on the edge, in zones outside the area of flow visualisation (this display can be desactivated by unselecting the box hide warn (tag [CheckHideWarning]) in the frame Vectors).

The position (x,y) and velocity components (U,V) can be displayed in the upper right text display window by moving the mouse over it. The correlation 'C' and warning flag 'F' are also indicated. The warning flag is equal to 0 for good vectors while non-zero values indicate different calculation problems, see below.


The global histograms of the vector components are available in the lower left windows. Histograms limited to a sub-region can be extracted by the menu bar tool [Projection object], selecting either [rectangle], [ellipse] or [polygon] to define the sub-region (see projection objects)


The velocity profile along a line can be obtained by creating a line with the upper menu bar [Projection object/line], like for image luminosity (see projection objects). Press (and release) the left hand side mouse button, draw the line, and press it again for the end of the line. The transverse and longitudinal velocity components along this line are then plotted in a new figure view_field.

Other vector color representations

Vector color can also represent another quantity, as chosen in the menu [ColorScalar] in the frame [Vectors]. For instance the vector length 'norm(U,V)' can be used. Then a color continuous 64 color code is appropriate, as set in the menu [ColorCode]. The color code extrema are set by [num_MinVec] and [num_MaxVec], choose for instance 0 and 5 respectively.'

Derived fields

Other field representations are available, selected in the menu [Fields] at the top of the GUI. For instance the option 'U' provides a (false) color map of the x wise velocity component. The color code can be adjusted by the edit box [num_MinA] (saturated blue color below this value) and [num_MaxA] (saturated red color beyond this value). Choose for instance -1 and 5 respectively.

A contour plot can be obtained instead of a color map by selecting the option 'contour' in the menu [ListContour] in the frame [Scalar] . Then select the contour interval, for instance 0.5. The result is shown in the following figure.

To get the vorticity field, 'vort' , and other spatial derivatives, you need to come back to the GUI series with images as input and action civ_series. In civ_input, select the check boxes [FIX1] and [PATCH1] , validate the input with [OK], then press [RUN] in the GUI series. A question box appears to warn about the existence of the result file, answer [OK] to refresh it with the new data. This will produce an interpolated velocity field and their spatial derivatives in the same netcdf file. After this operation vorticity can be visualized in the GUI uvmat, selecting the option 'vort' in the popup menu [FieldName].

Superposing image and vectors

It can be useful to visually superpose the images to the velocity field. This is done by selecting the option 'vec(U,V)' in the popup menu [FieldName] and 'image' in the popup menu [!FieldName_1], located just below in the upper frame [Input]. To remove the image, select the blank option in [!FieldName_1] .

Similarly, the velocity vectors can be superposed to the vorticity field, selecting 'vort' in [!FieldName_1] instead of 'image.

From pixel displacement to velocity

So far all PIV results have been expressed as image displacement expressed in pixels. Conversion to velocity requires timing information and geometric calibration, as described in geometric calibration. Both pieces of information must be stored in an xml file named 'images.xml in the same folder as the folder images containing the images.

First introduce the time interval, Dt=0.02 s, by creating a text file with the following content, using any text editor (with output in plain text), and save it with name 'images.xml (in Windows system, be carefull to avoid any additional hidden extension).


Then open the image with uvmat. The label 'xml' should appear in the upper right box [TimeName] and time value beside it in [TimeValue].

Now repeat the PIV operation to include the time information in the result (in the absence of time information the file index is taken as default value).

To introduce the geometric calibration, use the method described in geometric calibration, section 'Simple scaling'. The velocity field is then displayed in terms of physical velocity. To come back to the image coordinates, use the box [TransformName] on the left : select to blank instead of ’phys’.

Note that the netcdf file has not been by changed by calibration, whose rescaling is introduced after reading the file. This means that calibration can be provided, and possibly updated, after the PIV processing.

The main PIV parameters

The first parameter to adjust is the time interval between images, which should be sufficiently long to provide a displacement of a few pixels. The measurement precision is typically 0.2 pixel, so that a displacement of 4 pixels, as in the example, provides a relative precision of 5 %. A larger displacement would be preferable in terms of precision but may yield to poor image correlation and ’false vectors’.

Once the image pair has been chosen, the main parameters are the size of the correlation box in both directions ([num_CorrBoxSize]_1] and _2) and the size of the search box, ([num_!SearchBoxSize_1] and _2), expressed in pixels. For each velocity vector, the correlation box is moved within the search box to optimise the image correlation between the two sub-images inside the correlation box. To allow for a displacement of d pixels, the search box size must exceed the correlation box by at least d+2 on both sides, so 2d+4. A systematic shift [num_!SearchBoxShift_1], and _2, can be also introduced to minimise the search area in the presence of a mean flow.

The parameter [num_CorrSmooth] is used to fit the correlation data with a smooth function to obtain the maximum with sub-pixel precision. We generally keep the default value 1.

The parameters [num_Dx] and [num_Dy] define the mesh of the measurement grid, in pixels. Reduce them to get more vectors, but keep in mind that the spatial resolution is limited by the size of the correlation box.

The PIV operation is conveniently visualised by pressing the button [!TestCiv1] in the GUI civ. Then the image appear in a new GUI view_field, in which the mouse motion displays the correlation function, which appears in a secondary window, see figure. The resulting vector is shown as a line pointing to the correlation maximum. The corresponding correlation and search boxes are shown in the image. Let us run again PIV with [CorrBoxSize]=[25 25] and [SearchBoxSize]=[33,33], limiting ourselves to CIV1, and visualisae the result with uvmat. Many black vectors (F=-2) are obtained, showing that the search domain is too small, so that the correlation maximum is constrained by the limited search interval. Repeat the operation with [SearchBoxSize]=[35,33], then the arrows are not black anymore.


Spurious vectors are observed outside the fluid domain, which particularly disturbing when spatial derivatives are calculated.

This can be avoided by using a mask, which is an image of the same size as the images used for PIV. Grey color in the mask indicate regions excluded from measurement.

To produce the mask, first create a polygon by the menu bar command [Projection object/mask polygon]. Draw the mask with the mouse by moving around regions to exclude. Left mouse button to initiate the plot and produce new boundary points, press right hand button to finalise the polygon. By default mask is set inside the polygon, but it can be made outside by selecting the option ’mask_outside’ in the menu [ProjMode] of the GUI set_object.

Then the mask itself is produced by the menu bar command [Tools/Make mask]. The corresponding image is then displayed and stored by default in the directory of the initial image. Note that if several mask polygons have been initially created, as listed in [ListObject] (bottom right of the GUI uvmat), they will be merged as dark regions in the resulting mask (useful in case of multiple ’holes’).

The mask image can be seen as a mask by selecting [view_mask] at the upper left of the GUI uvmat. For checking purpose, it can be also opened by the browser of uvmat like any image. In the GUI civ, the mask is introduced by the selecting the green check box [Mask]. Vectors under the mask are not calculated in the resulting velocity data.

Further improvments of the results are discussed in CorrelationImageVelocimetryOptimisation

Attachments (9)

Download all attachments as: .zip