Struct re_types::archetypes::AnnotationContext

pub struct AnnotationContext {
    pub context: Option<SerializedComponentBatch>,
}

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

use ndarray::{s, Array, ShapeBuilder};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_annotation_context_segmentation")
        .spawn()?;

    // create an annotation context to describe the classes
    rec.log_static(
        "segmentation",
        &rerun::AnnotationContext::new([
            (1, "red", rerun::Rgba32::from_rgb(255, 0, 0)),
            (2, "green", rerun::Rgba32::from_rgb(0, 255, 0)),
        ]),
    )?;

    // create a segmentation image
    let mut data = Array::<u8, _>::zeros((200, 300).f());
    data.slice_mut(s![50..100, 50..120]).fill(1);
    data.slice_mut(s![100..180, 130..280]).fill(2);

    rec.log(
        "segmentation/image",
        &rerun::SegmentationImage::try_from(data)?,
    )?;

    Ok(())
}

Fields

context: Option<SerializedComponentBatch>

List of class descriptions, mapping class indices to class names, colors etc.

Implementations

impl AnnotationContext

pub fn descriptor_context() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::context.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl AnnotationContext

pub const NUM_COMPONENTS: usize = 2usize

The total number of components in the archetype: 1 required, 1 recommended, 0 optional

impl AnnotationContext

pub fn new(context: impl Into<AnnotationContext>) -> Self

Create a new AnnotationContext.

pub fn update_fields() -> Self

Update only some specific fields of a AnnotationContext.

pub fn clear_fields() -> Self

Clear all the fields of a AnnotationContext.

pub fn columns<I>( self, _lengths: I, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>

where I: IntoIterator<Item = usize> + Clone,

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing SerializedComponentBatches data into SerializedComponentColumns instead, via SerializedComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

pub fn columns_of_unit_batches( self, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>

Helper to partition the component data into unit-length sub-batches.

This is semantically similar to calling Self::columns with std::iter::take(1).repeat(n), where n is automatically guessed.

pub fn with_context(self, context: impl Into<AnnotationContext>) -> Self

List of class descriptions, mapping class indices to class names, colors etc.

pub fn with_many_context( self, context: impl IntoIterator<Item = impl Into<AnnotationContext>>, ) -> Self

This method makes it possible to pack multiple crate::components::AnnotationContext in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_context should be used when logging a single row’s worth of data.

Trait Implementations

impl Archetype for AnnotationContext

type Indicator = GenericIndicatorComponent<AnnotationContext>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in UI.

fn indicator() -> SerializedComponentBatch

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>, ) -> DeserializationResult<Self>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>, ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for AnnotationContext

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

Exposes the object’s contents as a set of SerializedComponentBatches.

fn to_arrow(&self) -> Result<Vec<(Field, Arc<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Clone for AnnotationContext

fn clone(&self) -> AnnotationContext

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AnnotationContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AnnotationContext

fn default() -> AnnotationContext

Returns the “default value” for a type.

impl PartialEq for AnnotationContext

fn eq(&self, other: &AnnotationContext) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for AnnotationContext

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

impl ArchetypeReflectionMarker for AnnotationContext

impl StructuralPartialEq for AnnotationContext