ouster.sdk.zone_monitor

Module contents

Copyright (c) 2023, Ouster, Inc. All rights reserved.

This module provides classes and utilities for configuring, managing, and monitoring zones in Ouster lidar data.

ouster.sdk.zone_monitor.zone_common

class EmulatedZoneMon(zone_set)[source]

Bases: object

Emulates ZoneMon alert decisions using ZoneRenderCache and range data.

calc_triggers(range_field, bitmask_field=None)[source]
get_packet()[source]

ZoneSet

class ZoneSet(*args, **kwargs)

Overloaded function.

  1. __init__(self: ouster.sdk._bindings.client.ZoneSet) -> None

  2. __init__(self: ouster.sdk._bindings.client.ZoneSet, arg0: str) -> None

  3. __init__(self: ouster.sdk._bindings.client.ZoneSet, arg0: bytes) -> None

__annotations__ = {}
__eq__(self: ouster.sdk._bindings.client.ZoneSet, arg0: ouster.sdk._bindings.client.ZoneSet) → bool
__hash__ = None
__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: ouster.sdk._bindings.client.ZoneSet) -> None

  2. __init__(self: ouster.sdk._bindings.client.ZoneSet, arg0: str) -> None

  3. __init__(self: ouster.sdk._bindings.client.ZoneSet, arg0: bytes) -> None

__module__ = 'ouster.sdk._bindings.client'
property label
property power_on_live_ids
render(self: ouster.sdk._bindings.client.ZoneSet, arg0: ouster.sdk._bindings.client.SensorInfo) → None
save(self: ouster.sdk._bindings.client.ZoneSet, arg0: str, arg1: ouster.sdk._bindings.client.ZoneSetOutputFilter) → None
property sensor_to_body_transform
to_json(self: ouster.sdk._bindings.client.ZoneSet, arg0: ouster.sdk._bindings.client.ZoneSetOutputFilter) → str
to_zip_blob(self: ouster.sdk._bindings.client.ZoneSet, arg0: ouster.sdk._bindings.client.ZoneSetOutputFilter) → bytes
property zones

Zone

class Zone(self: ouster.sdk._bindings.client.Zone)
__annotations__ = {}
__eq__(self: ouster.sdk._bindings.client.Zone, arg0: ouster.sdk._bindings.client.Zone) → bool
__hash__ = None
__init__(self: ouster.sdk._bindings.client.Zone) → None
__module__ = 'ouster.sdk._bindings.client'
property frame_count
property label
property mode
property point_count
property stl
property zrb

ZoneMode

class ZoneMode(self: ouster.sdk._bindings.client.ZoneMode, value: int)

Members:

NONE

OCCUPANCY

VACANCY

NONE = <ZoneMode.NONE: 0>
OCCUPANCY = <ZoneMode.OCCUPANCY: 1>
VACANCY = <ZoneMode.VACANCY: 2>
__annotations__ = {}
__eq__(self: object, other: object) → bool
__getstate__(self: object) → int
__hash__(self: object) → int
__index__(self: ouster.sdk._bindings.client.ZoneMode) → int
__init__(self: ouster.sdk._bindings.client.ZoneMode, value: int) → None
__int__(self: ouster.sdk._bindings.client.ZoneMode) → int
__members__ = {'NONE': <ZoneMode.NONE: 0>, 'OCCUPANCY': <ZoneMode.OCCUPANCY: 1>, 'VACANCY': <ZoneMode.VACANCY: 2>}
__module__ = 'ouster.sdk._bindings.client'
__ne__(self: object, other: object) → bool
__repr__(self: object) → str
__setstate__(self: ouster.sdk._bindings.client.ZoneMode, state: int) → None
__str__(self: object) → str
property name
property value

Stl

class Stl(*args, **kwargs)

Overloaded function.

  1. __init__(self: ouster.sdk._bindings.client.Stl, arg0: str) -> None

  2. __init__(self: ouster.sdk._bindings.client.Stl, arg0: list[int]) -> None

__annotations__ = {}
__eq__(self: ouster.sdk._bindings.client.Stl, arg0: ouster.sdk._bindings.client.Stl) → bool
__hash__ = None
__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: ouster.sdk._bindings.client.Stl, arg0: str) -> None

  2. __init__(self: ouster.sdk._bindings.client.Stl, arg0: list[int]) -> None

