API reference¶
Every command is a front-end over a module of the hbb2obb package, and the same functions can be imported directly:
| Module | What it holds | Command |
|---|---|---|
hbb2obb.converter |
The conversion: one image in, its OBBs out, and the writers for them. | hbb2obb |
hbb2obb.detector |
Detection of horizontal boxes, and merging detections with hand-drawn ones. | hbb2obb-detect |
hbb2obb.evaluator |
Matching and scoring OBBs against ground truth. | hbb2obb-eval |
hbb2obb.analysis |
The breakdown of an evaluation by what the ground-truth box looks like. | hbb2obb-analyze |
hbb2obb.formats |
Readers and writers for the five annotation formats over one box representation. | hbb2obb-convert, hbb2obb-view |
Coordinates are in absolute pixels throughout, and paths are pathlib.Path objects. Each guide ends with a worked example: conversion, detection, evaluation, analysis and formats.
The modules not listed here (cli, optimizer, plotting, provenance, viewer, utils) serve the commands and may change between releases.