dev
dev
Open navigation
Overview
What is Rerun?
Docs Guide
Getting Started
Install Rerun
Python SDK
C++ SDK
Rust SDK
Viewer
Troubleshooting
Set up a project
Set up a Python project
Set up a C++ project
Set up a Rust project
Log and Ingest
Opening files
Visualize
Navigating the Viewer
Query and Transform
Explore a recording with the dataframe view
Export the dataframe
Analyze the data and send back the results
Concepts
How does Rerun work?
Log and Ingest
Recordings
Entities and Components
The Entity Path Hierarchy
Transforms & Coordinate Frames
Events and Timelines
Static data
Chunks
Importers
Overview
🌊 C++ example
🐍 Python example
🦀 Rust example
Query semantics & partial updates
MCAP files
Supported Message Formats
MCAP Decoders Explained
CLI Reference for MCAP
Component Batches
Sinks
Video
Visualize
Blueprints
Customize views
Annotation Context
Entity Queries
Query and Transform
Catalog object model
Properties and segment tables
Dataframe queries
Lenses
How-to
Log and Ingest
Send entire columns at once
Using layers to append data to segments
Convert existing data to Rerun
Send partial updates over time
Send tables to Rerun
Share recordings across multiple processes
Send user-defined data
Clear out data using tombstones
Working with MCAP
Optimize chunk count
Loading URDF models
Visualize
Limit the viewer's memory usage
Use multiple native viewers
Implement custom visualizations (Rust only)
Visualize fixed-window plots
Component mappings
Visualize geospatial data
React to events in the Viewer
Building blueprints programmatically
Plot any scalar
Visualize state changes
Query and Transform
Overview
Common Dataframe Operations
Query images
Query video streams
View Operations
Generate segment URLs in dataframes
Time-align data
Export recordings to LeRobot datasets
Query data out of Rerun
Dataset Resampling
Query Performance Tuning
Creating sub-datasets
Integrations
Embed Rerun in notebooks
Embed Rerun in Web pages
Train PyTorch models with Rerun
Use Rerun with ROS 2
Integrate Rerun with native loggers
Reference
Types
Archetypes
AnnotationContext
Arrows2D
Arrows3D
Asset3D
AssetVideo
BarChart
Boxes2D
Boxes3D
Capsules3D
Clear
CoordinateFrame
Cylinders3D
DepthImage
Ellipses2D
Ellipsoids3D
EncodedDepthImage
EncodedImage
GeoLineStrings
GeoPoints
GraphEdges
GraphNodes
GridMap
Image
InstancePoses3D
LineStrips2D
LineStrips3D
McapChannel
McapMessage
McapSchema
McapStatistics
Mesh3D
Pinhole
Points2D
Points3D
RecordingInfo
Scalars
SegmentationImage
SeriesLines
SeriesPoints
StateChange
StateConfiguration
Tensor
TextDocument
TextLog
Transform3D
TransformAxes3D
VideoFrameReference
VideoStream
ViewCoordinates
Components
AggregationPolicy
AlbedoFactor
AnnotationContext
AxisLength
Blob
CellSize
ChannelId
ChannelMessageCounts
ClassId
ClearIsRecursive
Color
Colormap
Count
DepthMeter
DrawOrder
EntityPath
FillMode
FillRatio
GammaCorrection
GeoLineString
GraphEdge
GraphNode
GraphType
HalfSize2D
HalfSize3D
ImageBuffer
ImageFormat
ImagePlaneDistance
Interactive
InterpolationMode
IsKeyframe
KeyValuePairs
KeypointId
LatLon
Length
LineStrip2D
LineStrip3D
LinearSpeed
MagnificationFilter
MarkerShape
MarkerSize
MediaType
MeshFaceRendering
Name
Opacity
PinholeProjection
Plane3D
Position2D
Position3D
Radius
Range1D
Resolution
RotationAxisAngle
RotationQuat
Scalar
Scale3D
SchemaId
ShowLabels
StrokeWidth
TensorData
TensorDimensionIndexSelection
TensorHeightDimension
TensorWidthDimension
Texcoord2D
Text
TextLogLevel
Timestamp
TransformFrameId
TransformMat3x3
TransformRelation
Translation3D
TriangleIndices
ValueRange
Vector2D
Vector3D
VideoCodec
VideoSample
VideoTimestamp
ViewCoordinates
Visible
Datatypes
AbsoluteTimeRange
Angle
AnnotationInfo
Blob
Bool
ChannelCountPair
ChannelDatatype
ClassDescription
ClassDescriptionMapElem
ClassId
ColorModel
DVec2D
EntityPath
Float32
Float64
ImageFormat
KeypointId
KeypointPair
Mat3x3
Mat4x4
PixelFormat
Plane3D
Quaternion
Range1D
Range2D
Rgba32
RotationAxisAngle
TensorBuffer
TensorData
TensorDimensionIndexSelection
TensorDimensionSelection
TimeInt
TimeRange
TimeRangeBoundary
UInt16
UInt32
UInt64
Utf8
Utf8Pair
Uuid
UVec2D
UVec3D
UVec4D
Vec2D
Vec3D
Vec4D
VideoTimestamp
ViewCoordinates
VisibleTimeRange
Views
BarChartView
DataframeView
GraphView
MapView
Spatial2DView
Spatial3DView
StateTimelineView
TensorView
TextDocumentView
TextLogView
TimeSeriesView
Datastore compaction
Migration
Migrating from 0.31 to 0.32
Migrating from 0.30 to 0.31
Migrating from 0.29 to 0.30
Migrating from 0.28 to 0.29
Migrating from 0.27 to 0.28
Migrating from 0.26 to 0.27
Migrating from 0.25 to 0.26
Migrating from 0.24 to 0.25
Migrating from 0.23 to 0.24
Migrating from 0.22 to 0.23
Migrating from 0.21 to 0.22
Migrating from 0.20 to 0.21
Migrating from 0.19 to 0.20
Migrating from 0.18 to 0.19
Migrating from 0.17 to 0.18
Migrating from 0.16 to 0.17
Migrating from 0.15 to 0.16
Migrating from 0.14 to 0.15
Migrating from 0.12 to 0.13
Migrating from 0.8 to 0.9
About
⌨️ CLI manual
🌊 C++ APIs
🐍 Python APIs
🦀 Rust APIs
💻 Web Viewer API
📖 Code snippets
Developing Rerun
Roadmap
Architecture
Code of Conduct
Contributing
Importers
Extending Rerun's file loading capabilities with custom importers.