DPIVSoft documentation

Open, vendor-neutral, GPU-accelerated classical PIV (Particle Image Velocimetry). The documentation has three layers: the User guide gets you from installation to a first (stereo) measurement; the Theory pages explain the implemented methods – the PIV algorithm, its OpenCL parallelisation, stereo calibration and 3C reconstruction, and vorticity-based force estimation – with their derivations and practical notes; the API reference is generated directly from the NumPy-style docstrings in the source, so editing a docstring and rebuilding updates the corresponding page.

User guide

• Getting started
  • Installation
  • A first PIV run (CPU)
  • The same run on the GPU
  • Tutorials
  • Where to go next
• Stereo calibration workflow
  • What you need
  • 1. Launch the calibration GUI
  • 2. Enter the target geometry
  • 3. Per image: detect, sort, save
  • 4. Fit the calibration (“Soloff Calculation”)
  • 5. PIV on the raw images
  • 6. Reconstruct the three components
  • 7. Optional: Δz self-calibration
  • Status and honest caveats

Theory

• The PIV algorithm
  • 1. What PIV measures
  • 2. Algorithm at a glance
  • 3. Normalized cross-correlation of one window
  • 4. Finding the peak with sub-pixel accuracy (find_peaks)
  • 5. Multi-pass processing with window deformation
  • 6. Validation: the median filter
  • 7. Masks (solid regions)
  • 8. Parameters
  • 9. Practical use (CPU path)
  • 10. Function reference
  • References
• The OpenCL (GPU) implementation
  • 1. Why PIV maps well to a GPU
  • 2. Software stack
  • 3. The kernel inventory
  • 4. Set-up: three calls, once each
  • 5. Geometry-dependent kernels and work-group limits
  • 6. Memory management
  • 7. Hiding the file I/O
  • 8. The pipeline, stage by stage
  • 9. Function reference
  • References
• Stereo PIV: calibration & 3-component reconstruction
  • 1. The core idea
  • 2. Coordinate conventions
  • 3. The two calibration models
  • 4. Fitting the calibration (stereo_calibration)
  • 5. The local mapping Jacobian
  • 6. Soloff 3C reconstruction (soloff_velocity)
  • 7. Model dispatch
  • 8. When does the full model help?
  • 9. World grid & dewarp
  • 10. Disparity / \(\Delta z\) self-calibration
  • 11. File format (.npz)
  • 12. Function reference
  • References
• Force estimation from PIV fields
  • 1. Why compute forces from vorticity?
  • 2. Notation and inputs
  • 3. Computing the vorticity field
  • 4. Method 1 — the vortical impulse method (ImpulseMethod)
  • 5. Method 2 — the projection method (ProjectionMethod)
  • 6. The FEM machinery (meshTools.py)
  • 7. Choosing between the two methods
  • 8. Function reference
  • References

API reference

• dpivsoft.DPIV
  • processing()
  • corrFFT1()
  • corrFFT1bis()
  • corrFFT2()
  • corrDirect1()
  • gauss_subpixel()
  • find_peaks()
  • median_filter()
  • gaussian_filter()
  • gaussian_kernel()
  • jacobian_matrix()
  • interpolations()
  • translated_pixels()
  • deform_image()
  • weight_function()
  • masking()
  • change_mask()
  • check_mask()
  • load_images()
  • save()
• dpivsoft.Cl_DPIV
  • select_Platform()
  • compile_Kernels()
  • initialization()
  • processing()
• dpivsoft.Classes
  • Parameters
  • grid
  • Synt_Img
  • GPU
• dpivsoft.Postprocessing
  • vorticity()
  • vortex_profile()
  • walls_vorticity()
  • divergence()
  • stream_lines()
  • ImpulseMethod()
  • ProjectionMethod()
  • Surface_projection()
  • Object()
  • ControlVolume()
  • FieldDerivatives()
• dpivsoft.SyIm
  • Analytic_Syntetic()
  • Custom_Syntetic()
  • random_transformation()
  • Velocity_Profile()
  • Gen_trazers()
  • Img_Generation()
  • Pix2PIV()
  • SaveImg()
• dpivsoft.stereo_DPIV
  • rgb2gray()
  • stereo_calibration()
  • _poly9_design()
  • _poly19_design()
  • _fit_poly9()
  • _fit_poly19()
  • _is_full_poly()
  • _poly9_eval()
  • _poly9_jacobian()
  • _poly19_eval()
  • _poly19_jacobian()
  • _poly_eval()
  • _poly_jacobian()
  • _stereo_recon_grid()
  • soloff_velocity()
  • save()
  • make_world_grid()
  • backproject_image()
  • list_images()
  • download_pivchallenge_E()
  • backproject_folder()
  • compute_disparity()
  • build_disparity_maps()
  • disparity_to_delta_z()
  • delta_z_on_world_grid()
  • disparity_convergence_report()
  • calibration_GUI()
• dpivsoft.stereo_gui
  • read_grayscale_image()
  • find_points_TSI()
  • find_points_LaVision()
  • sort_points()
  • calibration_mesh()
  • StereoCalibrationApp
  • calibration_GUI()
• dpivsoft.meshTools
  • body_options()
  • mesh_generator()
  • projection_FEM_Solver()
  • FEM_Solver()
  • compute_added_mass()
  • plotPhiResults()
  • plot_mesh()
  • projectionMesh2Grid()
  • Read_Mesh()

Indices and tables

• Index

• Module Index

• Search Page