docs/snippets/INDEX.md
This file acts as an index reference for all of our snippets.
Use it to quickly find copy-pastable snippets of code for any Rerun feature you're interested in (APIs, Archetypes, Blueprint, etc).
Table of contents:
| Feature | Example | Description | Python | Rust | C++ |
|---|---|---|---|---|---|
| Query Data Platform | dataframe_operations | Demonstrate common dataframe operations with Rerun Data Platform | 🐍 | ||
| Query Data Platform | dataframe_performance | Sample snippets highlighting common performance-related improvements | 🐍 | ||
| Query Data Platform | dataset_resampling | Sample snippets highlighting common performance-related improvements | 🐍 | ||
| Query Data Platform | lerobot_export | Demonstrate converting Rerun recording to LeRobot dataset | 🐍 | ||
| Query Data Platform | query_images | Query various image representations | 🐍 | ||
| Query Data Platform | query_videos | Query video streams | 🐍 | ||
| Query Data Platform | query_video_keyframes | Query video streams efficiently using keyframe information | 🐍 | ||
| Query Data Platform | sub_dataset | Create a new dataset from a subset of segments of an existing dataset | 🐍 | ||
| Query Data Platform | time_alignment | Efficiently time align multirate columns | 🐍 | ||
| Query Data Platform | view_operations | Leverage filters to more efficiently perform downstream queries | 🐍 | ||
| Setting recording properties | recording_properties | Sets the recording properties | 🐍 | 🦀 | 🌊 |
| Setting recording properties | segment_properties | Query and display the first 10 rows of a recording | 🐍 | ||
| Setting recording properties | layers | 🐍 | |||
| Update rows | arrows3d_row_updates | Update a set of vectors over time | 🐍 | 🦀 | 🌊 |
| Update rows | scalars_row_updates | Update a scalar over time | 🐍 | 🦀 | 🌊 |
| Update rows | points3d_row_updates | Update a point cloud over time | 🐍 | 🦀 | 🌊 |
| Update rows | transform3d_row_updates | Update a transform over time | 🐍 | 🦀 | 🌊 |
| Update columns | scalars_column_updates | Update a scalar over time, in a single operation | 🐍 | 🦀 | 🌊 |
| Update columns | points3d_column_updates | Update a point cloud over time, in a single operation | 🐍 | 🦀 | 🌊 |
| Update columns | transform3d_column_updates | Update a transform over time, in a single operation | 🐍 | 🦀 | 🌊 |
| Update columns | image_column_updates | Update an image over time, in a single operation | 🐍 | 🦀 | 🌊 |
| Micro batching | micro_batching | Shows how to configure micro-batching directly from code | 🐍 | 🦀 | |
| Partial updates | points3d_partial_updates | Update specific properties of a point cloud over time | 🐍 | 🦀 | 🌊 |
| Partial updates | transform3d_partial_updates | Update specific properties of a transform over time | 🐍 | 🦀 | 🌊 |
| Partial updates | mesh3d_partial_updates | Log a simple colored triangle, then update its vertices' positions each frame | 🐍 | 🦀 | 🌊 |
| Send custom data | any_values | Log arbitrary data | 🐍 | 🦀 | 🌊 |
| Send custom data | dynamic_archetype | Log arbitrary archetype data | 🐍 | 🦀 | 🌊 |
| Send custom data | extra_values | Log extra values with a Points2D | 🐍 | 🦀 | 🌊 |
| Send custom data | custom_data | Shows how to implement custom archetypes and components | 🐍 | 🦀 | 🌊 |
| Send columns of custom data | any_values_column_updates | Update custom user-defined values over time, in a single operation | 🐍 | 🦀 | 🌊 |
| Send columns of custom data | any_batch_value_column_updates | Use AnyBatchValue and send_column to send an entire column of custom data to Rerun | 🐍 | 🦀 | 🌊 |
| Query dataframes | dataframe_query_example | Query and display the first 10 rows of a recording | 🐍 | ||
| Query dataframes | dataframe_view_query | Query and display the first 10 rows of a recording in a dataframe view | 🐍 | ||
| Host web viewer and connect it to a gRPC server | serve_web_viewer | Demonstrates how to log data to a gRPC server and connect the web viewer to it | 🐍 | 🦀 | |
| Experimental Viewer client | screenshot | Take screenshots of the viewer or specific views from code | 🐍 | ||
| Experimental Viewer client | send_table | Sets the recording properties | 🐍 | ||
| Convert custom MCAP Protobuf | convert_mcap_protobuf | Convert custom MCAP Protobuf messages to Rerun format | 🐍 |
All snippets, organized by the Archetype(s) they use.
| Archetype | Snippet | Description | Python | Rust | C++ |
|---|---|---|---|---|---|
AnnotationContext | tutorials/annotation_context | 🐍 | 🦀 | 🌊 | |
AnnotationContext | archetypes/annotation_context_segmentation | Log a segmentation image with annotations | 🐍 | 🦀 | 🌊 |
AnnotationContext | archetypes/annotation_context_rects | 🐍 | 🦀 | 🌊 | |
AnnotationContext | archetypes/annotation_context_connections | Log annotation context with connections between keypoints | 🐍 | 🦀 | 🌊 |
AnnotationContext | archetypes/segmentation_image_simple | Create and log a segmentation image | 🐍 | 🦀 | 🌊 |
Arrows2D | archetypes/arrows2d_simple | Log a batch of 2D arrows | 🐍 | 🦀 | 🌊 |
Arrows3D | archetypes/arrows3d_simple | Log a batch of 3D arrows | 🐍 | 🦀 | 🌊 |
Arrows3D | archetypes/arrows3d_row_updates | Update a set of vectors over time | 🐍 | 🦀 | 🌊 |
Arrows3D | archetypes/arrows3d_column_updates | Update a set of vectors over time, in a single operation | 🐍 | 🦀 | 🌊 |
Arrows3D | archetypes/clear_recursive | Log and then clear data recursively | 🐍 | 🦀 | 🌊 |
Arrows3D | archetypes/clear_simple | Log and then clear data | 🐍 | 🦀 | 🌊 |
Arrows3D | archetypes/transform3d_simple | Log different transforms between three arrows | 🐍 | 🦀 | 🌊 |
Arrows3D | archetypes/view_coordinates_simple | Change the view coordinates for the scene | 🐍 | 🦀 | 🌊 |
Asset3D | archetypes/asset3d_simple | Log a simple 3D asset | 🐍 | 🦀 | 🌊 |
AssetVideo | archetypes/video_auto_frames | Log a video asset using automatically determined frame references | 🐍 | 🦀 | 🌊 |
AssetVideo | archetypes/video_manual_frames | Manual use of individual video frame references | 🐍 | 🦀 | 🌊 |
BarChart | views/bar_chart | Use a blueprint to show a bar chart | 🐍 | ||
BarChart | archetypes/bar_chart | Create and log a bar chart | 🐍 | 🦀 | 🌊 |
Boxes2D | archetypes/boxes2d_simple | Log a simple 2D Box | 🐍 | 🦀 | 🌊 |
Boxes2D | archetypes/annotation_context_rects | 🐍 | 🦀 | 🌊 | |
Boxes2D | archetypes/entity_behavior | Configure interactivity & visibility of entities | 🐍 | ||
Boxes2D | concepts/viscomp-base | Base example | 🐍 | ||
Boxes2D | concepts/viscomp-component-default | Add a component default | 🐍 | ||
Boxes2D | concepts/viscomp-component-override | Override a component | 🐍 | ||
Boxes2D | tutorials/data_out | 🐍 | |||
Boxes3D | archetypes/boxes3d_simple | Log a single 3D Box | 🐍 | 🦀 | 🌊 |
Boxes3D | archetypes/boxes3d_batch | Log a batch of oriented bounding boxes | 🐍 | 🦀 | 🌊 |
Boxes3D | archetypes/coordinate_frame_builtin_frames | Demonstrates using explicit CoordinateFrame with implicit transform frames only | 🐍 | 🦀 | 🌊 |
Boxes3D | archetypes/instance_poses3d_combined | Log a simple 3D box with a regular & instance pose transform | 🐍 | 🦀 | 🌊 |
Boxes3D | archetypes/mesh3d_instancing | Log a simple 3D mesh with several instance pose transforms which instantiate the mesh several times and will not affect its children (known as mesh instancing) | 🐍 | 🦀 | 🌊 |
Boxes3D | archetypes/pinhole_projections | Demonstrates pinhole camera projections with Rerun blueprints | 🐍 | ||
Boxes3D | archetypes/transform3d_column_updates | Update a transform over time, in a single operation | 🐍 | 🦀 | 🌊 |
Boxes3D | archetypes/transform3d_partial_updates | Update specific properties of a transform over time | 🐍 | 🦀 | 🌊 |
Boxes3D | archetypes/transform3d_row_updates | Update a transform over time | 🐍 | 🦀 | 🌊 |
Boxes3D | howto/serve_web_viewer | Demonstrates how to log data to a gRPC server and connect the web viewer to it | 🐍 | 🦀 | |
Boxes3D | views/spatial3d | Use a blueprint to customize a Spatial3DView | 🐍 | ||
Capsules3D | archetypes/capsules3d_batch | Log a batch of capsules | 🐍 | 🦀 | 🌊 |
Clear | archetypes/clear_simple | Log and then clear data | 🐍 | 🦀 | 🌊 |
Clear | archetypes/clear_recursive | Log and then clear data recursively | 🐍 | 🦀 | 🌊 |
Clear | archetypes/transform3d_partial_updates | Update specific properties of a transform over time | 🐍 | 🦀 | 🌊 |
CoordinateFrame | archetypes/coordinate_frame_builtin_frames | Demonstrates using explicit CoordinateFrame with implicit transform frames only | 🐍 | 🦀 | 🌊 |
CoordinateFrame | archetypes/transform3d_hierarchy_frames | Logs a transform hierarchy using named transform frame relationships | 🐍 | 🦀 | 🌊 |
CoordinateFrame | concepts/transform3d_hierarchy_named_frames | Logs a simple transform hierarchy with named frames | 🐍 | 🦀 | 🌊 |
CoordinateFrame | howto/convert_mcap_protobuf | Convert custom MCAP Protobuf messages to Rerun format | 🐍 | ||
CoordinateFrame | howto/convert_mcap_protobuf_send_column | Convert custom MCAP Protobuf messages to Rerun format using send_columns | 🐍 | ||
Cylinders3D | archetypes/cylinders3d_batch | Log a batch of cylinders | 🐍 | 🦀 | 🌊 |
DepthImage | archetypes/depth_image_simple | Create and log a depth image | 🐍 | 🦀 | 🌊 |
DepthImage | archetypes/depth_image_3d | Create and log a depth image and pinhole camera | 🐍 | 🦀 | 🌊 |
Ellipsoids3D | archetypes/ellipsoids3d_simple | Log random points and the corresponding covariance ellipsoid | 🐍 | 🦀 | 🌊 |
Ellipsoids3D | archetypes/ellipsoids3d_batch | Log a batch of ellipsoids | 🐍 | 🦀 | 🌊 |
Ellipsoids3D | archetypes/transform3d_hierarchy | Logs a transform hierarchy | 🐍 | 🦀 | 🌊 |
Ellipsoids3D | archetypes/transform3d_hierarchy_frames | Logs a transform hierarchy using named transform frame relationships | 🐍 | 🦀 | 🌊 |
Ellipsoids3D | concepts/transform3d_hierarchy_named_frames | Logs a simple transform hierarchy with named frames | 🐍 | 🦀 | 🌊 |
Ellipsoids3D | concepts/transform3d_hierarchy_simple | Logs a simple transform hierarchy | 🐍 | 🦀 | 🌊 |
EncodedDepthImage | archetypes/encoded_depth_image | Log an encoded depth image stored as a 16-bit PNG or RVL file | 🐍 | 🦀 | 🌊 |
EncodedImage | archetypes/encoded_image | Create and log an image | 🐍 | 🦀 | 🌊 |
EncodedImage | archetypes/image_advanced | Log an image | 🐍 | ||
GeoLineStrings | archetypes/geo_line_strings_simple | Log a simple geospatial line string | 🐍 | 🦀 | 🌊 |
GeoPoints | archetypes/geo_points_simple | Log some very simple geospatial point | 🐍 | 🦀 | 🌊 |
GeoPoints | concepts/query-and-transform/segment_properties | Query and display the first 10 rows of a recording | 🐍 | ||
GeoPoints | views/map | Use a blueprint to customize a map view | 🐍 | ||
GraphEdges | archetypes/graph_directed | Log a simple directed graph | 🐍 | 🦀 | 🌊 |
GraphEdges | archetypes/graph_undirected | Log a simple undirected graph | 🐍 | 🦀 | 🌊 |
GraphNodes | archetypes/graph_directed | Log a simple directed graph | 🐍 | 🦀 | 🌊 |
GraphNodes | archetypes/graph_undirected | Log a simple undirected graph | 🐍 | 🦀 | 🌊 |
GraphNodes | views/graph | Use a blueprint to customize a graph view | 🐍 | ||
Image | archetypes/image_simple | Create and log an image | 🐍 | 🦀 | 🌊 |
Image | archetypes/image_row_updates | Update an image over time | 🐍 | 🦀 | 🌊 |
Image | archetypes/image_formats | Create and log an image with various formats | 🐍 | 🦀 | 🌊 |
Image | archetypes/image_advanced | Log an image | 🐍 | ||
Image | archetypes/pinhole_projections | Demonstrates pinhole camera projections with Rerun blueprints | 🐍 | ||
Image | archetypes/pinhole_simple | Log a pinhole and a random image | 🐍 | 🦀 | 🌊 |
Image | archetypes/text_document | Log a TextDocument | 🐍 | 🦀 | 🌊 |
Image | howto/query_images | Query various image representations | 🐍 | ||
Image | views/text_document | Use a blueprint to show a text document | 🐍 | ||
InstancePoses3D | archetypes/instance_poses3d_combined | Log a simple 3D box with a regular & instance pose transform | 🐍 | 🦀 | 🌊 |
InstancePoses3D | archetypes/mesh3d_instancing | Log a simple 3D mesh with several instance pose transforms which instantiate the mesh several times and will not affect its children (known as mesh instancing) | 🐍 | 🦀 | 🌊 |
LineStrips2D | archetypes/line_strips2d_ui_radius | Log lines with ui points & scene unit radii | 🐍 | 🦀 | 🌊 |
LineStrips2D | archetypes/line_strips2d_simple | Log a simple line strip | 🐍 | 🦀 | 🌊 |
LineStrips2D | archetypes/line_strips2d_segments_simple | Log a couple 2D line segments using 2D line strips | 🐍 | 🦀 | 🌊 |
LineStrips2D | archetypes/line_strips2d_batch | Log a batch of 2D line strips | 🐍 | 🦀 | 🌊 |
LineStrips2D | archetypes/entity_behavior | Configure interactivity & visibility of entities | 🐍 | ||
LineStrips3D | archetypes/line_strips3d_ui_radius | Log lines with ui points & scene unit radii | 🐍 | 🦀 | 🌊 |
LineStrips3D | archetypes/line_strips3d_simple | Log a simple line strip | 🐍 | 🦀 | 🌊 |
LineStrips3D | archetypes/line_strips3d_segments_simple | 🐍 | 🦀 | 🌊 | |
LineStrips3D | archetypes/line_strips3d_batch | Log a batch of 3D line strips | 🐍 | 🦀 | 🌊 |
LineStrips3D | archetypes/transform3d_hierarchy | Logs a transform hierarchy | 🐍 | 🦀 | 🌊 |
LineStrips3D | archetypes/transform3d_hierarchy_frames | Logs a transform hierarchy using named transform frame relationships | 🐍 | 🦀 | 🌊 |
McapChannel | archetypes/mcap_channel_simple | Log a simple MCAP channel definition | 🐍 | 🦀 | 🌊 |
McapMessage | archetypes/mcap_message_simple | Log a simple MCAP message with binary data | 🐍 | 🦀 | 🌊 |
McapMessage | howto/convert_mcap_protobuf | Convert custom MCAP Protobuf messages to Rerun format | 🐍 | ||
McapMessage | howto/convert_mcap_protobuf_send_column | Convert custom MCAP Protobuf messages to Rerun format using send_columns | 🐍 | ||
McapSchema | archetypes/mcap_schema_simple | Log a simple MCAP schema definition | 🐍 | 🦀 | 🌊 |
McapStatistics | archetypes/mcap_statistics_simple | Log simple MCAP recording statistics | 🐍 | 🦀 | 🌊 |
Mesh3D | archetypes/mesh3d_simple | Log a simple colored triangle | 🐍 | 🦀 | 🌊 |
Mesh3D | archetypes/mesh3d_partial_updates | Log a simple colored triangle, then update its vertices' positions each frame | 🐍 | 🦀 | 🌊 |
Mesh3D | archetypes/mesh3d_instancing | Log a simple 3D mesh with several instance pose transforms which instantiate the mesh several times and will not affect its children (known as mesh instancing) | 🐍 | 🦀 | 🌊 |
Mesh3D | archetypes/mesh3d_indexed | Log a simple colored triangle | 🐍 | 🦀 | 🌊 |
Pinhole | archetypes/pinhole_simple | Log a pinhole and a random image | 🐍 | 🦀 | 🌊 |
Pinhole | archetypes/pinhole_projections | Demonstrates pinhole camera projections with Rerun blueprints | 🐍 | ||
Pinhole | archetypes/pinhole_perspective | Logs a point cloud and a perspective camera looking at it | 🐍 | 🦀 | 🌊 |
Pinhole | archetypes/depth_image_3d | Create and log a depth image and pinhole camera | 🐍 | 🦀 | 🌊 |
Pinhole | howto/convert_mcap_protobuf | Convert custom MCAP Protobuf messages to Rerun format | 🐍 | ||
Pinhole | howto/convert_mcap_protobuf_send_column | Convert custom MCAP Protobuf messages to Rerun format using send_columns | 🐍 | ||
Points2D | archetypes/points2d_ui_radius | Log some points with ui points & scene unit radii | 🐍 | 🦀 | 🌊 |
Points2D | archetypes/points2d_simple | Log some very simple points | 🐍 | 🦀 | 🌊 |
Points2D | archetypes/points2d_random | Log some random points with color and radii | 🐍 | 🦀 | 🌊 |
Points2D | archetypes/entity_behavior | Configure interactivity & visibility of entities | 🐍 | ||
Points2D | concepts/different_data_per_timeline | Log different data on different timelines | 🐍 | 🦀 | 🌊 |
Points2D | concepts/indices | Set different types of indices | 🐍 | 🦀 | 🌊 |
Points2D | concepts/query-and-transform/segment_properties | Query and display the first 10 rows of a recording | 🐍 | ||
Points2D | tutorials/extra_values | Log extra values with a Points2D | 🐍 | 🦀 | 🌊 |
Points2D | views/spatial2d | Use a blueprint to customize a Spatial2DView | 🐍 | ||
Points3D | archetypes/points3d_ui_radius | Log some points with ui points & scene unit radii | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/points3d_simple | Log some very simple points | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/points3d_row_updates | Update a point cloud over time | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/points3d_random | Log some random points with color and radii | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/points3d_partial_updates | Update specific properties of a point cloud over time | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/points3d_column_updates | Update a point cloud over time, in a single operation | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/annotation_context_connections | Log annotation context with connections between keypoints | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/coordinate_frame_builtin_frames | Demonstrates using explicit CoordinateFrame with implicit transform frames only | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/ellipsoids3d_simple | Log random points and the corresponding covariance ellipsoid | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/instance_poses3d_combined | Log a simple 3D box with a regular & instance pose transform | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/pinhole_perspective | Logs a point cloud and a perspective camera looking at it | 🐍 | 🦀 | 🌊 |
Points3D | archetypes/pinhole_projections | Demonstrates pinhole camera projections with Rerun blueprints | 🐍 | ||
Points3D | concepts/explicit_recording | Just makes sure that explicit recordings actually work | 🐍 | ||
Points3D | concepts/how_helix_was_logged | 🐍 | |||
Points3D | concepts/recording_properties | Sets the recording properties | 🐍 | 🦀 | 🌊 |
Points3D | descriptors/descr_builtin_archetype | 🐍 | 🦀 | 🌊 | |
Points3D | howto/dual_color_point_cloud | Demonstrates how to visualize the same point cloud with two different color schemes | 🐍 | 🦀 | |
Points3D | howto/set_sinks | Log some data to a file and a Viewer at the same time | 🐍 | 🦀 | 🌊 |
Points3D | quick_start/quick_start_connect | Connect to the viewer and log some data | 🐍 | 🦀 | 🌊 |
Points3D | quick_start/quick_start_spawn | Spawn a viewer and log some data | 🐍 | 🦀 | 🌊 |
Points3D | tutorials/timelines_example | 🐍 | 🦀 | 🌊 | |
Points3D | views/spatial3d | Use a blueprint to customize a Spatial3DView | 🐍 | ||
Scalars | archetypes/scalars_simple | Log a scalar over time | 🐍 | 🦀 | 🌊 |
Scalars | archetypes/scalars_row_updates | Update a scalar over time | 🐍 | 🦀 | 🌊 |
Scalars | archetypes/scalars_multiple_plots | Log a scalar over time | 🐍 | 🦀 | 🌊 |
Scalars | archetypes/scalars_column_updates | Update a scalar over time, in a single operation | 🐍 | 🦀 | 🌊 |
Scalars | archetypes/series_lines_style | Log a scalar over time | 🐍 | 🦀 | 🌊 |
Scalars | archetypes/series_points_style | Log a scalar over time | 🐍 | 🦀 | 🌊 |
Scalars | concepts/query-and-transform/dataframe_query_example | Query and display the first 10 rows of a recording | 🐍 | ||
Scalars | howto/component_mapping | Demonstrates how to configure visualizer component mappings from blueprint | 🐍 | 🦀 | |
Scalars | tutorials/fixed_window_plot | 🐍 | |||
Scalars | tutorials/visualizer-overrides | Log a scalar over time and override the visualizer | 🐍 | ||
Scalars | views/dataframe | Use a blueprint to customize a DataframeView | 🐍 | ||
Scalars | views/timeseries | Use a blueprint to customize a TimeSeriesView | 🐍 | ||
SegmentationImage | archetypes/segmentation_image_simple | Create and log a segmentation image | 🐍 | 🦀 | 🌊 |
SegmentationImage | archetypes/annotation_context_segmentation | Log a segmentation image with annotations | 🐍 | 🦀 | 🌊 |
SeriesLines | archetypes/series_lines_style | Log a scalar over time | 🐍 | 🦀 | 🌊 |
SeriesLines | archetypes/scalars_multiple_plots | Log a scalar over time | 🐍 | 🦀 | 🌊 |
SeriesLines | howto/component_mapping | Demonstrates how to configure visualizer component mappings from blueprint | 🐍 | 🦀 | |
SeriesLines | tutorials/visualizer-overrides | Log a scalar over time and override the visualizer | 🐍 | ||
SeriesLines | views/timeseries | Use a blueprint to customize a TimeSeriesView | 🐍 | ||
SeriesPoints | archetypes/series_points_style | Log a scalar over time | 🐍 | 🦀 | 🌊 |
SeriesPoints | archetypes/scalars_multiple_plots | Log a scalar over time | 🐍 | 🦀 | 🌊 |
SeriesPoints | tutorials/visualizer-overrides | Log a scalar over time and override the visualizer | 🐍 | ||
Tensor | views/tensor | Use a blueprint to show a tensor view | 🐍 | ||
Tensor | archetypes/tensor_simple | Create and log a tensor | 🐍 | 🦀 | 🌊 |
TextDocument | views/text_document | Use a blueprint to show a text document | 🐍 | ||
TextDocument | archetypes/text_document | Log a TextDocument | 🐍 | 🦀 | 🌊 |
TextDocument | archetypes/entity_path | 🐍 | 🦀 | 🌊 | |
TextDocument | howto/lerobot_export | Demonstrate converting Rerun recording to LeRobot dataset | 🐍 | ||
TextLog | views/text_log | Use a blueprint to show a text log | 🐍 | ||
TextLog | archetypes/text_log_integration | Shows integration of Rerun's TextLog with the native logging interface | 🐍 | 🦀 | 🌊 |
TextLog | archetypes/text_log | 🐍 | 🦀 | 🌊 | |
TextLog | concepts/how-does-rerun-work/log-to-grpc | 🐍 | 🦀 | 🌊 | |
TextLog | concepts/how-does-rerun-work/log-to-rrd | 🐍 | 🦀 | 🌊 | |
TextLog | howto/micro_batching | Shows how to configure micro-batching directly from code | 🐍 | 🦀 | |
Transform3D | concepts/transform3d_hierarchy_simple | Logs a simple transform hierarchy | 🐍 | 🦀 | 🌊 |
Transform3D | concepts/transform3d_hierarchy_named_frames | Logs a simple transform hierarchy with named frames | 🐍 | 🦀 | 🌊 |
Transform3D | archetypes/transform3d_simple | Log different transforms between three arrows | 🐍 | 🦀 | 🌊 |
Transform3D | archetypes/transform3d_row_updates | Update a transform over time | 🐍 | 🦀 | 🌊 |
Transform3D | archetypes/transform3d_partial_updates | Update specific properties of a transform over time | 🐍 | 🦀 | 🌊 |
Transform3D | archetypes/transform3d_hierarchy_frames | Logs a transform hierarchy using named transform frame relationships | 🐍 | 🦀 | 🌊 |
Transform3D | archetypes/transform3d_hierarchy | Logs a transform hierarchy | 🐍 | 🦀 | 🌊 |
Transform3D | archetypes/transform3d_column_updates | Update a transform over time, in a single operation | 🐍 | 🦀 | 🌊 |
Transform3D | archetypes/transform3d_axes | Log different transforms with visualized coordinates axes | 🐍 | 🦀 | 🌊 |
Transform3D | archetypes/coordinate_frame_builtin_frames | Demonstrates using explicit CoordinateFrame with implicit transform frames only | 🐍 | 🦀 | 🌊 |
Transform3D | archetypes/instance_poses3d_combined | Log a simple 3D box with a regular & instance pose transform | 🐍 | 🦀 | 🌊 |
Transform3D | archetypes/pinhole_projections | Demonstrates pinhole camera projections with Rerun blueprints | 🐍 | ||
Transform3D | howto/convert_mcap_protobuf | Convert custom MCAP Protobuf messages to Rerun format | 🐍 | ||
Transform3D | howto/convert_mcap_protobuf_send_column | Convert custom MCAP Protobuf messages to Rerun format using send_columns | 🐍 | ||
Transform3D | howto/load_urdf | 🐍 | |||
TransformAxes3D | archetypes/transform3d_axes | Log different transforms with visualized coordinates axes | 🐍 | 🦀 | 🌊 |
TransformAxes3D | archetypes/transform3d_column_updates | Update a transform over time, in a single operation | 🐍 | 🦀 | 🌊 |
TransformAxes3D | archetypes/transform3d_row_updates | Update a transform over time | 🐍 | 🦀 | 🌊 |
VideoFrameReference | archetypes/video_auto_frames | Log a video asset using automatically determined frame references | 🐍 | 🦀 | 🌊 |
VideoFrameReference | archetypes/video_manual_frames | Manual use of individual video frame references | 🐍 | 🦀 | 🌊 |
VideoStream | archetypes/video_stream_synthetic | Video encode images using av and stream them to Rerun | 🐍 | ||
VideoStream | howto/convert_mcap_protobuf | Convert custom MCAP Protobuf messages to Rerun format | 🐍 | ||
VideoStream | howto/convert_mcap_protobuf_send_column | Convert custom MCAP Protobuf messages to Rerun format using send_columns | 🐍 | ||
VideoStream | howto/lerobot_export | Demonstrate converting Rerun recording to LeRobot dataset | 🐍 | ||
ViewCoordinates | archetypes/view_coordinates_simple | Change the view coordinates for the scene | 🐍 | 🦀 | 🌊 |
ViewCoordinates | archetypes/asset3d_simple | Log a simple 3D asset | 🐍 | 🦀 | 🌊 |
ViewCoordinates | archetypes/pinhole_perspective | Logs a point cloud and a perspective camera looking at it | 🐍 | 🦀 | 🌊 |
ViewCoordinates | archetypes/pinhole_projections | Demonstrates pinhole camera projections with Rerun blueprints | 🐍 | ||
ViewCoordinates | archetypes/transform3d_hierarchy | Logs a transform hierarchy | 🐍 | 🦀 | 🌊 |
ViewCoordinates | archetypes/transform3d_hierarchy_frames | Logs a transform hierarchy using named transform frame relationships | 🐍 | 🦀 | 🌊 |
All snippets, organized by the View(s) they use.
| Component | Snippet | Description | Python | Rust | C++ |
|---|---|---|---|---|---|
BarChartView | tutorials/visualization/save_blueprint | Craft an example blueprint with the python API and save it to a file for future use | 🐍 | ||
BarChartView | views/bar_chart | Use a blueprint to show a bar chart | 🐍 | ||
DataframeView | reference/dataframe_view_query | Query and display the first 10 rows of a recording in a dataframe view | 🐍 | ||
DataframeView | views/dataframe | Use a blueprint to customize a DataframeView | 🐍 | ||
GraphView | views/graph | Use a blueprint to customize a graph view | 🐍 | ||
MapView | views/map | Use a blueprint to customize a map view | 🐍 | ||
Spatial2DView | archetypes/entity_behavior | Configure interactivity & visibility of entities | 🐍 | ||
Spatial2DView | archetypes/line_strips2d_batch | Log a batch of 2D line strips | 🐍 | 🦀 | 🌊 |
Spatial2DView | archetypes/line_strips2d_segments_simple | Log a couple 2D line segments using 2D line strips | 🐍 | 🦀 | 🌊 |
Spatial2DView | archetypes/line_strips2d_simple | Log a simple line strip | 🐍 | 🦀 | 🌊 |
Spatial2DView | archetypes/line_strips2d_ui_radius | Log lines with ui points & scene unit radii | 🐍 | 🦀 | 🌊 |
Spatial2DView | archetypes/pinhole_projections | Demonstrates pinhole camera projections with Rerun blueprints | 🐍 | ||
Spatial2DView | archetypes/points2d_random | Log some random points with color and radii | 🐍 | 🦀 | 🌊 |
Spatial2DView | archetypes/points2d_simple | Log some very simple points | 🐍 | 🦀 | 🌊 |
Spatial2DView | archetypes/points2d_ui_radius | Log some points with ui points & scene unit radii | 🐍 | 🦀 | 🌊 |
Spatial2DView | archetypes/video_manual_frames | Manual use of individual video frame references | 🐍 | 🦀 | 🌊 |
Spatial2DView | concepts/different_data_per_timeline | Log different data on different timelines | 🐍 | 🦀 | 🌊 |
Spatial2DView | concepts/viscomp-base | Base example | 🐍 | ||
Spatial2DView | concepts/viscomp-component-default | Add a component default | 🐍 | ||
Spatial2DView | concepts/viscomp-component-override | Override a component | 🐍 | ||
Spatial2DView | tutorials/extra_values | Log extra values with a Points2D | 🐍 | 🦀 | 🌊 |
Spatial2DView | views/spatial2d | Use a blueprint to customize a Spatial2DView | 🐍 | ||
Spatial3DView | archetypes/pinhole_projections | Demonstrates pinhole camera projections with Rerun blueprints | 🐍 | ||
Spatial3DView | archetypes/transform3d_hierarchy | Logs a transform hierarchy | 🐍 | 🦀 | 🌊 |
Spatial3DView | howto/dual_color_point_cloud | Demonstrates how to visualize the same point cloud with two different color schemes | 🐍 | 🦀 | |
Spatial3DView | howto/screenshot | Take screenshots of the viewer or specific views from code | 🐍 | ||
Spatial3DView | views/spatial3d | Use a blueprint to customize a Spatial3DView | 🐍 | ||
TensorView | views/tensor | Use a blueprint to show a tensor view | 🐍 | ||
TextDocumentView | tutorials/visualization/save_blueprint | Craft an example blueprint with the python API and save it to a file for future use | 🐍 | ||
TextDocumentView | views/text_document | Use a blueprint to show a text document | 🐍 | ||
TextLogView | views/text_log | Use a blueprint to show a text log | 🐍 | ||
TimeSeriesView | howto/component_mapping | Demonstrates how to configure visualizer component mappings from blueprint | 🐍 | 🦀 | |
TimeSeriesView | howto/visualization/save_blueprint | Craft a blueprint with the python API and save it to a file for future use | 🐍 | ||
TimeSeriesView | tutorials/fixed_window_plot | 🐍 | |||
TimeSeriesView | tutorials/visualization/save_blueprint | Craft an example blueprint with the python API and save it to a file for future use | 🐍 | ||
TimeSeriesView | tutorials/visualizer-overrides | Log a scalar over time and override the visualizer | 🐍 | ||
TimeSeriesView | views/timeseries | Use a blueprint to customize a TimeSeriesView | 🐍 |
All snippets, organized by the blueprint-related Archetype(s) they use.
| Archetype | Snippet | Description | Python | Rust | C++ |
|---|---|---|---|---|---|
Background | tutorials/annotation_context | 🐍 | 🦀 | 🌊 | |
DataframeQuery | reference/dataframe_view_query | Query and display the first 10 rows of a recording in a dataframe view | 🐍 | ||
DataframeQuery | views/dataframe | Use a blueprint to customize a DataframeView | 🐍 | ||
EntityBehavior | archetypes/entity_behavior | Configure interactivity & visibility of entities | 🐍 | ||
EyeControls3D | views/spatial3d | Use a blueprint to customize a Spatial3DView | 🐍 | ||
GraphBackground | views/graph | Use a blueprint to customize a graph view | 🐍 | ||
LineGrid3D | views/spatial3d | Use a blueprint to customize a Spatial3DView | 🐍 | ||
PlotBackground | views/bar_chart | Use a blueprint to show a bar chart | 🐍 | ||
PlotBackground | views/timeseries | Use a blueprint to customize a TimeSeriesView | 🐍 | ||
PlotLegend | views/timeseries | Use a blueprint to customize a TimeSeriesView | 🐍 | ||
ScalarAxis | views/timeseries | Use a blueprint to customize a TimeSeriesView | 🐍 | ||
SpatialInformation | views/spatial3d | Use a blueprint to customize a Spatial3DView | 🐍 | ||
TensorScalarMapping | views/tensor | Use a blueprint to show a tensor view | 🐍 | ||
TensorSliceSelection | views/tensor | Use a blueprint to show a tensor view | 🐍 | ||
TextLogColumns | views/text_log | Use a blueprint to show a text log | 🐍 | ||
TextLogFormat | views/text_log | Use a blueprint to show a text log | 🐍 | ||
TextLogRows | views/text_log | Use a blueprint to show a text log | 🐍 | ||
TimeAxis | views/timeseries | Use a blueprint to customize a TimeSeriesView | 🐍 | ||
VisualBounds2D | archetypes/line_strips2d_batch | Log a batch of 2D line strips | 🐍 | 🦀 | 🌊 |
VisualBounds2D | archetypes/line_strips2d_segments_simple | Log a couple 2D line segments using 2D line strips | 🐍 | 🦀 | 🌊 |
VisualBounds2D | archetypes/line_strips2d_simple | Log a simple line strip | 🐍 | 🦀 | 🌊 |
VisualBounds2D | archetypes/line_strips2d_ui_radius | Log lines with ui points & scene unit radii | 🐍 | 🦀 | 🌊 |
VisualBounds2D | archetypes/points2d_random | Log some random points with color and radii | 🐍 | 🦀 | 🌊 |
VisualBounds2D | archetypes/points2d_simple | Log some very simple points | 🐍 | 🦀 | 🌊 |
VisualBounds2D | archetypes/points2d_ui_radius | Log some points with ui points & scene unit radii | 🐍 | 🦀 | 🌊 |
VisualBounds2D | concepts/different_data_per_timeline | Log different data on different timelines | 🐍 | 🦀 | 🌊 |
VisualBounds2D | tutorials/extra_values | Log extra values with a Points2D | 🐍 | 🦀 | 🌊 |
VisualBounds2D | views/graph | Use a blueprint to customize a graph view | 🐍 | ||
VisualBounds2D | views/spatial2d | Use a blueprint to customize a Spatial2DView | 🐍 |