Skip to content

Archetypes

rerun.blueprint.archetypes

class Background

Bases: BackgroundExt, Archetype

Archetype: Configuration for the background of a view.

def __init__(color_or_kind=None, *, color=None, kind=None)

Create a new instance of the Background archetype.

PARAMETER DESCRIPTION
color_or_kind

Either a color for solid background color or kind of the background (see BackgroundKind). If set, color and kind must not be set.

TYPE: Rgba32Like | BackgroundKindLike | None DEFAULT: None

kind

The type of the background. Defaults to BackgroundKind.GradientDark.

TYPE: BackgroundKindLike | None DEFAULT: None

color

Color used for BackgroundKind.SolidColor.

Defaults to White.

TYPE: Rgba32Like | None DEFAULT: None

class ContainerBlueprint

Bases: Archetype

Archetype: The top-level description of the Viewport.

def __init__(container_kind, *, display_name=None, contents=None, col_shares=None, row_shares=None, active_tab=None, visible=None, grid_columns=None)

Create a new instance of the ContainerBlueprint archetype.

PARAMETER DESCRIPTION
container_kind

The class of the view.

TYPE: ContainerKindLike

display_name

The name of the container.

TYPE: Utf8Like | None DEFAULT: None

contents

ContainerIds or SpaceViewIds that are children of this container.

TYPE: EntityPathArrayLike | None DEFAULT: None

col_shares

The layout shares of each column in the container.

For Horizontal containers, the length of this list should always match the number of contents.

Ignored for Vertical containers.

TYPE: Float32ArrayLike | None DEFAULT: None

row_shares

The layout shares of each row of the container.

For Vertical containers, the length of this list should always match the number of contents.

Ignored for Horizontal containers.

TYPE: Float32ArrayLike | None DEFAULT: None

active_tab

Which tab is active.

Only applies to Tabs containers.

TYPE: EntityPathLike | None DEFAULT: None

visible

Whether this container is visible.

Defaults to true if not specified.

TYPE: BoolLike | None DEFAULT: None

grid_columns

How many columns this grid should have.

If unset, the grid layout will be auto.

Ignored for Horizontal/Vertical containers.

TYPE: UInt32Like | None DEFAULT: None

class DataframeQuery

Bases: Archetype

Archetype: The query for the dataframe view.

def __init__(*, timeline=None, kind=None, latest_at_queries=None, time_range_queries=None)

Create a new instance of the DataframeQuery archetype.

PARAMETER DESCRIPTION
timeline

The timeline for this query.

If unset, use the time panel's timeline and a latest at query, ignoring all other components of this archetype.

TYPE: Utf8Like | None DEFAULT: None

kind

Kind of query: latest-at or range.

TYPE: QueryKindLike | None DEFAULT: None

latest_at_queries

Configuration for latest-at queries.

Note: configuration as saved on a per-timeline basis.

TYPE: LatestAtQueriesLike | None DEFAULT: None

time_range_queries

Configuration for the time range queries.

Note: configuration as saved on a per-timeline basis.

TYPE: TimeRangeQueriesLike | None DEFAULT: None

class PanelBlueprint

Bases: Archetype

Archetype: Shared state for the 3 collapsible panels.

def __init__(*, state=None)

Create a new instance of the PanelBlueprint archetype.

class PlotLegend

Bases: PlotLegendExt, Archetype

Archetype: Configuration for the legend of a plot.

def __init__(corner=None, *, visible=None)

Create a new instance of the PlotLegend archetype.

PARAMETER DESCRIPTION
corner

To what corner the legend is aligned.

Defaults to the right bottom corner.

TYPE: Corner2DLike | None DEFAULT: None

visible

Whether the legend is shown at all.

True by default.

TYPE: BoolLike | None DEFAULT: None

class ScalarAxis

Bases: Archetype

Archetype: Configuration for the scalar axis of a plot.

def __init__(*, range=None, zoom_lock=None)

Create a new instance of the ScalarAxis archetype.

PARAMETER DESCRIPTION
range

The range of the axis.

