piv_synth_pair — PIV synth op

Data kinds: noneimage2d (an op determined by its arguments alone — it takes no image or data input)

Call: import pivops; pivops.piv_synth_pair(shape, displacement, density=0.02, diameter_px=2.5, seed=0, noise_sigma=0.0, intensity=(0.6, 1.0), background=0.0) (or opspiv.get("piv_synth_pair"))

Usage

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

既知の変位場を持つ画像対を作る。返りは `(image_a, image_b, truth)`。

粒子を動かしてから 2 枚目を描く(1 枚目を補間で歪めるのではない)。

補間で作ると、補間の平滑化が「PIV が当てやすい絵」を作ってしまい、

自分の実装を自分に有利な入力で測ることになる。

Args:

shape: `(H, W)`。

displacement: 変位の与え方。次のいずれか。

• 長さ 2 の列 —— 一様並進 `(dy, dx)` [px]。

• `callable(rows, cols) -> (dy, dx)` —— 位置に依存する場。

引数は粒子の連続座標の配列。

density / diameter_px / seed / intensity / background: :func:piv_synth_particles と同じ。

noise_sigma: 2 枚それぞれに独立に足す加法ガウス雑音の標準偏差。

Returns:

`(a (H, W), b (H, W), truth (2, H, W))truth` は画素ごと

真の変位で、窓の格子に落とすには :func:piv_sample_at_windows を使う。

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_particlespy -3.11 examples/piv_flow_from_particles.py

poc_strain_historypy -3.11 examples/poc_strain_history.py

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

piv_cross_correlate · piv_multipass · piv_deform_pass · strain_from_displacement · correlation_quality · speckle_quality

Same category (synth)

piv_synth_particles · piv_synth_sequence


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