Struct re_types::archetypes::SegmentationImage
source · pub struct SegmentationImage {
pub buffer: Option<SerializedComponentBatch>,
pub format: Option<SerializedComponentBatch>,
pub opacity: Option<SerializedComponentBatch>,
pub draw_order: Option<SerializedComponentBatch>,
}
Expand description
Archetype: An image made up of integer components::ClassId
s.
Each pixel corresponds to a components::ClassId
that will be mapped to a color based on annotation context.
In the case of floating point images, the label will be looked up based on rounding to the nearest integer value.
See also archetypes::AnnotationContext
to associate each class with a color and a label.
§Example
§Simple segmentation image
use ndarray::{s, Array, ShapeBuilder};
fn main() -> Result<(), Box<dyn std::error::Error>> {
let rec = rerun::RecordingStreamBuilder::new("rerun_example_segmentation_image").spawn()?;
// create a segmentation image
let mut image = Array::<u8, _>::zeros((8, 12).f());
image.slice_mut(s![0..4, 0..6]).fill(1);
image.slice_mut(s![4..8, 6..12]).fill(2);
// create an annotation context to describe the classes
let annotation = rerun::AnnotationContext::new([
(1, "red", rerun::Rgba32::from_rgb(255, 0, 0)),
(2, "green", rerun::Rgba32::from_rgb(0, 255, 0)),
]);
// log the annotation and the image
rec.log_static("/", &annotation)?;
rec.log("image", &rerun::SegmentationImage::try_from(image)?)?;
Ok(())
}

