blueprint.py

rerun.log.experimental.blueprint

def new_blueprint(application_id, *, blueprint_id=None, make_default=False, make_thread_default=False, spawn=False, add_to_app_default_blueprint=False, default_enabled=True)

Creates a new blueprint with a user-chosen application id (name) to configure the appearance of Rerun.

If you only need a single global blueprint, rerun.init might be simpler.

Parameters:

Name	Type	Description	Default
application_id	str	Your Rerun recordings will be categorized by this application id, so try to pick a unique one for each application that uses the Rerun SDK. For example, if you have one application doing object detection and another doing camera calibration, you could have rerun.init("object_detector") and rerun.init("calibrator").	required
blueprint_id	Optional[str]	Set the blueprint ID that this process is logging to, as a UUIDv4. The default blueprint_id is based on multiprocessing.current_process().authkey which means that all processes spawned with multiprocessing will have the same default blueprint_id. If you are not using multiprocessing and still want several different Python processes to log to the same Rerun instance (and be part of the same blueprint), you will need to manually assign them all the same blueprint_id. Any random UUIDv4 will work, or copy the blueprint_id for the parent process.	None
make_default	bool	If true (not the default), the newly initialized blueprint will replace the current active one (if any) in the global scope.	False
make_thread_default	bool	If true (not the default), the newly initialized blueprint will replace the current active one (if any) in the thread-local scope.	False
spawn	bool	Spawn a Rerun Viewer and stream logging data to it. Short for calling spawn separately. If you don't call this, log events will be buffered indefinitely until you call either connect, show, or save	False
add_to_app_default_blueprint	bool	Should the blueprint append to the existing app-default blueprint instead instead of creating a new one.	False
default_enabled	bool	Should Rerun logging be on by default? Can overridden with the RERUN env-var, e.g. RERUN=on or RERUN=off.	True

Returns:

Type	Description
RecordingStream	A handle to the rerun.RecordingStream. Use it to log data to Rerun.

def add_space_view(*, origin, name, entity_paths, blueprint=None)

Add a new space view to the blueprint.

Parameters:

Name	Type	Description	Default
origin	str	The EntityPath to use as the origin of this space view. All other entities will be transformed to be displayed relative to this origin.	required
name	Optional[str]	The name of the space view to show in the UI. Will default to the origin if not provided.	required
entity_paths	Optional[List[str]]	The entities to be shown in the space view. If not provided, this will default to [origin]	required
blueprint	Optional[RecordingStream]	The blueprint to add the space view to. If None, the default global blueprint is used.	None

def set_panels(*, all_expanded=None, blueprint_view_expanded=None, selection_view_expanded=None, timeline_view_expanded=None, blueprint=None)

Change the visibility of the view panels.

Parameters:

Name	Type	Description	Default
all_expanded	Optional[bool]	Expand or collapse all panels.	None
blueprint_view_expanded	Optional[bool]	Expand or collapse the blueprint view panel.	None
selection_view_expanded	Optional[bool]	Expand or collapse the selection view panel.	None
timeline_view_expanded	Optional[bool]	Expand or collapse the timeline view panel.	None
blueprint	Optional[RecordingStream]	The blueprint to add the space view to. If None, the default global blueprint is used.	None

def set_auto_space_views(enabled, blueprint=None)

Change whether or not the blueprint automatically adds space views for all entities.

Parameters:

Name	Type	Description	Default
enabled	Optional[bool]	Whether or not to automatically add space views for all entities.	required
blueprint	Optional[RecordingStream]	The blueprint to add the space view to. If None, the default global blueprint is used.	None