annotate_scale_bar_layout — ANNOTATE paper op

• Data kinds: none → table (an op determined by its arguments alone — it takes no image or data input)

• Call: import fullseye as fs; fs.ledger.annotate_scale_bar_layout(shape, units_per_pixel, unit='µm', corner='rb', target_fraction=0.2, margin=14, thickness=5) (to call the implementation directly, import annotate; annotate.annotate_scale_bar_layout(shape, units_per_pixel, unit='µm', corner='rb', target_fraction=0.2, margin=14, thickness=5); from the registry, opsannotate.get("annotate_scale_bar_layout"))

Usage

Returns a table (dict): a bar of a round length, at most target_fraction of the image width.

Of 1/2/5 × 10^k, the length is the one at or below target_fraction * W * units_per_pixel with the largest value. Pixel length = round(length / units_per_pixel).

Returns

dict

{"length","px","rect":(x,y,w,h),"unit","corner","label"}.

Raises

ValueError

units_per_pixel / target_fraction is not positive, unknown corner,

or the bar is shorter than 1 pixel or does not fit in the image.

Detailed usage guide

• figure_annotation family guide

Background guides (the physics and conventions behind this op)

• dataset_conventions — Training-dataset conventions — COCO / YOLO / VOC and pitfalls in visual inspection

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_figure — py -3.11 examples/paper_figure.py

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

—

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.