jupedsim.recording#

Module Contents#

class RecordingAgent[source]#

Data for a single agent at a single frame.

id: int[source]#
position: tuple[float, float][source]#
orientation: tuple[float, float][source]#
class RecordingFrame[source]#

A single frame from the simulation.

index: int[source]#
agents: list[RecordingAgent][source]#
class Recording(db_connection_str: str, uri=False)[source]#
Parameters:

db_connection_str (str) –

property num_frames: int[source]#

Access the number of frames stored in this recording.

Returns:

Number of frames in this recording.

Return type:

int

property fps: float[source]#

How many frames are stored per second.

Returns:

Frames per second of this recording.

Return type:

float

frame(index: int) RecordingFrame[source]#

Access a single frame of the recording.

Parameters:

index (int) – index of the frame to access.

Returns:

A single frame.

Return type:

RecordingFrame

geometry() shapely.GeometryCollection[source]#

Access this recordings’ geometry.

Returns:

walkable area of the simulation that created this recording.

Return type:

shapely.GeometryCollection

bounds() jupedsim.internal.aabb.AABB[source]#

Get bounds of the position data contained in this recording.

Return type:

jupedsim.internal.aabb.AABB