Struct rerun::archetypes::SegmentationImage
source · pub struct SegmentationImage {
pub data: TensorData,
pub draw_order: Option<DrawOrder>,
}
Expand description
Archetype: An image made up of integer class-ids.
The shape of the TensorData
must be mappable to an HxW
tensor.
Each pixel corresponds to a class-id 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.
Leading and trailing unit-dimensions are ignored, so that
1x640x480x1
is treated as a 640x480
image.
See also 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§
§data: TensorData
The image data. Should always be a rank-2 tensor.
draw_order: Option<DrawOrder>
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 const NUM_COMPONENTS: usize = 3usize
pub const NUM_COMPONENTS: usize = 3usize
The total number of components in the archetype: 1 required, 1 recommended, 1 optional
source§impl SegmentationImage
impl SegmentationImage
sourcepub fn new(data: impl Into<TensorData>) -> SegmentationImage
pub fn new(data: impl Into<TensorData>) -> SegmentationImage
Create a new SegmentationImage
.
sourcepub fn with_draw_order(
self,
draw_order: impl Into<DrawOrder>
) -> SegmentationImage
pub fn with_draw_order( self, draw_order: impl Into<DrawOrder> ) -> SegmentationImage
An optional floating point value that specifies the 2D drawing order.
Objects with higher values are drawn on top of those with lower values.
source§impl SegmentationImage
impl SegmentationImage
sourcepub fn try_from<T>(
data: T
) -> Result<SegmentationImage, ImageConstructionError<T>>
pub fn try_from<T>( data: T ) -> Result<SegmentationImage, 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 an 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 indicator() -> MaybeOwnedComponentBatch<'static>
fn indicator() -> MaybeOwnedComponentBatch<'static>
source§fn required_components() -> Cow<'static, [ComponentName]>
fn required_components() -> Cow<'static, [ComponentName]>
source§fn recommended_components() -> Cow<'static, [ComponentName]>
fn recommended_components() -> Cow<'static, [ComponentName]>
source§fn optional_components() -> Cow<'static, [ComponentName]>
fn optional_components() -> Cow<'static, [ComponentName]>
source§fn all_components() -> Cow<'static, [ComponentName]>
fn all_components() -> Cow<'static, [ComponentName]>
source§fn from_arrow_components(
arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)>
) -> Result<SegmentationImage, DeserializationError>
fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> Result<SegmentationImage, DeserializationError>
ComponentNames
, deserializes them
into this archetype. Read moresource§fn from_arrow(
data: impl IntoIterator<Item = (Field, Box<dyn Array>)>
) -> Result<Self, DeserializationError>where
Self: Sized,
fn from_arrow(
data: impl IntoIterator<Item = (Field, Box<dyn Array>)>
) -> Result<Self, DeserializationError>where
Self: Sized,
source§impl AsComponents for SegmentationImage
impl AsComponents for SegmentationImage
source§fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>
fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>
ComponentBatch
s. 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 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
on the heap, in bytes.source§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 moresource§impl ToArchetype<SegmentationImage> for LatestAtResults
impl ToArchetype<SegmentationImage> for LatestAtResults
source§fn to_archetype(
&self,
resolver: &PromiseResolver
) -> PromiseResult<Result<SegmentationImage, QueryError>>
fn to_archetype( &self, resolver: &PromiseResolver ) -> PromiseResult<Result<SegmentationImage, QueryError>>
re_types_core::Archetype
. Read moreimpl 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> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§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