If unset, the range well be automatically determined based on the queried data.

TYPE: Range1DLike | None DEFAULT: None

zoom_lock

If enabled, the Y axis range will remain locked to the specified range when zooming.

TYPE: BoolLike | None DEFAULT: None

class SpaceViewBlueprint

Bases: Archetype

Archetype: The top-level description of the Viewport.

def __init__(class_identifier, *, display_name=None, space_origin=None, visible=None)

Create a new instance of the SpaceViewBlueprint archetype.

PARAMETER DESCRIPTION
class_identifier

The class of the view.

TYPE: Utf8Like

display_name

The name of the view.

TYPE: Utf8Like | None DEFAULT: None

space_origin

The "anchor point" of this space view.

Defaults to the root path '/' if not specified.

The transform at this path forms the reference point for all scene->world transforms in this space view. I.e. the position of this entity path in space forms the origin of the coordinate system in this space view. Furthermore, this is the primary indicator for heuristics on what entities we show in this space view.

TYPE: EntityPathLike | None DEFAULT: None

visible

Whether this space view is visible.

Defaults to true if not specified.

TYPE: BoolLike | None DEFAULT: None

class SpaceViewContents

Bases: Archetype

Archetype: The contents of a SpaceView.

The contents are found by combining a collection of QueryExpressions.

