rerun::archetypes::AnnotationContext Struct Reference

Archetype: The annotation context provides additional information on how to display entities. More...

#include <rerun/archetypes/annotation_context.hpp>

Public Types
using	IndicatorComponent = rerun::components::IndicatorComponent< IndicatorComponentName >
	Indicator component, used to identify the archetype when converting to a list of components.

Public Member Functions
	AnnotationContext (AnnotationContext &&other)=default
	AnnotationContext (rerun::components::AnnotationContext _context)

Public Attributes
rerun::components::AnnotationContext	context
	List of class descriptions, mapping class indices to class names, colors etc.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

Detailed Description

Archetype: The annotation context provides additional information on how to display entities.

Entities can use components::ClassIds and components::KeypointIds to provide annotations, and the labels and colors will be looked up in the appropriate annotation context. We use the first annotation context we find in the path-hierarchy when searching up through the ancestors of a given entity path.

See also datatypes::ClassDescription.

Example

Segmentation

#include <rerun.hpp>
 
#include <algorithm> // fill_n
#include <vector>
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_annotation_context_segmentation");
    rec.spawn().exit_on_failure();
 
    // create an annotation context to describe the classes
    rec.log_static(
        "segmentation",
        rerun::AnnotationContext({
            rerun::AnnotationInfo(1, "red", rerun::Rgba32(255, 0, 0)),
            rerun::AnnotationInfo(2, "green", rerun::Rgba32(0, 255, 0)),
        })
    );
 
    // create a segmentation image
    const int HEIGHT = 200;
    const int WIDTH = 300;
    std::vector<uint8_t> data(WIDTH * HEIGHT, 0);
    for (auto y = 50; y <100; ++y) {
        std::fill_n(data.begin() + y * WIDTH + 50, 70, static_cast<uint8_t>(1));
    }
    for (auto y = 100; y <180; ++y) {
        std::fill_n(data.begin() + y * WIDTH + 130, 150, static_cast<uint8_t>(2));
    }
 
    rec.log("segmentation/image", rerun::SegmentationImage(data.data(), {WIDTH, HEIGHT}));
}

Member Data Documentation

IndicatorComponentName

constexpr const char rerun::archetypes::AnnotationContext::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.components.AnnotationContextIndicator"

---

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

• rerun/archetypes/annotation_context.hpp