lines.py

rerun.log.lines

def log_line_strip(entity_path, positions, *, stroke_width=None, color=None, draw_order=None, ext=None, timeless=False, recording=None)

Log a line strip through 2D or 3D space.

A line strip is a list of points connected by line segments. It can be used to draw approximations of smooth curves.

The points will be connected in order, like so:

       2------3     5
      /        \   /
0----1          \ /
                 4

Parameters:

Name	Type	Description	Default
entity_path	str	Path to the path in the space hierarchy	required
positions	ArrayLike | None	An Nx2 or Nx3 array of points along the path.	required
stroke_width	float | None	Optional width of the line.	None
color	Color | None	Optional RGB or RGBA in sRGB gamma-space as either 0-1 floats or 0-255 integers, with separate alpha.	None
draw_order	float | None	An optional floating point value that specifies the 2D drawing order. Objects with higher values are drawn on top of those with lower values. The default for lines is 20.0.	None
ext	dict[str, Any] | None	Optional dictionary of extension components. See rerun.log_extension_components	None
timeless	bool	If true, the path will be timeless (default: False).	False
recording	RecordingStream | None	Specifies the rerun.RecordingStream to use. If left unspecified, defaults to the current active data recording, if there is one. See also: rerun.init, rerun.set_global_data_recording.	None

def log_line_strips_2d(entity_path, line_strips, *, identifiers=None, stroke_widths=None, colors=None, draw_order=None, ext=None, timeless=False, recording=None)

Log a batch of line strips through 2D space.

Each line strip is a list of points connected by line segments. It can be used to draw approximations of smooth curves.

The points will be connected in order, like so:

       2------3     5
      /        \   /
0----1          \ /
                 4

Parameters:

Name	Type	Description	Default
entity_path	str	Path to the path in the space hierarchy	required
line_strips	Iterable[ArrayLike] | None	An iterable of Nx2 arrays of points along the path. To log an empty line_strip use np.zeros((0,0,3)) or np.zeros((0,0,2))	required
identifiers	ArrayLike | None	Unique numeric id that shows up when you hover or select the line.	None
stroke_widths	ArrayLike | None	Optional widths of the line.	None
colors	Color | Colors | None	Optional colors of the lines. RGB or RGBA in sRGB gamma-space as either 0-1 floats or 0-255 integers, with separate alpha.	None
draw_order	float | None	An optional floating point value that specifies the 2D drawing order. Objects with higher values are drawn on top of those with lower values. The default for lines is 20.0.	None
ext	dict[str, Any] | None	Optional dictionary of extension components. See rerun.log_extension_components	None
timeless	bool	If true, the path will be timeless (default: False).	False
recording	RecordingStream | None	Specifies the rerun.RecordingStream to use. If left unspecified, defaults to the current active data recording, if there is one. See also: rerun.init, rerun.set_global_data_recording.	None

def log_line_strips_3d(entity_path, line_strips, *, identifiers=None, stroke_widths=None, colors=None, draw_order=None, ext=None, timeless=False, recording=None)

Log a batch of line strips through 3D space.

Each line strip is a list of points connected by line segments. It can be used to draw approximations of smooth curves.

The points will be connected in order, like so:

       2------3     5
      /        \   /
0----1          \ /
                 4

Parameters:

Name	Type	Description	Default
entity_path	str	Path to the path in the space hierarchy	required
line_strips	Iterable[ArrayLike] | None	An iterable of Nx3 arrays of points along the path. To log an empty line_strip use np.zeros((0,0,3)) or np.zeros((0,0,2))	required
identifiers	ArrayLike | None	Unique numeric id that shows up when you hover or select the line.	None
stroke_widths	ArrayLike | None	Optional widths of the line.	None
colors	Color | Colors | None	Optional colors of the lines. RGB or RGBA in sRGB gamma-space as either 0-1 floats or 0-255 integers, with separate alpha.	None
draw_order	float | None	An optional floating point value that specifies the 2D drawing order. Objects with higher values are drawn on top of those with lower values. The default for lines is 20.0.	None
ext	dict[str, Any] | None	Optional dictionary of extension components. See rerun.log_extension_components	None
timeless	bool	If true, the path will be timeless (default: False).	False
recording	RecordingStream | None	Specifies the rerun.RecordingStream to use. If left unspecified, defaults to the current active data recording, if there is one. See also: rerun.init, rerun.set_global_data_recording.	None

def log_line_segments(entity_path, positions, *, stroke_width=None, color=None, draw_order=None, ext=None, timeless=False, recording=None)

Log many 2D or 3D line segments.

The points will be connected in even-odd pairs, like so:

       2------3     5
                   /
0----1            /
                 4

Parameters:

Name	Type	Description	Default
entity_path	str	Path to the line segments in the space hierarchy	required
positions	ArrayLike	An Nx2 or Nx3 array of points. Even-odd pairs will be connected as segments.	required
stroke_width	float | None	Optional width of the line.	None
color	Color | None	Optional RGB or RGBA in sRGB gamma-space as either 0-1 floats or 0-255 integers, with separate alpha.	None
draw_order	float | None	An optional floating point value that specifies the 2D drawing order. Objects with higher values are drawn on top of those with lower values. The default for lines is 20.0.	None
ext	dict[str, Any] | None	Optional dictionary of extension components. See rerun.log_extension_components	None
timeless	bool	If true, the line segments will be timeless (default: False).	False
recording	RecordingStream | None	Specifies the rerun.RecordingStream to use. If left unspecified, defaults to the current active data recording, if there is one. See also: rerun.init, rerun.set_global_data_recording.	None