piv_to_velocity — PIV `field` op

• Data kinds: flow2d → flow2d

• Call: import fullseye as fs; fs.ledger.piv_to_velocity(flow, pixel_size_m, dt_s) (to call the implementation directly, import pivops; pivops.piv_to_velocity(flow, pixel_size_m, dt_s); from the registry, opspiv.get("piv_to_velocity"))

Usage

Pixels/frame → m/s. Both are required arguments (no default values are provided).

Mixing up units changes the order of magnitude without raising an exception, so providing a default would make accidents the default —— the same judgement as cell_size in demops.

Returns:

(2, h, w) [m/s].

Detailed usage guide

• piv_displacement family guide

References (sample data, literature)

• Sample-data catalog (download URLs / licences) — 2-D uses skimage.data (BSD/public domain) plus synthetic images; 3-D lists download URLs for real data sources (Stanford, PDS, …).

• Operator provenance and references — the sources of the research/methods this op family came from.

• The canonical algorithm (author, year) and its uses are named in the family usage guide above.

Runnable examples (verified samples that actually call this op)

• piv_flow_from_particles — py -3.11 examples/piv_flow_from_particles.py

• poc_river_surface_velocity — py -3.11 examples/poc_river_surface_velocity.py

Ops the type connects to (they accept `flow2d` as input)

piv_deform_pass · piv_outlier_mask · piv_replace_outliers · piv_vorticity · piv_divergence · piv_flow_magnitude · piv_velocity_gradient · piv_q_criterion

Same category (`field`)

piv_vorticity · piv_divergence · piv_flow_magnitude · piv_velocity_gradient · piv_q_criterion · piv_swirling_strength · piv_strain_rate

*Provenance: pivops.py — PIV operator registry. This per-op note is generated by tools/opdocs.py md (do not hand-edit).*

piv_to_velocity — PIV field op