API reference

This page provides an auto-generated summary of synpivimage’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

Virtual PIV Setup

synpivimage.camera.Camera(*, nx, ny, ...[, seed])	Camera Model
synpivimage.camera.Camera.save_jsonld(filename)	Save the component to JSON
synpivimage.camera.Camera.load_jsonld(filename)	Load the camera from a JSON-LD file
synpivimage.laser.Laser(*, shape_factor, width)	Laser class.
synpivimage.laser.Laser.save_jsonld(filename)	Save the component to JSON.
synpivimage.laser.Laser.load_jsonld(filename)	Load the Laser from a JSON-LD file
synpivimage.particles.Particles(*, x, y, z, size)	Particle class