+ /world/**           # add everything…
- /world/roads/**     # …but remove all roads…
+ /world/roads/main   # …but show main road

If there is multiple matching rules, the most specific rule wins. If there are multiple rules of the same specificity, the last one wins. If no rules match, the path is excluded.

Specifying a path without a + or - prefix is equivalent to +:

/world/**           # add everything…
- /world/roads/**   # …but remove all roads…
/world/roads/main   # …but show main road

The /** suffix matches the whole subtree, i.e. self and any child, recursively (/world/** matches both /world and /world/car/driver). Other uses of * are not (yet) supported.

Internally, EntityPathFilter sorts the rule by entity path, with recursive coming before non-recursive. This means the last matching rule is also the most specific one. For instance:

+ /world/**
- /world
- /world/car/**
+ /world/car/driver

The last rule matching /world/car/driver is + /world/car/driver, so it is included. The last rule matching /world/car/hood is - /world/car/**, so it is excluded. The last rule matching /world is - /world, so it is excluded. The last rule matching /world/house is + /world/**, so it is included.

def __init__(query)

Create a new instance of the SpaceViewContents archetype.

PARAMETER DESCRIPTION
query

The QueryExpression that populates the contents for the SpaceView.

They determine which entities are part of the spaceview.

TYPE: Utf8ArrayLike

class TensorScalarMapping

Bases: Archetype

Archetype: Configures how tensor scalars are mapped to color.

def __init__(*, mag_filter=None, colormap=None, gamma=None)

Create a new instance of the TensorScalarMapping archetype.

PARAMETER DESCRIPTION
mag_filter

Filter used when zooming in on the tensor.

Note that the filter is applied to the scalar values before they are mapped to color.

TYPE: MagnificationFilterLike | None DEFAULT: None

colormap

How scalar values map to colors.

TYPE: ColormapLike | None DEFAULT: None

gamma

Gamma exponent applied to normalized values before mapping to color.

Raises the normalized values to the power of this value before mapping to color. Acts like an inverse brightness. Defaults to 1.0.

TYPE: Float32Like | None DEFAULT: None

class TensorSliceSelection

Bases: Archetype

Archetype: Specifies a 2D slice of a tensor.

def __init__(*, width=None, height=None, indices=None, slider=None)

Create a new instance of the TensorSliceSelection archetype.

PARAMETER DESCRIPTION
width

Which dimension to map to width.

If not specified, the height will be determined automatically based on the name and index of the dimension.

TYPE: TensorDimensionSelectionLike | None DEFAULT: None

height

Which dimension to map to height.

If not specified, the height will be determined automatically based on the name and index of the dimension.

TYPE: TensorDimensionSelectionLike | None DEFAULT: None

indices

Selected indices for all other dimensions.

If any of the here listed dimensions is equal to width or height, it will be ignored.

TYPE: TensorDimensionIndexSelectionArrayLike | None DEFAULT: None

slider

Any dimension listed here will have a slider for the index.

Edits to the sliders will directly manipulate dimensions on the indices list. If any of the here listed dimensions is equal to width or height, it will be ignored. If not specified, adds slides for any dimension in indices.

TYPE: TensorDimensionIndexSliderArrayLike | None DEFAULT: None

class TensorViewFit

Bases: TensorViewFitExt, Archetype

Archetype: Configures how a selected tensor slice is shown on screen.

def __init__(scaling=None)

Create a new instance of the TensorViewFit archetype.

PARAMETER DESCRIPTION
scaling

How the image is scaled to fit the view.

TYPE: ViewFitLike | None DEFAULT: None

class TimeRangeTableOrder

Bases: Archetype

Archetype: Ordering of the time range table of the dataframe view.

def __init__(*, sort_key=None, sort_order=None)

Create a new instance of the TimeRangeTableOrder archetype.

PARAMETER DESCRIPTION
sort_key

The primary sort key

TYPE: SortKeyLike | None DEFAULT: None

sort_order

The sort order

TYPE: SortOrderLike | None DEFAULT: None

class ViewportBlueprint

Bases: Archetype

Archetype: The top-level description of the Viewport.

def __init__(*, root_container=None, maximized=None, auto_layout=None, auto_space_views=None, past_viewer_recommendations=None)

Create a new instance of the ViewportBlueprint archetype.

PARAMETER DESCRIPTION
root_container

The layout of the space-views

TYPE: UuidLike | None DEFAULT: None

maximized

Show one tab as maximized?

TYPE: UuidLike | None DEFAULT: None

auto_layout

Whether the viewport layout is determined automatically.

If true, the container layout will be reset whenever a new space view is added or removed. This defaults to false and is automatically set to false when there is user determined layout.

TYPE: BoolLike | None DEFAULT: None

auto_space_views

Whether or not space views should be created automatically.

If true, the viewer will only add space views that it hasn't considered previously (as identified by past_viewer_recommendations) and which aren't deemed redundant to existing space views. This defaults to false and is automatically set to false when the user adds space views manually in the viewer.

TYPE: BoolLike | None DEFAULT: None

past_viewer_recommendations

Hashes of all recommended space views the viewer has already added and that should not be added again.

This is an internal field and should not be set usually. If you want the viewer from stopping to add space views, you should set auto_space_views to false.

The viewer uses this to determine whether it should keep adding space views.

TYPE: UInt64ArrayLike | None DEFAULT: None

class VisibleTimeRanges

Bases: VisibleTimeRangesExt, Archetype

Archetype: Configures what range of each timeline is shown on a view.

Whenever no visual time range applies, queries are done with "latest at" semantics. This means that the view will, starting from the time cursor position, query the latest data available for each component type.

The default visual time range depends on the type of view this property applies to: - For time series views, the default is to show the entire timeline. - For any other view, the default is to apply latest-at semantics.

def __init__(ranges)

Create a new instance of the VisibleTimeRanges archetype.

PARAMETER DESCRIPTION
ranges

The time ranges to show for each timeline unless specified otherwise on a per-entity basis.

If a timeline is listed twice, a warning will be issued and the first entry will be used.

TYPE: VisibleTimeRangeArrayLike

class VisualBounds2D

Bases: VisualBounds2DExt, Archetype

Archetype: Controls the visual bounds of a 2D view.

Everything within these bounds are guaranteed to be visible. Somethings outside of these bounds may also be visible due to letterboxing.

If no visual bounds are set, it will be determined automatically, based on the bounding-box of the data or other camera information present in the view.

def __init__(*, x_range, y_range)

Create a new instance of the VisualBounds2D archetype.

PARAMETER DESCRIPTION
x_range

The minimum visible range of the X-axis (usually left and right bounds).

TYPE: Range1DLike

y_range

The minimum visible range of the Y-axis (usually left and right bounds).

TYPE: Range1DLike