annotate_colorbar — ANNOTATE paper op

Data kinds: image2d × image2dimage2d

Call: import annotate; annotate.annotate_colorbar(img, field, rect, lut=None, vmin=None, vmax=None, alpha=0.6, mask=None, unit='', label_fmt='{:.3g}', orientation='vertical', font_size=12, scheme='okabe_ito', font_path=None, text_color=None, nan_transparent=False) (or opsannotate.get("annotate_colorbar"))

Usage

Returns an image (image2d): a scalar field colour-mapped through a LUT and overlaid, with a colour bar.

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

`t = (field - vmin)/(vmax - vmin) を [0,1] に**クリップ**し lut[round(t*(n-1))]`

で色にする(範囲外の値は端の色 —— カラーバーの端と同じなので嘘にならない)。

重ねは `alpha の α 合成、mask` を渡せばその画素だけ。

Parameters

----------

field : (H, W)

画像と同じ大きさのスカラ場。非有限は `nan_transparent=True` のときだけ

透明として許す(既定は ValueError)。

lut : (n, 3) or None

None なら :func:palette.diverging_lut の 256 段。

vmin, vmax : float or None

None なら場の(有限値の)最小・最大。等しければ ValueError。

Raises

------

ValueError

形の不一致、非有限(許可なし)、vmin == vmax、alpha が [0,1] の外、

バーの矩形が画像外、LUT の形。

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

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.