Struct re_types::archetypes::Tensor

pub struct Tensor {
    pub data: TensorData,
}

Archetype: A generic n-dimensional Tensor.

Example

Simple tensor

use ndarray::{Array, ShapeBuilder};

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

    let mut data = Array::<u8, _>::default((8, 6, 3, 5).f());
    data.map_inplace(|x| *x = rand::random());

    let tensor =
        rerun::Tensor::try_from(data)?.with_dim_names(["width", "height", "channel", "batch"]);
    rec.log("tensor", &tensor)?;

    Ok(())
}

Fields

data: TensorData

The tensor data

Implementations

impl Tensor

pub const NUM_COMPONENTS: usize = 2usize

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

impl Tensor

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

Create a new Tensor.

impl Tensor

pub fn data(&self) -> &TensorData

Accessor to the underlying TensorData.

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

Try to construct a Tensor from anything that can be converted into TensorData

This is useful for constructing a tensor from an ndarray.

pub fn with_dim_names( self, names: impl IntoIterator<Item = impl Into<ArrowString>> ) -> Self

Update the names of the contained TensorData dimensions.

Any existing Dimension names will be overwritten.

If too many, or too few names are provided, this function will warn and only update the subset of names that it can.

Trait Implementations

impl Archetype for Tensor

type Indicator = GenericIndicatorComponent<Tensor>

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 indicator() -> MaybeOwnedComponentBatch<'static>

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

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.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> 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, Box<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 Tensor

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

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

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

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

impl Clone for Tensor

fn clone(&self) -> Tensor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tensor

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

Formats the value using the given formatter.

impl PartialEq for Tensor

fn eq(&self, other: &Tensor) -> 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 Tensor

fn heap_size_bytes(&self) -> u64

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

fn is_pod() -> bool

Is Self just plain old data?

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.

impl<'a> TryFrom<&'a Tensor> for ArrayViewD<'a, f16>

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TensorCastError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for Tensor