Struct rerun::sdk::components::TensorData

#[repr(transparent)]
pub struct TensorData(pub TensorData);

Component: An N-dimensional array of numbers.

The number of dimensions and their respective lengths is specified by the shape field. The dimensions are ordered from outermost to innermost. For example, in the common case of a 2D RGB Image, the shape would be [height, width, channel].

These dimensions are combined with an index to look up values from the buffer field, which stores a contiguous array of typed values.

Tuple Fields

0: TensorData

Methods from Deref<Target = TensorData>

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

The shape of the tensor.

pub fn dim_name(&self, dim: usize) -> Option<&ArrowString>

Get the name of a specific dimension.

Returns None if the dimension does not have a name.

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

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 Borrow<TensorData> for TensorData

fn borrow(&self) -> &TensorData

Immutably borrows from an owned value.

impl Clone for TensorData

fn clone(&self) -> TensorData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for TensorData

fn descriptor() -> ComponentDescriptor

Returns the complete ComponentDescriptor for this Component.

fn name() -> ComponentName

The fully-qualified name of this component, e.g. rerun.components.Position2D.

impl Debug for TensorData

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

Formats the value using the given formatter.

impl Default for TensorData

fn default() -> TensorData

Returns the “default value” for a type.

impl Deref for TensorData

type Target = TensorData

The resulting type after dereferencing.

fn deref(&self) -> &TensorData

Dereferences the value.

impl DerefMut for TensorData

fn deref_mut(&mut self) -> &mut TensorData

Mutably dereferences the value.

impl EntityDataUi for TensorData

fn entity_data_ui( &self, ctx: &ViewerContext<'_>, ui: &mut Ui, ui_layout: UiLayout, _entity_path: &EntityPath, row_id: Option<RowId>, _query: &LatestAtQuery, _db: &EntityDb, )

If you need to lookup something in the chunk store, use the given query to do so.

impl<T> From<T> for TensorData

where T: Into<TensorData>,

fn from(v: T) -> TensorData

Converts to this type from the input type.

impl Loggable for TensorData

fn arrow_datatype() -> DataType

The underlying arrow::datatypes::DataType, excluding datatype extensions.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, TensorData>>>>, ) -> Result<Arc<dyn Array>, SerializationError>

where TensorData: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow_opt( arrow_data: &dyn Array, ) -> Result<Vec<Option<TensorData>>, DeserializationError>

where TensorData: Sized,

Given an Arrow array, deserializes it into a collection of optional Loggables.

fn arrow_empty() -> Arc<dyn Array>

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>>, ) -> Result<Arc<dyn Array>, SerializationError>

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow(data: &dyn Array) -> Result<Vec<Self>, DeserializationError>

Given an Arrow array, deserializes it into a collection of Loggables.

impl PartialEq for TensorData

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

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

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 StructuralPartialEq for TensorData