PIVTools Manual

Comprehensive documentation for installing, configuring, and using the high-performance PIV processing toolkit.

Quick Start

Get PIVTools up and running in minutes with pip install. No compiler required. Both the GUI and CLI run from the same YAML configuration file, allowing all GUI functionality to be achieved via appropriately constructed YAML configs.

Python 3.12/3.13 virtual environmentpip install pivtoolsLaunch GUI or CLIShared YAML configuration

Image Configuration

Configure image paths, camera setups, file formats, and frame pairing.

Source & base directoriesMulti-camera setupFrame pairing modes

Masking

Define regions to exclude from PIV processing using polygon masks or pixel borders.

Polygon mask editorPixel border modeAuto-loading masks

Pre-Processing

Apply temporal and spatial filters to enhance PIV image quality before correlation.

Time & POD filtersGaussian, median, normBatch size control

PIV Processing

Configure instantaneous or ensemble PIV with multi-pass refinement, outlier detection, and infilling.

Instantaneous & ensemble modesSingle-pixel accumulationOutlier detection & infilling

Developer Installation

Build from source for development, customization, or contribution.

Clone repositoryPlatform-specific setupC extension compilation

Coming Soon

Calibration Guide

Scale factor, pinhole, and stereo calibration

Statistics & Analysis

POD, SPOD, and ensemble statistics

Troubleshooting

Common issues and solutions

Ready to Get Started?

Install PIVTools and start processing your PIV data with unprecedented speed and accuracy.

Install via pipView on GitHub