Skip to content

openptv2 Documentation

Particle Tracking Velocimetry: track particles in 3D from 4 camera views.

Start here (10 minutes)

New to openptv2? Do this first:

  1. Install — Installation: 
    pip install "openptv2[gui]"
  2. Run your first tracking — GUI First Tracking tutorial: open the bundled test_data/test_cavity example in the desktop GUI and track particles in 5 clicks. No data to download, no parameters to tune.
  3. Understand what happened — Tracking Pipeline & Results: what detection, correspondences, and tracking do, and where results land.
openptv2-gui -w test_data/test_cavity/parameters_Run1.yaml

If you prefer the command line, the same example runs headless:

pyptv_batch --workdir=test_data/test_cavity --first=10000 --last=10001

Documentation map

I want to... Go to
Track my first particles GUI First Tracking
Install on my platform Installation
Run without the GUI Command-Line Batch Processing
Calibrate my own cameras Plate Calibration How-To
Pick a tracker Tracker Engines & Parameters
Store large runs efficiently Zarr & HDF5 Storage
Contribute code Building from Source

Advanced case studies (cavity flow, aorta flow) and calibration references live in the navigation sidebar. Start with the tutorial above first.