piv_streamline_image — PIV visualise op

• Data kinds: flow2d → rgb

• Call: import fullseye as fs; fs.ledger.piv_streamline_image(flow, upsample=8, background=None, color=(0.08, 0.08, 0.12), width=1.5, arrows=True, **stream_kw) (to call the implementation directly, import pivops; pivops.piv_streamline_image(flow, upsample=8, background=None, color=(0.08, 0.08, 0.12), width=1.5, arrows=True, **stream_kw); from the registry, opspiv.get("piv_streamline_image"))

Usage

Streamline plot (MATLAB's streamslice). Returns (h*upsample, w*upsample, 3).

Lines are drawn with the evenly spaced placement of piv_streamlines, and 1 arrowhead showing direction is placed midway along each line's arc length (unlike LIC, forward and backward can be read). Since the line spacing is uniform, line density does not represent speed —— to see speed, lay piv_flow_magnitude or a hue map in background.

Args:

flow: (2, h, w).

upsample / background / color / width: same as piv_quiver.

arrows: whether to place arrowheads.

**stream_kw: passed through to piv_streamlines (separation etc.).

Returns:

(h*upsample, w*upsample, 3) float64, range [0, 1].

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_field_analysis_tour — py -3.11 examples/piv_field_analysis_tour.py

Ops the type connects to (they accept rgb as input)

—

Same category (visualise)

piv_flow_to_rgbimage · piv_line_integral_convolution · piv_streamlines · piv_quiver


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

© 2026 Kazufumi Furuse — Fullseye operator documentation. Licensed under Apache-2.0.