overlay_mask — ANNOTATE overlay op

Data kinds: image2d × maskimage2d

Call: import annotate; annotate.overlay_mask(img, mask, color='wrong', alpha=0.45, outline=0, outline_color=None, scheme='okabe_ito', style=None) (or opsannotate.get("overlay_mask"))

Usage

Overlay a binary mask with alpha. **Exactly `a*f + (1-a)*b`.**

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

Parameters

----------

mask : (H,W)

画像と同じ大きさの真偽(または [0,1] の重み)。

形が違えば例外 ―― (row,col) と (x,y) の取り違えはここで死ぬ。

alpha : float

マスク側の重み。

outline : int

0 より大きければマスクの輪郭を太さ `outline` で描く。

Raises

------

ValueError

形の不一致 / alpha が [0,1] の外 / mask に非有限。

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)

annotate_gallerypy -3.11 examples/annotate_gallery.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 (overlay)

overlay_labels


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