filter_by_volume — 3D regionprops op

Data kinds: voxelvoxel

Call: import fullseye as fs; fs.ledger.filter_by_volume(vol, min_voxels: 'int', connectivity: 'int' = 26) -> 'np.ndarray' (to call the implementation directly, import regionprops3d; regionprops3d.filter_by_volume(vol, min_voxels: 'int', connectivity: 'int' = 26) -> 'np.ndarray'; from the registry, ops3d.get("filter_by_volume"))

Usage

Return a bool mask with the connected components below min_voxels removed.

> The detailed description below is the original text — the summary and the headings are translated.

Parameters

----------

vol : array_like

bool または 0/1 の 3D 配列。

min_voxels : int

この閾値「未満」(< min_voxels)の成分を落とす。閾値 "以上" は残す。

connectivity : int

6 / 18 / 26。

Returns

-------

ndarray(bool)

条件を満たす成分のみ True。前景無しや全成分除去なら全 False。

補足:

• `min_voxelsint()` で丸めてから比較する。1 以下ならすべての成分が残る。

• 内部で `label_componentsbincountcounts >= min_voxels のラベルを残す。ラベルの再番号付けは行わず bool マスクだけ返すので、番号が要るなら結果をもう一度 label_components` に通す。

• 入力は 0 以外を前景として bool 化する(NaN も前景)。軸順 (z, y, x)。

• Raises `ValueError: 3 次元でない入力、connectivity` が 6/18/26 以外。

• ボクセル数はスペーシング未補正なので、実寸で閾値を切るなら voxel 体積で割ってから渡す。

Background guides (the physics and conventions behind this op)

measurement_uncertainty — 計測の不確かさと校正の知識 — 「測れている」を主張するために

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.

Runnable examples (verified samples that actually call this op)

region_props_3dpy -3.11 examples_3d/region_props_3d.py

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

voxel_to_mips · voxel_to_mesh · signed_distance_field · to_points · sobel3d · hessian3d · curvature_maps · edt_jfa

Same category (regionprops)

label_components · region_props · largest_component · inner_box3 · vol_label · vol_region_props


*Provenance: regionprops3d.py — 3D 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.