annotate_outline — ANNOTATE paper op

Data kinds: image2d × maskimage2d

Call: import fullseye as fs; fs.ledger.annotate_outline(img, mask, label=None, color='emphasis', width=1.5, alpha=1.0, dash=None, font_size=12, label_offset=(0, 0), box_alpha=0.6, text_color=None, scheme='okabe_ito', font_path=None, layout=None) (to call the implementation directly, import annotate; annotate.annotate_outline(img, mask, label=None, color='emphasis', width=1.5, alpha=1.0, dash=None, font_size=12, label_offset=(0, 0), box_alpha=0.6, text_color=None, scheme='okabe_ito', font_path=None, layout=None); from the registry, opsannotate.get("annotate_outline"))

Usage

Returns an image (image2d): the outline of a mask as an (anti-aliased) closed polyline, with text at the centroid.

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

Raises

------

ValueError

mask の形が画像と違う、真の画素が無い、alpha が [0,1] の外。

手順: `layout が無ければ annotate_outline_layout(mask)` で境界ループ

(画素の辺に沿う `(x, y)` の閉多角形、外周と穴の両方、成分ごと)と重心を

求め、各ループを距離被覆率のアンチエイリアス折れ線で載せる。`label` が

あれば重心 + `label_offsettext_box(anchor="cm"`、下敷き付き)を置く。

• `img: (H, W) / (H, W, 1|3|4)、float64 複製・[0, 1]`。

• `mask: (H, W)、画像と同じ形([row, col] 添字)。bool 以外は > 0.5`

で二値化、非有限は `ValueError。真の画素が無ければ ValueError`。

• `width: 線幅 [px]、0.5 以上。dash=(on, off) [px] で破線(on > 0`、

`off >= 0`)。

• `alpha: [0, 1]box_alpha` は文字の下敷きの不透明度。

• `label_offset: (dx, dy)` [px]。重心が輪郭の外に落ちる形(三日月など)は

ここでずらす。

• `layout: annotate_outline_layout` の返り値を渡すと再計算せず同じ配置を

別の絵に使い回せる(`contours / centroid` を読む)。

• 返り値: 入力と同形の float64。

塗りで示すなら `overlay_mask、複数領域に番号を振るなら annotate_markers`。

Detailed usage guide

figure_annotation family guide

Background guides (the physics and conventions behind this op)

dataset_conventions — 学習データセット規約の知識 — COCO / YOLO / VOC と外観検査での落とし穴

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)

paper_figurepy -3.11 examples/paper_figure.py

poc_rotation_invariance_auditpy -3.11 examples/poc_rotation_invariance_audit.py

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

text_box · arrow · leader_line · label_points · crosshair · legend_box · color_bar · scale_bar

Same category (paper)

annotate_leader_layout · annotate_leader · annotate_markers · annotate_legend · annotate_dimension_layout · annotate_dimension · annotate_angle_layout · annotate_angle


*Provenance: annotate.py — ANNOTATE 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.