Skip to content

__init__.py

rerun._rerun2.datatypes

class Angle(*args, **kwargs)

Angle in either radians or degrees.

inner: float = field(converter=float) class-attribute instance-attribute

Radians (float): 3D rotation angle in radians. Only one of degrees or radians should be set.

Degrees (float): 3D rotation angle in degrees. Only one of degrees or radians should be set.

class Point2D

A point in 2D space.

class Point3D

A point in 3D space.

class Rotation3D

A 3D rotation.

inner: datatypes.Quaternion | datatypes.RotationAxisAngle = field(converter=rotation3d_inner_converter) class-attribute instance-attribute

Quaternion (datatypes.Quaternion): Rotation defined by a quaternion.

AxisAngle (datatypes.RotationAxisAngle): Rotation defined with an axis and an angle.

class Scale3D

3D scaling factor, part of a transform representation.

Example
# uniform scaling
scale = rr.dt.Scale3D(3.)

# non-uniform scaling
scale = rr.dt.Scale3D([1, 1, -1])
scale = rr.dt.Scale3D(rr.dt.Vec3D([1, 1, -1]))
inner: datatypes.Vec3D | float = field(converter=scale3d_inner_converter) class-attribute instance-attribute

ThreeD (datatypes.Vec3D): Individual scaling factors for each axis, distorting the original object.

Uniform (float): Uniform scaling factor along all axis.

class Transform3D

Representation of a 3D affine transform.

inner: datatypes.TranslationAndMat3x3 | datatypes.TranslationRotationScale3D = field() class-attribute instance-attribute

TranslationAndMat3x3 (datatypes.TranslationAndMat3x3):

TranslationRotationScale (datatypes.TranslationRotationScale3D):

class Mat3x3

A 3x3 column-major Matrix.

class Mat4x4

A 4x4 column-major Matrix.

class Quaternion(*args, **kwargs)

A Quaternion represented by 4 real numbers.

Note: although the x,y,z,w components of the quaternion will be passed through to the datastore as provided, when used in the viewer Quaternions will always be normalized.

class Vec2D

A vector in 2D space.

class Vec3D

A vector in 3D space.

class Vec4D

A vector in 4D space.

class RotationAxisAngle

3D rotation represented by a rotation around a given axis.

axis: datatypes.Vec3D = field(converter=_rotationaxisangle_axis_converter) class-attribute instance-attribute

Axis to rotate around.

This is not required to be normalized. If normalization fails (typically because the vector is length zero), the rotation is silently ignored.

angle: datatypes.Angle = field(converter=rotationaxisangle_angle_converter) class-attribute instance-attribute

How much to rotate around the axis.

class TranslationAndMat3x3(*args, **kwargs)

Representation of an affine transform via a 3x3 affine matrix paired with a translation.

First applies the matrix, then the translation.

from_parent: bool = field(converter=bool) class-attribute instance-attribute

If true, the transform maps from the parent space to the space where the transform was logged. Otherwise, the transform maps from the space to its parent.

translation: datatypes.Vec3D | None = field(default=None, converter=_translationandmat3x3_translation_converter) class-attribute instance-attribute

3D translation, applied after the matrix.

matrix: datatypes.Mat3x3 | None = field(default=None, converter=_translationandmat3x3_matrix_converter) class-attribute instance-attribute

3x3 matrix for scale, rotation & shear.

class TranslationRotationScale3D(*args, **kwargs)

Representation of an affine transform via separate translation, rotation & scale.

from_parent: bool = field(converter=bool) class-attribute instance-attribute

If true, the transform maps from the parent space to the space where the transform was logged. Otherwise, the transform maps from the space to its parent.

translation: datatypes.Vec3D | None = field(default=None, converter=_translationrotationscale3d_translation_converter) class-attribute instance-attribute

3D translation vector, applied last.

rotation: datatypes.Rotation3D | None = field(default=None, converter=_translationrotationscale3d_rotation_converter) class-attribute instance-attribute

3D rotation, applied second.

scale: datatypes.Scale3D | None = field(default=None, converter=_translationrotationscale3d_scale_converter) class-attribute instance-attribute

3D scale, applied first.

class AffixFuzzer3

inner: float | list[datatypes.AffixFuzzer1] | npt.NDArray[np.float32] = field() class-attribute instance-attribute

degrees (float):

radians (float):

craziness (list[datatypes.AffixFuzzer1]):

fixed_size_shenanigans (npt.NDArray[np.float32]):

class AffixFuzzer4

inner: datatypes.AffixFuzzer3 | list[datatypes.AffixFuzzer3] = field() class-attribute instance-attribute

single_required (datatypes.AffixFuzzer3):

many_required (list[datatypes.AffixFuzzer3]):

many_optional (list[datatypes.AffixFuzzer3]):