PIVTools Manual

Install and run PIVtools in minutes.

• pip install pivtools
• Python 3.12 - 3.14 support
• Pre-compiled C extensions

All CLI commands with options and examples.

• 16 CLI commands
• Batch processing
• Workflow examples

Set up input images, cameras, and file formats.

• Multiple image formats
• Multi-camera support
• Batch processing paths

Exclude regions from PIV processing.

• Polygon mask editor
• Pixel border mode
• Per-camera masks

Temporal and spatial filters for image enhancement.

• POD background removal
• Gaussian/median filters
• Live preview

Cross-correlation with multi-pass refinement.

• Multi-pass windowing
• Ensemble averaging
• Outlier detection & infilling

Convert pixels to physical units.

• Scale factor method
• Dotboard/ChArUco patterns
• Polynomial fitting

3D velocity reconstruction from camera pairs.

• 3D reconstruction (ux, uy, uz)
• Dotboard, ChArUco & stepped boards
• Self-calibration (Wieneke 2005)

Two-level boards for transmission rigs.

• Cameras on opposite faces
• Composed stereo pose
• Fiducial and level picking

Align multi-camera coordinate systems.

• Joint multi-camera model
• Guided setup wizard
• Datum + overlap (scale factor)

Create MP4 animations of velocity fields.

• 1080p/4K resolution
• Multiple variables
• Auto color scaling

Interactive vector field visualisation.

• Vector overlays
• Colormap controls
• Frame navigation

Geometric transformations on vector fields.

• Flip/rotate operations
• Batch processing
• Operation chaining

Combine multi-camera vector fields.

• Seamless overlap blending
• Overlap detection
• Multi-camera fields

Mean velocities, Reynolds stresses, TKE, and more.

• Time-averaged stats
• Per-frame statistics
• TKE & vorticity

Build from source and contribute.

• Clone & build
• C extension compilation
• Build tuning knobs