color_bar — ANNOTATE furniture op

Data kinds: image2d × lutimage2d

Call: import annotate; annotate.color_bar(img, lut, rect, vmin=0.0, vmax=1.0, unit='', label_fmt='{:g}', orientation='vertical', font_size=12, font_path=None, scheme='okabe_ito', border=1, border_color='neutral', text_color=None, style=None) (or opsannotate.get("color_bar"))

Usage

The legend of a LUT (a colour bar), labelled with its minimum, maximum and unit.

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

Parameters

----------

lut : (n,3) or (n,)

色対応表。float [0,1]。:func:palette.diverging_lut の出力をそのまま。

rect : (x, y, w, h)

バーの矩形(左上基準)。

vmin, vmax : float

両端の値。`vmin == vmax` は目盛りの意味が消えるので ValueError。

orientation : {'vertical','horizontal'}

`'vertical'` は 上が vmax(row は下向きなので LUT を反転する)。

Returns

-------

ndarray

Raises

------

ValueError

LUT の形/値域、矩形のはみ出し、vmin==vmax、未知の orientation。

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 · scale_bar · axes_frame

Same category (furniture)

legend_box · scale_bar


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