Rerun C++ SDK
Loading...
Searching...
No Matches
rerun::datatypes::TensorData Struct Reference

Datatype: A multi-dimensional Tensor of data. More...

#include <rerun/datatypes/tensor_data.hpp>

Public Member Functions

 TensorData (Collection< rerun::datatypes::TensorDimension > shape_, datatypes::TensorBuffer buffer_)
 New tensor data from shape and tensor buffer.
 
template<typename TElement >
 TensorData (Collection< datatypes::TensorDimension > shape_, const TElement *data)
 New tensor data from dimensions and pointer to tensor data.
 

Public Attributes

rerun::Collection< rerun::datatypes::TensorDimensionshape
 The shape of the tensor, including optional names for each dimension.
 
rerun::datatypes::TensorBuffer buffer
 The content/data.
 

Detailed Description

Datatype: A multi-dimensional Tensor of data.

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.

Note that the buffer may be encoded in a compressed format such as jpeg or in a format with downsampled chroma, such as NV12 or YUY2. For file formats, the shape is used as a hint, for chroma downsampled format the shape has to be the shape of the decoded image.

Constructor & Destructor Documentation

◆ TensorData() [1/2]

rerun::datatypes::TensorData::TensorData ( Collection< rerun::datatypes::TensorDimension shape_,
datatypes::TensorBuffer  buffer_ 
)
inline

New tensor data from shape and tensor buffer.

Parameters
shape_Shape of the tensor.
buffer_The tensor buffer containing the tensor's data.

◆ TensorData() [2/2]

template<typename TElement >
rerun::datatypes::TensorData::TensorData ( Collection< datatypes::TensorDimension shape_,
const TElement *  data 
)
inlineexplicit

New tensor data from dimensions and pointer to tensor data.

Type must be one of the types supported by rerun::datatypes::TensorData.

Parameters
shape_Shape of the tensor. Determines the number of elements expected to be in data.
dataTarget of the pointer must outlive the archetype.

The documentation for this struct was generated from the following file: