Skip to main content
Public SDK scene read types. These are stable SDK types that insulate users from the internal wire format. They are constructed from the internal types in beta/scene/internal/scene.py.

​
SceneEvent Objects

@dataclass
class SceneEvent()
A single event in a stream, with its signed download URL and timestamp.

​
timestamp

Timestamp of the event.

​
url

Raw unsigned URI as stored in the scene definition.

​
signed_url

Time-limited signed URL for downloading the file.

​
PointCloudStream Objects

@dataclass
class PointCloudStream()
A stream of lidar point cloud events.

​
find_event

def find_event(timestamp: float) -> SceneEvent | None
Return the event with the given timestamp, or None if not present.

​
get_event

def get_event(timestamp: float) -> SceneEvent
Return the event with the given timestamp. Raises:
  • KeyError - If no event with that timestamp exists.

​
ImageStream Objects

@dataclass
class ImageStream()
A stream of camera image events.

​
find_event

def find_event(timestamp: float) -> SceneEvent | None
Return the event with the given timestamp, or None if not present.

​
get_event

def get_event(timestamp: float) -> SceneEvent
Return the event with the given timestamp. Raises:
  • KeyError - If no event with that timestamp exists.

​
CompositeScene Objects

@dataclass
class CompositeScene()
A scene composed of multiple named streams (lidar + cameras).

​
find_stream

def find_stream(
    stream_id: str, *, kind: Literal["point_cloud", "image"]
) -> PointCloudStream | ImageStream | None
Return the stream with the given ID and kind, or None if not present.

​
get_stream

def get_stream(
        stream_id: str, *,
        kind: Literal["point_cloud",
                      "image"]) -> PointCloudStream | ImageStream
Return the stream with the given ID and kind. Raises:
  • KeyError - If no stream with that ID and kind exists.

​
get_images_at_timestamp

def get_images_at_timestamp(timestamp: float) -> list[tuple[str, SceneEvent]]
Return camera image events at the given timestamp across image streams. Streams without a matching event are skipped.

​
SceneRead Objects

class SceneRead()
Read scene structure and signed URLs from a scene storage item.

​
read

def read() -> Scene
Fetch the scene structure with signed download URLs for all constituent files.