Skip to content

Utilities

rerun.utilities

color_grid = build_color_grid() module-attribute

Default color grid

color_spiral = build_color_spiral() module-attribute

Default color spiral

rect_pyramid = build_rect_pyramid() module-attribute

Default rect pyramid data

def bounce_lerp(a, b, t)

A linear interpolator that bounces between a and b as t goes above 1.0.

PARAMETER DESCRIPTION
a

Start value (t == 0).

TYPE: float

b

End value (t == 1).

TYPE: float

t

Interpolation coefficient.

TYPE: float | ndarray[Any, dtype[Any]]

def build_color_grid(x_count=10, y_count=10, z_count=10, twist=0)

Create a cube of points with colors.

The total point cloud will have x_count * y_count * z_count points.

PARAMETER DESCRIPTION
x_count

Number of points in each dimension.

TYPE: int DEFAULT: 10

y_count

Number of points in each dimension.

TYPE: int DEFAULT: 10

z_count

Number of points in each dimension.

TYPE: int DEFAULT: 10

twist

Angle to twist from bottom to top of the cube

TYPE: float DEFAULT: 0

def build_color_spiral(num_points=100, radius=2, angular_step=0.02, angular_offset=0, z_step=0.1)

Create a spiral of points with colors along the Z axis.

PARAMETER DESCRIPTION
num_points

Total number of points.

TYPE: int DEFAULT: 100

radius

The radius of the spiral.

TYPE: float DEFAULT: 2

angular_step

The factor applied between each step along the trigonometric circle.

TYPE: float DEFAULT: 0.02

angular_offset

Offsets the starting position on the trigonometric circle.

TYPE: float DEFAULT: 0

z_step

The factor applied between each step along the Z axis.

TYPE: float DEFAULT: 0.1

def build_rect_pyramid(count=20, width=100, height=100)

Create a stack of N colored rectangles.

PARAMETER DESCRIPTION
count

Number of rectangles to create.

TYPE: int DEFAULT: 20

width

Width of the base of the pyramid.

TYPE: int DEFAULT: 100

height

Height of the pyramid.

TYPE: int DEFAULT: 100

def interleave(arr1, arr2)

Interleaves two numpy arrays.

PARAMETER DESCRIPTION
arr1

A numpy array of arbitrary shape and length.

TYPE: NDArray[float64]

arr2

A numpy array with the same shape and length as arr1.

TYPE: NDArray[float64]

data

Simple data to be used for Rerun demos.

color_grid = build_color_grid() module-attribute

Default color grid

color_spiral = build_color_spiral() module-attribute

Default color spiral

rect_pyramid = build_rect_pyramid() module-attribute

Default rect pyramid data

def build_color_grid(x_count=10, y_count=10, z_count=10, twist=0)

Create a cube of points with colors.

The total point cloud will have x_count * y_count * z_count points.

PARAMETER DESCRIPTION
x_count

Number of points in each dimension.

TYPE: int DEFAULT: 10

y_count

Number of points in each dimension.

TYPE: int DEFAULT: 10

z_count

Number of points in each dimension.

TYPE: int DEFAULT: 10

twist

Angle to twist from bottom to top of the cube

TYPE: float DEFAULT: 0

def build_color_spiral(num_points=100, radius=2, angular_step=0.02, angular_offset=0, z_step=0.1)

Create a spiral of points with colors along the Z axis.

PARAMETER DESCRIPTION
num_points

Total number of points.

TYPE: int DEFAULT: 100

radius

The radius of the spiral.

TYPE: float DEFAULT: 2

angular_step

The factor applied between each step along the trigonometric circle.

TYPE: float DEFAULT: 0.02

angular_offset

Offsets the starting position on the trigonometric circle.

TYPE: float DEFAULT: 0

z_step

The factor applied between each step along the Z axis.

TYPE: float DEFAULT: 0.1

def build_rect_pyramid(count=20, width=100, height=100)

Create a stack of N colored rectangles.

PARAMETER DESCRIPTION
count

Number of rectangles to create.

TYPE: int DEFAULT: 20

width

Width of the base of the pyramid.

TYPE: int DEFAULT: 100

height

Height of the pyramid.

TYPE: int DEFAULT: 100

util

Simple utilities to be used for Rerun demos.

def bounce_lerp(a, b, t)

A linear interpolator that bounces between a and b as t goes above 1.0.

PARAMETER DESCRIPTION
a

Start value (t == 0).

TYPE: float

b

End value (t == 1).

TYPE: float

t

Interpolation coefficient.

TYPE: float | ndarray[Any, dtype[Any]]

def interleave(arr1, arr2)

Interleaves two numpy arrays.

PARAMETER DESCRIPTION
arr1

A numpy array of arbitrary shape and length.

TYPE: NDArray[float64]

arr2

A numpy array with the same shape and length as arr1.

TYPE: NDArray[float64]