Fields§
§buffer: Option<SerializedComponentBatch>
The raw image data.
format: Option<SerializedComponentBatch>
The format of the image.
opacity: Option<SerializedComponentBatch>
Opacity of the image, useful for layering the segmentation image on top of another image.
Defaults to 0.5 if there’s any other images in the scene, otherwise 1.0.
draw_order: Option<SerializedComponentBatch>
An optional floating point value that specifies the 2D drawing order.
Objects with higher values are drawn on top of those with lower values.
Implementations§
source§impl SegmentationImage
impl SegmentationImage
sourcepub fn descriptor_buffer() -> ComponentDescriptor
pub fn descriptor_buffer() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::buffer
.
sourcepub fn descriptor_format() -> ComponentDescriptor
pub fn descriptor_format() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::format
.
sourcepub fn descriptor_opacity() -> ComponentDescriptor
pub fn descriptor_opacity() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::opacity
.
sourcepub fn descriptor_draw_order() -> ComponentDescriptor
pub fn descriptor_draw_order() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::draw_order
.
sourcepub fn descriptor_indicator() -> ComponentDescriptor
pub fn descriptor_indicator() -> ComponentDescriptor
Returns the ComponentDescriptor
for the associated indicator component.
source§impl SegmentationImage
impl SegmentationImage
sourcepub const NUM_COMPONENTS: usize = 5usize
pub const NUM_COMPONENTS: usize = 5usize
The total number of components in the archetype: 2 required, 1 recommended, 2 optional
source§impl SegmentationImage
impl SegmentationImage
sourcepub fn new(
buffer: impl Into<ImageBuffer>,
format: impl Into<ImageFormat>,
) -> Self
pub fn new( buffer: impl Into<ImageBuffer>, format: impl Into<ImageFormat>, ) -> Self
Create a new SegmentationImage
.
sourcepub fn update_fields() -> Self
pub fn update_fields() -> Self
Update only some specific fields of a SegmentationImage
.
sourcepub fn clear_fields() -> Self
pub fn clear_fields() -> Self
Clear all the fields of a SegmentationImage
.
sourcepub fn columns<I>(
self,
_lengths: I,
) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>
pub fn columns<I>( self, _lengths: I, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>
Partitions the component data into multiple sub-batches.
Specifically, this transforms the existing SerializedComponentBatch
es data into SerializedComponentColumn
s
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.
sourcepub fn columns_of_unit_batches(
self,
) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>
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.
sourcepub fn with_buffer(self, buffer: impl Into<ImageBuffer>) -> Self
pub fn with_buffer(self, buffer: impl Into<ImageBuffer>) -> Self
The raw image data.
sourcepub fn with_many_buffer(
self,
buffer: impl IntoIterator<Item = impl Into<ImageBuffer>>,
) -> Self
pub fn with_many_buffer( self, buffer: impl IntoIterator<Item = impl Into<ImageBuffer>>, ) -> Self
This method makes it possible to pack multiple crate::components::ImageBuffer
in a single component batch.
This only makes sense when used in conjunction with Self::columns
. Self::with_buffer
should
be used when logging a single row’s worth of data.
sourcepub fn with_format(self, format: impl Into<ImageFormat>) -> Self
pub fn with_format(self, format: impl Into<ImageFormat>) -> Self
The format of the image.
sourcepub fn with_many_format(
self,
format: impl IntoIterator<Item = impl Into<ImageFormat>>,
) -> Self
pub fn with_many_format( self, format: impl IntoIterator<Item = impl Into<ImageFormat>>, ) -> Self
This method makes it possible to pack multiple crate::components::ImageFormat
in a single component batch.
This only makes sense when used in conjunction with Self::columns
. Self::with_format
should
be used when logging a single row’s worth of data.
sourcepub fn with_opacity(self, opacity: impl Into<Opacity>) -> Self
pub fn with_opacity(self, opacity: impl Into<Opacity>) -> Self
Opacity of the image, useful for layering the segmentation image on top of another image.
Defaults to 0.5 if there’s any other images in the scene, otherwise 1.0.
sourcepub fn with_many_opacity(
self,
opacity: impl IntoIterator<Item = impl Into<Opacity>>,
) -> Self
pub fn with_many_opacity( self, opacity: impl IntoIterator<Item = impl Into<Opacity>>, ) -> Self
This method makes it possible to pack multiple crate::components::Opacity
in a single component batch.
This only makes sense when used in conjunction with Self::columns
. Self::with_opacity
should
be used when logging a single row’s worth of data.
sourcepub fn with_draw_order(self, draw_order: impl Into<DrawOrder>) -> Self
pub fn with_draw_order(self, draw_order: impl Into<DrawOrder>) -> Self
An optional floating point value that specifies the 2D drawing order.
Objects with higher values are drawn on top of those with lower values.
sourcepub fn with_many_draw_order(
self,
draw_order: impl IntoIterator<Item = impl Into<DrawOrder>>,
) -> Self
pub fn with_many_draw_order( self, draw_order: impl IntoIterator<Item = impl Into<DrawOrder>>, ) -> Self
This method makes it possible to pack multiple crate::components::DrawOrder
in a single component batch.
This only makes sense when used in conjunction with Self::columns
. Self::with_draw_order
should
be used when logging a single row’s worth of data.
source§impl SegmentationImage
impl SegmentationImage
sourcepub fn try_from<T: TryInto<TensorData>>(
data: T,
) -> Result<Self, ImageConstructionError<T>>
pub fn try_from<T: TryInto<TensorData>>( data: T, ) -> Result<Self, ImageConstructionError<T>>
Try to construct a SegmentationImage
from anything that can be converted into TensorData
Will return an ImageConstructionError
if the shape of the tensor data is invalid
for treating as an image.
This is useful for constructing a SegmentationImage
from an ndarray.
Trait Implementations§
source§impl Archetype for SegmentationImage
impl Archetype for SegmentationImage
§type Indicator = GenericIndicatorComponent<SegmentationImage>
type Indicator = GenericIndicatorComponent<SegmentationImage>
source§fn name() -> ArchetypeName
fn name() -> ArchetypeName
rerun.archetypes.Points2D
.source§fn display_name() -> &'static str
fn display_name() -> &'static str
source§fn required_components() -> Cow<'static, [ComponentDescriptor]>
fn required_components() -> Cow<'static, [ComponentDescriptor]>
source§fn recommended_components() -> Cow<'static, [ComponentDescriptor]>
fn recommended_components() -> Cow<'static, [ComponentDescriptor]>
source§fn optional_components() -> Cow<'static, [ComponentDescriptor]>
fn optional_components() -> Cow<'static, [ComponentDescriptor]>
source§fn all_components() -> Cow<'static, [ComponentDescriptor]>
fn all_components() -> Cow<'static, [ComponentDescriptor]>
source§fn from_arrow_components(
arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>,
) -> DeserializationResult<Self>
fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>, ) -> DeserializationResult<Self>
ComponentNames
, deserializes them
into this archetype. Read moresource§fn from_arrow(
data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>,
) -> Result<Self, DeserializationError>where
Self: Sized,
fn from_arrow(
data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>,
) -> Result<Self, DeserializationError>where
Self: Sized,
source§impl AsComponents for SegmentationImage
impl AsComponents for SegmentationImage
source§fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>
fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>
SerializedComponentBatch
es. Read moresource§impl Clone for SegmentationImage
impl Clone for SegmentationImage
source§fn clone(&self) -> SegmentationImage
fn clone(&self) -> SegmentationImage
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for SegmentationImage
impl Debug for SegmentationImage
source§impl Default for SegmentationImage
impl Default for SegmentationImage
source§fn default() -> SegmentationImage
fn default() -> SegmentationImage
source§impl PartialEq for SegmentationImage
impl PartialEq for SegmentationImage
source§fn eq(&self, other: &SegmentationImage) -> bool
fn eq(&self, other: &SegmentationImage) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl SizeBytes for SegmentationImage
impl SizeBytes for SegmentationImage
source§fn heap_size_bytes(&self) -> u64
fn heap_size_bytes(&self) -> u64
self
uses on the heap. Read moresource§fn total_size_bytes(&self) -> u64
fn total_size_bytes(&self) -> u64
self
in bytes, accounting for both stack and heap space.source§fn stack_size_bytes(&self) -> u64
fn stack_size_bytes(&self) -> u64
self
on the stack, in bytes. Read moreimpl ArchetypeReflectionMarker for SegmentationImage
impl StructuralPartialEq for SegmentationImage
Auto Trait Implementations§
impl Freeze for SegmentationImage
impl !RefUnwindSafe for SegmentationImage
impl Send for SegmentationImage
impl Sync for SegmentationImage
impl Unpin for SegmentationImage
impl !UnwindSafe for SegmentationImage
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more