Algorithms for PIV image processing with a CPU.
openpiv-python-cpu is a version of openpiv-python optimized for use with a central processing unit (CPU). OpenPIV-Python consists of Python modules for performing particle image velocimetry (PIV) analysis on a set of image pairs. This implementation adds more flexibility for adjusting the PIV parameters. The cross-correlation is performed using the fastest Fourier transform in the west (pyFFTW), while the frame deformation is accelerated by Numba. Both validation and replacement procedures have been improved, and replacement through spring analogy has been added. Overall, this project aimed at improving the performance and accuracy for CPU-based PIV analysis.
An alternative implementation of the same algorithms for use with a graphics processing unit (GPU) is available as openpiv-python-gpu.
OpenPIV-Python is currently under active development, which means it might contain some bugs, and its API is subject to change. This module has been tested on both Windows (work station and laptops) and Linux (Niagara supercomputing cluster and Google Colab) platforms.
Use the following command to install from GitHub:
pip install git+https://github.com/ali-sh-96/openpiv-python-cpu
The OpenPIV documentation is readily accessible on the project's webpage at https://openpiv.readthedocs.org. For information on how to use the modules, see the tutorial notebooks below.
- OpenPIV team
- Alex Liberzon
- Ali Shirinzad
- Pierre E. Sullivan
Copyright statement: cpu_smoothn.py is a Python version of smoothn.m originally created by
D. Garcia, written by Prof. Lewis, and available on
GitHub. We are thankful to the original authors for
releasing their work as an open source. OpenPIV license does not relate to this code. Please communicate with the
authors regarding their license.
Shirinzad, A., Jaber, K., Xu, K., & Sullivan, P. E. (2023). An Enhanced Python-Based Open-Source Particle Image Velocimetry Software for Use with Central Processing Units. Fluids, 8(11), 285. https://doi.org/10.3390/fluids8110285