piv_outlier_mask — PIV validate op

Data kinds: flow2dmask

Call: import pivops; pivops.piv_outlier_mask(flow, threshold=2.0, epsilon=0.1) (or opspiv.get("piv_outlier_mask"))

Usage

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

正規化中央値検定(Westerweel & Scarano 2005)で外れベクトルを見つける。

各ベクトルについて、8 近傍の中央値からの残差を近傍残差の中央値で割る。

分母に `epsilon`(既定 0.1 px、PIV の測定不確かさの目安)を足すのは、

一様な場で分母が 0 になって全部が外れ値になるのを防ぐため —— この項が

無いと、理想的な入力ほど検定が壊れる

勾配の急な場では害になる(2026-09-06 実測)。Rankine 型の渦

(芯の半径 28 px)で多段 PIV を掛けたところ、閾値 2 が拾った 5 本は

すべて芯の縁(中心から 32 px)に並び、実際の誤差は 0.07-0.45 px ——

外れ値ではなく速度分布が折れている場所だった。近傍中央値で均すと

RMS が 0.134 から 0.230 へ悪化する(閾値 5 では 1 本も拾わず 0.134 のまま)。

検定は「近傍と違う = 間違い」という仮定に立つので、**本物の不連続を

間違いと呼ぶ**。掛けるかどうかは場の性質を見て決めること。

Args:

flow: `(2, h, w)`。

threshold: この値を超えたら外れ値。慣行は 2。

epsilon: 分母の下駄 [px]。

Returns:

`(h, w) の bool。True が外れ値(nanTrue`)。

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

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

piv_replace_outliers

Same category (validate)

piv_replace_outliers


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