compare_frame — ANNOTATE compose op

Data kinds: image2d × image2dimage2d

Call: import annotate; annotate.compare_frame(left, right, layout='h', labels=None, divider=3, gap=0, divider_color='neutral', background=0.0, label_anchor='lt', label_margin=8, scheme='okabe_ito', **text_kw) (or opsannotate.get("compare_frame"))

Usage

Put two images side by side, with a divider and labels at the boundary.

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

Parameters

----------

left, right : ndarray

比べる 2 枚。大きさが違ってもよい(足りない側は `background` で埋める)。

チャンネル数は揃っていること。

layout : {'h','v'}

`'h' = 左右、'v'` = 上下。

labels : (str, str) or None

それぞれの見出し。

divider : int

仕切りの太さ [px] (0 で無し)。

gap : int

仕切りの両側に空ける余白[px]。

Returns

-------

ndarray

新しい合成画像。

Raises

------

ValueError

チャンネル数の不一致 / 未知の layout / 負の divider・gap /

labels が 2 要素でない。

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 (compose)

zoom_inset · panel_grid


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