Struct re_types::archetypes::Image

pub struct Image {
    pub data: TensorData,
    pub draw_order: Option<DrawOrder>,
}

Expand description

Archetype: A monochrome or color image.

The shape of the TensorData must be mappable to:

A HxW tensor, treated as a grayscale image.
A HxWx3 tensor, treated as an RGB image.
A HxWx4 tensor, treated as an RGBA image.

Leading and trailing unit-dimensions are ignored, so that 1x640x480x3x1 is treated as a 640x480x3 RGB image.

Example

`image_simple`:

//! Create and log an image

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

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

    let mut image = Array::<u8, _>::zeros((8, 12, 3).f());
    image.slice_mut(s![.., .., 0]).fill(255);
    image.slice_mut(s![0..4, 0..6, 0]).fill(0);
    image.slice_mut(s![0..4, 0..6, 1]).fill(255);

    rec.log("image", &rerun::Image::try_from(image)?)?;

    rerun::native_viewer::show(storage.take())?;
    Ok(())
}

Fields§

§data: TensorData

The image data. Should always be a rank-2 or rank-3 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§

impl Image

pub const NUM_COMPONENTS: usize = 4usize

impl Image

pub fn new(data: impl Into<TensorData>) -> Self

pub fn with_draw_order(self, draw_order: impl Into<DrawOrder>) -> Self

impl Image

pub fn try_from<T: TryInto<TensorData>>( data: T ) -> Result<Self, ImageConstructionError<T>>
where <T as TryInto<TensorData>>::Error: Error,

Try to construct an Image 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 Image from an ndarray.

Trait Implementations§

impl Archetype for Image

type Indicator = GenericIndicatorComponent<Image>

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

fn name() -> ArchetypeName

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

fn indicator() -> MaybeOwnedComponentBatch<'static>

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

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

Returns the names of all components that must be provided by the user when constructing this archetype.

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

Returns the names of all components that should be provided by the user when constructing this archetype.

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

Returns the names of all components that may be provided by the user when constructing this archetype.

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

Returns the names of all components that must, should and may be provided by the user when constructing this archetype. Read more

fn from_arrow( arrow_data: impl IntoIterator<Item = (Field, Box<dyn Array>)> ) -> DeserializationResult<Self>

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

impl AsComponents for Image

fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>

Exposes the object’s contents as a set of ComponentBatchs. Read more

fn num_instances(&self) -> usize

The number of instances in each batch. Read more

fn to_arrow(&self) -> SerializationResult<Vec<(Field, Box<dyn Array>)>>

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

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Image

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

Formats the value using the given formatter. Read more

impl PartialEq for Image

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

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

1.0.0 · source§

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<'a> TryFrom<&'a Image> for ArrayViewD<'a, f16>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Image> for ArrayViewD<'a, f32>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Image> for ArrayViewD<'a, f64>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Image> for ArrayViewD<'a, i16>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Image> for ArrayViewD<'a, i32>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Image> for ArrayViewD<'a, i64>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Image> for ArrayViewD<'a, i8>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Image> for ArrayViewD<'a, u16>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Image> for ArrayViewD<'a, u32>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Image> for ArrayViewD<'a, u64>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Image> for ArrayViewD<'a, u8>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: &'a Image) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Image

Auto Trait Implementations§

impl RefUnwindSafe for Image

impl Send for Image

impl Sync for Image

impl Unpin for Image

impl UnwindSafe for Image

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more