Vectors3D

SUMMARY

A batch of vectors in 3D space.

from telekinesis import datatypes
vectors3d = datatypes.Vectors3D([[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]])

API Reference

Complete API documentation for Vectors3D, including parameters, attributes, and methods.

View Reference →

Parameters

Parameter	Type	Default	Description
data	np.ndarray | list | tuple	Required	Array-like data of shape (N, 3).

Raises

Exception	Condition
TypeError	data can't be converted to a float32 array (e.g. non-numeric elements)
ValueError	data's rank isn't 2, its last axis isn't length 3, or it contains a non-finite value (NaN/Inf)

Attributes

Attribute	Type	Description
shape_spec	ClassVar[tuple[int | None, ...]]	Class-level shape spec, (None, 3) — None means the batch size is variable.
data	np.ndarray	The wrapped batch, shape (N, 3). Reading it returns a copy, so mutating the result doesn't affect the Vectors3D; assigning a new value re-validates it the same way as construction.
shape	tuple[int, ...]	(N, 3).
ndim	int	Always 2.
dtype	np.dtype	Always float32.
size	int	3 * N.

Methods

Method	Type	Description
Vectors3D.coerce(value)	Vectors3D	Converts array-like data of shape (N, 3) into a Vectors3D. Accepts a np.ndarray, list, or tuple. If value is already a Vectors3D, it is returned unchanged.
to_numpy(copy=True)	np.ndarray	Returns the vectors as a plain array. With the default copy=True you get an independent copy; pass copy=False to get a direct reference to the internal array instead, so mutating it also mutates the Vectors3D.
copy()	Vectors3D	Returns a new, independent Vectors3D with the same data.

Operators

Operation	Behavior
v1 == v2	True only if other is exactly a Vectors3D (not a subclass, not another datatype) with element-equal data. False for anything else.
len(v)	Batch size N. 0 for an empty batch (shape (0, 3)) — that's a valid, constructible batch.
np.asarray(v)	Returns a copy of data as an np.ndarray; NumPy functions accept a Vectors3D directly.

Visualization

import rerun as rr

# Your code block
# ....

rr.init("vectors3d_example", spawn=True)
datatypes.visualize(vectors3d, entity_path="/vectors3d", label="Vectors3D")

Example

"""Demonstrates the Telekinesis Vectors3D datatype."""

import time

import numpy as np
import rerun as rr
from loguru import logger

from telekinesis import datatypes

def vectors3d_example():
    """Demonstrate creation, inspection, operations, visualization, and serialization."""

    # ======================= Create ============================================
    vectors = [[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]]
    vectors3d = datatypes.Vectors3D(vectors)
    logger.info(f"Created Vectors3D: {vectors3d}")

    empty_vectors3d = datatypes.Vectors3D(np.empty((0, 3), dtype=np.float32))
    logger.info(f"Created empty Vectors3D batch: {empty_vectors3d}")

    # ======================= Inspect ===========================================
    logger.info(f"data={vectors3d.data}")
    logger.info(f"shape={vectors3d.shape}")
    logger.info(f"ndim={vectors3d.ndim}")
    logger.info(f"dtype={vectors3d.dtype}")
    logger.info(f"size={vectors3d.size}")

    # ======================= Operations =========================================
    vectors3d.data = [[7.0, 8.0, 9.0], [10.0, 11.0, 12.0]]
    logger.info(f"Updated Vectors3D: {vectors3d}")

    vectors3d_copy = vectors3d.copy()
    logger.info(f"Copied Vectors3D: {vectors3d_copy}")

    vectors3d_numpy = vectors3d.to_numpy(copy=True)
    logger.info(f"NumPy Vectors3D:\n{vectors3d_numpy}")

    numpy_array = np.asarray(vectors3d)
    column_sums = np.sum(vectors3d, axis=0)
    logger.info(f"NumPy array:\n{numpy_array}")
    logger.info(f"Column sums: {column_sums}")

    # ======================= Visualize =========================================
    rr.init("vectors3d_example", spawn=True)
    datatypes.visualize(vectors3d, entity_path="/vectors3d", label=["Vector 1", "Vector 2"])

    # ======================= Serialize / Deserialize ===========================
    start = time.perf_counter()
    serialized = datatypes.serialize(vectors3d)
    serialization_ms = (time.perf_counter() - start) * 1000

    start = time.perf_counter()
    deserialized = datatypes.deserialize(serialized)["param_0"]
    deserialization_ms = (time.perf_counter() - start) * 1000

    logger.info(f"Deserialized Vectors3D: {deserialized}")
    logger.info(f"Round-trip successful: {vectors3d == deserialized}")
    logger.info(f"Serialization time: {serialization_ms:.3f} ms")
    logger.info(f"Deserialization time: {deserialization_ms:.3f} ms")


if __name__ == "__main__":
    vectors3d_example()

See also Vector3D for a single 3D vector.