__module__ = 'ouster.sdk._bindings.client'
property coordinate_frame
property filename
property hash
to_mesh(self: ouster.sdk._bindings.client.Stl) → ouster.sdk._bindings.client.Mesh

Zrb

class Zrb(*args, **kwargs)

Overloaded function.

  1. __init__(self: ouster.sdk._bindings.client.Zrb) -> None

  2. __init__(self: ouster.sdk._bindings.client.Zrb, arg0: str) -> None

  3. __init__(self: ouster.sdk._bindings.client.Zrb, arg0: list[int]) -> None

__annotations__ = {}
__eq__(self: ouster.sdk._bindings.client.Zrb, arg0: ouster.sdk._bindings.client.Zrb) → bool
__hash__ = None
__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: ouster.sdk._bindings.client.Zrb) -> None

  2. __init__(self: ouster.sdk._bindings.client.Zrb, arg0: str) -> None

  3. __init__(self: ouster.sdk._bindings.client.Zrb, arg0: list[int]) -> None

__module__ = 'ouster.sdk._bindings.client'
property beam_to_lidar_transform
blob(self: ouster.sdk._bindings.client.Zrb) → list[int]
property far_range_mm
property hash
property lidar_to_sensor_transform
property near_range_mm
save(self: ouster.sdk._bindings.client.Zrb, arg0: str) → None
property sensor_to_body_transform
property serial_number
property stl_hash

ZoneState

class ZoneState
__annotations__ = {}
__init__(*args, **kwargs)
__module__ = 'ouster.sdk._bindings.client'
property count
static dtype() → numpy.dtype
property error_flags
property id
property invalid_count
property live
property max_count
property max_range
property mean_range
property min_range
property occlusion_count
property trigger_status
property trigger_type
property triggered_frames

CoordinateFrame

class CoordinateFrame(self: ouster.sdk._bindings.client.CoordinateFrame, value: int)

Members:

BODY

SENSOR

BODY = <CoordinateFrame.BODY: 1>
SENSOR = <CoordinateFrame.SENSOR: 2>
__annotations__ = {}
__eq__(self: object, other: object) → bool
__getstate__(self: object) → int
__hash__(self: object) → int
__index__(self: ouster.sdk._bindings.client.CoordinateFrame) → int
__init__(self: ouster.sdk._bindings.client.CoordinateFrame, value: int) → None
__int__(self: ouster.sdk._bindings.client.CoordinateFrame) → int
__members__ = {'BODY': <CoordinateFrame.BODY: 1>, 'SENSOR': <CoordinateFrame.SENSOR: 2>}
__module__ = 'ouster.sdk._bindings.client'
__ne__(self: object, other: object) → bool
__repr__(self: object) → str
__setstate__(self: ouster.sdk._bindings.client.CoordinateFrame, state: int) → None
__str__(self: object) → str
property name
property value

ZoneSetOutputFilter

class ZoneSetOutputFilter(self: ouster.sdk._bindings.client.ZoneSetOutputFilter, value: int)

Members:

STL

ZRB

STL_AND_ZRB

STL = <ZoneSetOutputFilter.STL: 0>
STL_AND_ZRB = <ZoneSetOutputFilter.STL_AND_ZRB: 2>
ZRB = <ZoneSetOutputFilter.ZRB: 1>
__annotations__ = {}
__eq__(self: object, other: object) → bool
__getstate__(self: object) → int
__hash__(self: object) → int
__index__(self: ouster.sdk._bindings.client.ZoneSetOutputFilter) → int
__init__(self: ouster.sdk._bindings.client.ZoneSetOutputFilter, value: int) → None
__int__(self: ouster.sdk._bindings.client.ZoneSetOutputFilter) → int
__members__ = {'STL': <ZoneSetOutputFilter.STL: 0>, 'STL_AND_ZRB': <ZoneSetOutputFilter.STL_AND_ZRB: 2>, 'ZRB': <ZoneSetOutputFilter.ZRB: 1>}
__module__ = 'ouster.sdk._bindings.client'
__ne__(self: object, other: object) → bool
__repr__(self: object) → str
__setstate__(self: ouster.sdk._bindings.client.ZoneSetOutputFilter, state: int) → None
__str__(self: object) → str
property name
property value