auterion::ClassCatalog Class Reference

Names for the classes a detector reports, for the ground station to display. More...

#include <auterion_sdk/object_detection/class_catalog.hpp>

Public Member Functions
bool	empty () const
	True when no class is named.
std::size_t	size () const
const std::map< uint32_t, ClassEntry > &	entries () const
	The named classes, keyed by class id.

Static Public Member Functions
static ClassCatalog	fromModelOrder (const std::vector< std::string > &names_in_model_order)
	Names in model index order: element i names class i.
static ClassCatalog	fromClassIds (const std::map< uint32_t, std::string > &class_id_to_name)
	Names keyed by id, for a detector that numbers its classes itself.
static ClassCatalog	fromEntries (const std::map< uint32_t, ClassEntry > &class_id_to_entry)
	Names keyed by id, with a colour and category per class.

Detailed Description

Names for the classes a detector reports, for the ground station to display.

Ids are the detector's own class numbers: no offset is applied anywhere along the way. An empty catalog is valid, and the ground station then displays the raw ids.

Member Function Documentation

fromClassIds()

static ClassCatalog auterion::ClassCatalog::fromClassIds ( const std::map< uint32_t, std::string > &  class_id_to_name )

static

Names keyed by id, for a detector that numbers its classes itself.

Parameters

class_id_to_name

Class id to name. An entry keyed by kUnknownClassId is ignored.

fromEntries()

static ClassCatalog auterion::ClassCatalog::fromEntries ( const std::map< uint32_t, ClassEntry > &  class_id_to_entry )

static

Names keyed by id, with a colour and category per class.

The general form of fromClassIds().

Parameters

class_id_to_entry

Class id to entry. An entry keyed by kUnknownClassId is ignored.

fromModelOrder()

static ClassCatalog auterion::ClassCatalog::fromModelOrder ( const std::vector< std::string > &  names_in_model_order )

static

Names in model index order: element i names class i.

Parameters

names_in_model_order

Class names, densely indexed from class 0.

---

The documentation for this class was generated from the following file:

• include/auterion_sdk/object_detection/class_catalog.hpp