Struct Tensor

pub struct Tensor {
    pub tensor_id: TensorId,
    pub shape: Vec<TensorDimension>,
    pub data: TensorData,
    pub meaning: TensorDataMeaning,
    pub meter: Option<f32>,
}

A Multi-dimensional Tensor.

All clones are shallow.

The Tensor component is special, as you can only have one instance of it per entity. This is because each element in a tensor is considered to be a separate instance.

Examples

assert_eq!(
    Tensor::data_type(),
    DataType::Struct(vec![
        Field::new("tensor_id", DataType::FixedSizeBinary(16), false),
        Field::new(
            "shape",
            DataType::List(Box::new(Field::new(
                "item",
                TensorDimension::data_type(),
                false
            )),),
            false
        ),
        Field::new("data", TensorData::data_type(), false),
        Field::new(
            "meaning",
            DataType::Union(
                vec![
                    Field::new("Unknown", DataType::Boolean, false),
                    Field::new("ClassId", DataType::Boolean, false),
                    Field::new("Depth", DataType::Boolean, false)
                ],
                None,
                UnionMode::Dense
            ),
            false
        ),
        Field::new("meter", DataType::Float32, true),
    ])
);

Fields

tensor_id: TensorId

Unique identifier for the tensor

shape: Vec<TensorDimension>

Dimensionality and length

data: TensorData

Data payload

meaning: TensorDataMeaning

The per-element data meaning Used to indicated if the data should be interpreted as color, class_id, etc.

meter: Option<f32>

Reciprocal scale of meter unit for depth images

Implementations

impl Tensor

pub fn id(&self) -> TensorId

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

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

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

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

pub fn num_dim(&self) -> usize

pub fn image_height_width_channels(&self) -> Option<[u64; 3]>

If the tensor can be interpreted as an image, return the height, width, and channels/depth of it.

pub fn is_shaped_like_an_image(&self) -> bool

Returns true if the tensor can be interpreted as an image.

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 meaning(&self) -> TensorDataMeaning

pub fn get_with_image_coords( &self, x: u64, y: u64, channel: u64, ) -> Option<TensorElement>

Query with x, y, channel indices.

Allows to query values for any image like tensor even if it has more or less dimensions than 3. (useful for sampling e.g. N x M x C x 1 tensor which is a valid image)

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

pub fn dtype(&self) -> TensorDataType

pub fn size_in_bytes(&self) -> usize

impl Tensor

pub fn new( tensor_id: TensorId, shape: Vec<TensorDimension>, data: TensorData, meaning: TensorDataMeaning, meter: Option<f32>, ) -> Self

impl Tensor

pub fn from_image_file(path: &Path) -> Result<Self, TensorImageLoadError>

Construct a tensor from the contents of an image file on disk.

JPEGs will be kept encoded, left to the viewer to decode on-the-fly. Other images types will be decoded directly.

Requires the image feature.

pub fn from_jpeg_file(path: &Path) -> Result<Self, TensorImageLoadError>

Construct a tensor from the contents of a JPEG file on disk.

Requires the image feature.

pub fn tensor_from_jpeg_file( image_path: impl AsRef<Path>, ) -> Result<Self, TensorImageLoadError>

👎Deprecated: Renamed ‘from_jpeg_file’

pub fn from_image_bytes( bytes: Vec<u8>, format: ImageFormat, ) -> Result<Self, TensorImageLoadError>

Construct a tensor from the contents of an image file.

JPEGs will be kept encoded, left to the viewer to decode on-the-fly. Other images types will be decoded directly.

Requires the image feature.

pub fn from_jpeg_bytes( jpeg_bytes: Vec<u8>, ) -> Result<Self, TensorImageLoadError>

Construct a tensor from the contents of a JPEG file, without decoding it now.

Requires the image feature.

pub fn tensor_from_jpeg_bytes( jpeg_bytes: Vec<u8>, ) -> Result<Self, TensorImageLoadError>

👎Deprecated: Renamed ‘from_jpeg_bytes’

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.

This is a convenience function that calls DecodedTensor::from_image.

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

Construct a tensor from image::DynamicImage.

Requires the image feature.

This is a convenience function that calls DecodedTensor::from_dynamic_image.

pub fn could_be_dynamic_image(&self) -> bool

Predicts if Self::to_dynamic_image is likely to succeed, without doing anything expensive

pub fn to_dynamic_image(&self) -> Result<DynamicImage, TensorImageSaveError>

Try to convert an image-like tensor into an image::DynamicImage.

Trait Implementations

impl ArrowDeserialize for Tensor

