__init__.py
rerun._rerun2
class Points2D
Bases: Archetype
A 2D point cloud with positions and optional colors, radii, labels, etc.
Example
import rerun as rr
import rerun.experimental as rr2
rr.init("points", spawn=True)
rr2.log("simple", rr2.Points2D([[0, 0], [1, 1]]))
# Log an extra rect to set the view bounds
rr.log_rect("bounds", [0, 0, 4, 3], rect_format=rr.RectFormat.XCYCWH)
points: components.Point2DArray = field(metadata={'component': 'primary'}, converter=components.Point2DArray.from_similar)
class-attribute
instance-attribute
All the actual 2D points that make up the point cloud.
radii: components.RadiusArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.RadiusArray.from_similar)
class-attribute
instance-attribute
Optional radii for the points, effectively turning them into circles.
colors: components.ColorArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.ColorArray.from_similar)
class-attribute
instance-attribute
Optional colors for the points.
The colors are interpreted as RGB or RGBA in sRGB gamma-space, As either 0-1 floats or 0-255 integers, with separate alpha.
labels: components.LabelArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.LabelArray.from_similar)
class-attribute
instance-attribute
Optional text labels for the points.
draw_order: components.DrawOrderArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.DrawOrderArray.from_similar)
class-attribute
instance-attribute
An optional floating point value that specifies the 2D drawing order. Objects with higher values are drawn on top of those with lower values.
The default for 2D points is 30.0.
class_ids: components.ClassIdArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.ClassIdArray.from_similar)
class-attribute
instance-attribute
Optional class Ids for the points.
The class ID provides colors and labels if not specified explicitly.
keypoint_ids: components.KeypointIdArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.KeypointIdArray.from_similar)
class-attribute
instance-attribute
Optional keypoint IDs for the points, identifying them within a class.
If keypoint IDs are passed in but no class IDs were specified, the class ID will
default to 0.
This is useful to identify points within a single classification (which is identified
with class_id).
E.g. the classification might be 'Person' and the keypoints refer to joints on a
detected skeleton.
instance_keys: components.InstanceKeyArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.InstanceKeyArray.from_similar)
class-attribute
instance-attribute
Unique identifiers for each individual point in the batch.
class Points3D
Bases: Archetype
A 3D point cloud with positions and optional colors, radii, labels, etc.
Example
import rerun as rr
import rerun.experimental as rr2
rr.init("points", spawn=True)
rr2.log("simple", rr2.Points3D([[0, 0, 0], [1, 1, 1]]))
points: components.Point3DArray = field(metadata={'component': 'primary'}, converter=components.Point3DArray.from_similar)
class-attribute
instance-attribute
All the actual 3D points that make up the point cloud.
radii: components.RadiusArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.RadiusArray.from_similar)
class-attribute
instance-attribute
Optional radii for the points, effectively turning them into circles.
colors: components.ColorArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.ColorArray.from_similar)
class-attribute
instance-attribute
Optional colors for the points.
The colors are interpreted as RGB or RGBA in sRGB gamma-space, As either 0-1 floats or 0-255 integers, with separate alpha.
labels: components.LabelArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.LabelArray.from_similar)
class-attribute
instance-attribute
Optional text labels for the points.
draw_order: components.DrawOrderArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.DrawOrderArray.from_similar)
class-attribute
instance-attribute
An optional floating point value that specifies the 3D drawing order. Objects with higher values are drawn on top of those with lower values.
The default for 3D points is 30.0.
class_ids: components.ClassIdArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.ClassIdArray.from_similar)
class-attribute
instance-attribute
Optional class Ids for the points.
The class ID provides colors and labels if not specified explicitly.
keypoint_ids: components.KeypointIdArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.KeypointIdArray.from_similar)
class-attribute
instance-attribute
Optional keypoint IDs for the points, identifying them within a class.
If keypoint IDs are passed in but no class IDs were specified, the class ID will
default to 0.
This is useful to identify points within a single classification (which is identified
with class_id).
E.g. the classification might be 'Person' and the keypoints refer to joints on a
detected skeleton.
instance_keys: components.InstanceKeyArray | None = field(metadata={'component': 'secondary'}, default=None, converter=components.InstanceKeyArray.from_similar)
class-attribute
instance-attribute
Unique identifiers for each individual point in the batch.
class Transform3D
Bases: Archetype
A 3D transform.
Example
import rerun as rr
import rerun.experimental as rr2
from rerun.experimental import dt as rrd
rr.init("transform", spawn=True)
origin = [0, 0, 0]
base_vector = [0, 1, 0]
rr.log_arrow("base", origin=origin, vector=base_vector)
rr2.log("base/translated", rr2.Transform3D(rrd.TranslationRotationScale3D(translation=[1, 0, 0])))
rr.log_arrow("base/translated", origin=origin, vector=base_vector)
rr2.log(
"base/rotated_scaled",
rrd.TranslationRotationScale3D(
rotation=rrd.RotationAxisAngle(axis=[0, 0, 1], radians=3.14 / 4), scale=rrd.Scale3D(2)
),
)
rr.log_arrow("base/rotated_scaled", origin=origin, vector=base_vector)
transform: components.Transform3DArray = field(metadata={'component': 'primary'}, converter=components.Transform3DArray.from_similar)
class-attribute
instance-attribute
The transform