Struct rerun::Tensor

pub struct Tensor {
    pub data: TensorData,
    pub value_range: Option<ValueRange>,
}

Archetype: An N-dimensional array of numbers.

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

value_range: Option<ValueRange>

The expected range of values.

This is typically the expected range of valid values. Everything outside of the range is clamped to the range for the purpose of colormpaping. Any colormap applied for display, will map this range.

If not specified, the range will be automatically estimated from the data. Note that the Viewer may try to guess a wider range than the minimum/maximum of values in the contents of the tensor. E.g. if all values are positive, some bigger than 1.0 and all smaller than 255.0, the Viewer will guess that the data likely came from an 8bit image, thus assuming a range of 0-255.

Implementations

impl Tensor

pub const NUM_COMPONENTS: usize = 3usize

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

impl Tensor

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

Create a new Tensor.

pub fn with_value_range(self, value_range: impl Into<ValueRange>) -> Tensor

The expected range of values.

This is typically the expected range of valid values. Everything outside of the range is clamped to the range for the purpose of colormpaping. Any colormap applied for display, will map this range.

If not specified, the range will be automatically estimated from the data. Note that the Viewer may try to guess a wider range than the minimum/maximum of values in the contents of the tensor. E.g. if all values are positive, some bigger than 1.0 and all smaller than 255.0, the Viewer will guess that the data likely came from an 8bit image, thus assuming a range of 0-255.

impl Tensor

pub fn data(&self) -> &TensorData

Accessor to the underlying TensorData.

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

where T: TryInto<TensorData>,

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>> ) -> Tensor

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.

impl Tensor

pub fn from_image( image: impl Into<DynamicImage> ) -> Result<Tensor, TensorImageLoadError>

Construct a tensor from something that can be turned into a image::DynamicImage.

Requires the image feature.

pub fn from_dynamic_image( image: DynamicImage ) -> Result<Tensor, TensorImageLoadError>

Construct a tensor from image::DynamicImage.

Requires the image feature.

Methods from Deref<Target = TensorData>

pub fn shape(&self) -> &[TensorDimension]

The shape of the tensor, including optional dimension names.

pub fn shape_short(&self) -> &[TensorDimension]

Returns the shape of the tensor with all leading & trailing dimensions of size 1 ignored.

If all dimension sizes are one, this returns only the first dimension.

pub fn num_dim(&self) -> usize

The number of dimensions of the tensor.

An image tensor will usually have two (height, width) or three (height, width, channels) dimensions.

pub fn is_vector(&self) -> bool

Returns true if either all dimensions have size 1 or only a single dimension has a size larger than 1.

Empty tensors return false.

pub fn get(&self, index: &[u64]) -> Option<TensorElement>

Get the value of the element at the given index.

Return None if out-of-bounds.

pub fn dtype(&self) -> TensorDataType

The datatype of the tensor.

pub fn size_in_bytes(&self) -> usize

The size of the tensor data, in bytes.

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 display_name() -> &'static str

Readable name for displaying in ui.

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>)> ) -> Result<Tensor, DeserializationError>

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 AsRef<TensorData> for Tensor

fn as_ref(&self) -> &TensorData

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<TensorData> for Tensor

fn borrow(&self) -> &TensorData

Immutably borrows from an owned value.

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<(), Error>

Formats the value using the given formatter.

impl Deref for Tensor

type Target = TensorData

The resulting type after dereferencing.

fn deref(&self) -> &TensorData

Dereferences the value.

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 ArrayBase<ViewRepr<&'a f16>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a f16>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a f16>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Tensor> for ArrayBase<ViewRepr<&'a f32>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a f32>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a f32>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Tensor> for ArrayBase<ViewRepr<&'a f64>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a f64>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a f64>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Tensor> for ArrayBase<ViewRepr<&'a i16>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a i16>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a i16>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Tensor> for ArrayBase<ViewRepr<&'a i32>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a i32>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a i32>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Tensor> for ArrayBase<ViewRepr<&'a i64>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a i64>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a i64>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Tensor> for ArrayBase<ViewRepr<&'a i8>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a i8>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a i8>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Tensor> for ArrayBase<ViewRepr<&'a u16>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a u16>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a u16>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Tensor> for ArrayBase<ViewRepr<&'a u32>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a u32>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a u32>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Tensor> for ArrayBase<ViewRepr<&'a u64>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a u64>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a u64>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Tensor> for ArrayBase<ViewRepr<&'a u8>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a Tensor ) -> Result<ArrayBase<ViewRepr<&'a u8>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a u8>, Dim<IxDynImpl>> as TryFrom<&'a Tensor>>::Error>

Performs the conversion.

impl ArchetypeReflectionMarker for Tensor

impl StructuralPartialEq for Tensor