type ArrayType = TensorArray

The arrow2::Array type corresponding to this field

fn arrow_deserialize<'a>(v: Option<Self>) -> Option<Self>

Deserialize this field from arrow

impl ArrowField for Tensor

type Type = Tensor

This should be Self except when implementing large offset and fixed placeholder types. For the later, it should refer to the actual type. For example when the placeholder type is LargeString, this should be String.

fn data_type() -> DataType

The DataType

impl ArrowSerialize for Tensor

type MutableArrayType = MutableTensorArray

The arrow2::array::MutableArray that holds this value

fn new_array() -> Self::MutableArrayType

Create a new mutable array

fn arrow_serialize(v: &Self, array: &mut Self::MutableArrayType) -> Result<()>

Serialize this field to arrow

impl AsRef<Tensor> for DecodedTensor

fn as_ref(&self) -> &Tensor

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

impl Borrow<Tensor> for DecodedTensor

fn borrow(&self) -> &Tensor

Immutably borrows from an owned value.

impl Clone for Tensor

fn clone(&self) -> Tensor

Returns a duplicate 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<'a> From<&'a Tensor> for Cow<'a, Tensor>

fn from(value: &'a Tensor) -> Self

Converts to this type from the input type.

impl<'a> From<Tensor> for Cow<'a, Tensor>

fn from(value: Tensor) -> Self

Converts to this type from the input type.

impl LegacyComponent for Tensor

fn legacy_name() -> ComponentName

The name of the component.

fn field() -> Field

Create a Field for this LegacyComponent.

impl Loggable for Tensor

type Name = ComponentName

type Item<'a> = <&'a <Tensor as ArrowDeserialize>::ArrayType as IntoIterator>::Item

type Iter<'a> = <&'a <Tensor as ArrowDeserialize>::ArrayType as IntoIterator>::IntoIter

fn name() -> Self::Name

The fully-qualified name of this loggable, e.g. rerun.datatypes.Vec2D.

fn to_arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType.

fn try_to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, Self>>>>, _extension_wrapper: Option<&str>, ) -> SerializationResult<Box<dyn Array>>

where Self: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::to_arrow_datatype.

fn try_iter_from_arrow( data: &dyn Array, ) -> DeserializationResult<Self::Iter<'_>>

where Self: Sized,

Given an Arrow array, deserializes it into a iterator of Loggable::Items.

fn convert_item_to_self(item: Self::Item<'_>) -> Option<Self>

Convert a Loggable::Item into an optional Loggable

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>>, extension_wrapper: Option<&str>, ) -> Box<dyn Array>

where Self: Clone + 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::to_arrow_datatype.

fn try_to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>>, extension_wrapper: Option<&str>, ) -> Result<Box<dyn Array>, SerializationError>

where Self: Clone + 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::to_arrow_datatype.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, Self>>>>, extension_wrapper: Option<&str>, ) -> Box<dyn Array>

where Self: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::to_arrow_datatype.

fn from_arrow(data: &(dyn Array + 'static)) -> Vec<Self>

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

fn try_from_arrow( data: &(dyn Array + 'static), ) -> Result<Vec<Self>, DeserializationError>

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

fn from_arrow_opt(data: &(dyn Array + 'static)) -> Vec<Option<Self>>

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

fn try_from_arrow_opt( data: &(dyn Array + 'static), ) -> Result<Vec<Option<Self>>, DeserializationError>

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

impl PartialEq for Tensor

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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, 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<D: Dimension> TryFrom<ArrayBase<OwnedRepr<f16>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<f16, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<f16>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<f16, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<f32>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<f32, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<f64>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<f64, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<i16>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<i16, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<i32>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<i32, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<i64>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<i64, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<i8>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<i8, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<u16>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<u16, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<u32>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<u32, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<u64>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<u64, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Dimension> TryFrom<ArrayBase<OwnedRepr<u8>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(value: Array<u8, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a f16>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, f16, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a f16>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, f16, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a f32>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, f32, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a f64>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, f64, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a i16>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, i16, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a i32>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, i32, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a i64>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, i64, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a i8>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, i8, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a u16>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, u16, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a u32>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, u32, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a u64>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, u64, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, D: Dimension> TryFrom<ArrayBase<ViewRepr<&'a u8>, D>> for Tensor

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from(view: ArrayView<'a, u8, D>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Tensor> for DecodedTensor

type Error = Tensor

The type returned in the event of a conversion error.

fn try_from(tensor: Tensor) -> Result<Self, Tensor>

Performs the conversion.

impl Component for Tensor

impl StructuralPartialEq for Tensor