piv_ensemble_correlate — PIV estimate op

• Data kinds: images → flow2d

• Call: import fullseye as fs; fs.ledger.piv_ensemble_correlate(images, window=32, overlap=0.5, peak='gauss3', window_func='hann', normalize='overlap', search_limit=0.25) (to call the implementation directly, import pivops; pivops.piv_ensemble_correlate(images, window=32, overlap=0.5, peak='gauss3', window_func='hann', normalize='overlap', search_limit=0.25); from the registry, opspiv.get("piv_ensemble_correlate"))

• Return value through the ledger: fullseye.ledger.piv_ensemble_correlate(...) returns **only the declared out type flow2d** (the underlying function also returns auxiliary values). When you need what was dropped, use fullseye.ledger.piv_ensemble_correlate.raw(...) or call pivops.piv_ensemble_correlate directly.

• Underlying return: (flow, info) -> flow2d

Usage

> This operator's description has not been translated yet. The original text follows as it is.

相関マップを足してからピークを探す(アンサンブル相関)。

粒子が少ない・雑音が多い場合、1 対ずつ測って平均すると**外れたベクトルの

平均**になる。相関の段階で足すと、弱いピークが同じ場所に積み上がって

立ち上がる。定常流(全対で変位が同じ)が前提。

Args:

images: 2 枚以上の画像の列。連続する対 `(k, k+1)` を使う。

window / overlap / peak / window_func / normalize / search_limit:

:func:piv_cross_correlate と同じ。

Returns:

`(flow (2, h, w), info)。info["pairs"]` に使った対の数。

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

• 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_to_velocity · piv_velocity_gradient

Same category (estimate)

piv_cross_correlate · piv_multipass · piv_deform_pass

*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.