pyrealsense2.sensor

class pyrealsense2.sensor

__init__(self: pyrealsense2.sensor) → None

Methods

__init__(self)
as_color_sensor(self)
as_debug_stream_sensor(self)
as_depth_sensor(self)
as_fisheye_sensor(self)
as_max_usable_range_sensor(self)
as_motion_sensor(self)
as_pose_sensor(self)
as_roi_sensor(self)
as_wheel_odometer(self)
close(self)	Close sensor for exclusive access.
from_frame(frame)
get_active_streams(self)	Retrieves the list of stream profiles currently streaming on the sensor.
get_info(self, info)	Retrieve camera specific information, like versions of various internal components.
get_option(self, option)	Read option value from the device.
get_option_description(self, option)	Get option description.
get_option_range(self, option)	Retrieve the available range of values of a supported option
get_option_value(self, arg0)
get_option_value_description(self, option, value)	Get option value description (In case a specific option value holds special meaning)
get_recommended_filters(self)	Return the recommended list of filters by the sensor.
get_stream_profiles(self)	Retrieves the list of stream profiles supported by the sensor.
get_supported_options(self)	Retrieve list of supported options
is_color_sensor(self)
is_debug_stream_sensor(self)
is_depth_sensor(self)
is_fisheye_sensor(self)
is_max_usable_range_sensor(self)
is_motion_sensor(self)
is_option_read_only(self, option)	Check if particular option is read only.
is_pose_sensor(self)
is_roi_sensor(self)
is_wheel_odometer(self)
on_options_changed(self, callback)	Sets a callback to notify in case options in this container change value
open(*args, **kwargs)	Overloaded function.
set_notifications_callback(self, callback)	Register Notifications callback
set_option(self, option, value)	Write new value to device option
set_option_value(self, arg0, arg1)
start(*args, **kwargs)	Overloaded function.
stop(self)	Stop streaming.
supports(*args, **kwargs)	Overloaded function.

Attributes

name
profiles	The list of stream profiles supported by the sensor.

as_color_sensor(self: pyrealsense2.sensor) → rs2::color_sensor

as_debug_stream_sensor(self: pyrealsense2.sensor) → rs2::debug_stream_sensor

as_depth_sensor(self: pyrealsense2.sensor) → rs2::depth_sensor

as_fisheye_sensor(self: pyrealsense2.sensor) → rs2::fisheye_sensor

as_max_usable_range_sensor(self: pyrealsense2.sensor) → rs2::max_usable_range_sensor

as_motion_sensor(self: pyrealsense2.sensor) → rs2::motion_sensor

as_pose_sensor(self: pyrealsense2.sensor) → rs2::pose_sensor

as_roi_sensor(self: pyrealsense2.sensor) → rs2::roi_sensor

as_wheel_odometer(self: pyrealsense2.sensor) → rs2::wheel_odometer

close(self: pyrealsense2.sensor) → None

Close sensor for exclusive access.

static from_frame(frame: pyrealsense2.frame) → pyrealsense2.sensor

get_active_streams(self: pyrealsense2.sensor) → list[pyrealsense2.stream_profile]

Retrieves the list of stream profiles currently streaming on the sensor.

get_info(self: pyrealsense2.sensor, info: pyrealsense2.camera_info) → str

Retrieve camera specific information, like versions of various internal components.

get_recommended_filters(self: pyrealsense2.sensor) → list[pyrealsense2.filter]

Return the recommended list of filters by the sensor.

get_stream_profiles(self: pyrealsense2.sensor) → list[pyrealsense2.stream_profile]

Retrieves the list of stream profiles supported by the sensor.

is_color_sensor(self: pyrealsense2.sensor) → bool

is_debug_stream_sensor(self: pyrealsense2.sensor) → bool

is_depth_sensor(self: pyrealsense2.sensor) → bool

is_fisheye_sensor(self: pyrealsense2.sensor) → bool

is_max_usable_range_sensor(self: pyrealsense2.sensor) → bool

is_motion_sensor(self: pyrealsense2.sensor) → bool

is_pose_sensor(self: pyrealsense2.sensor) → bool

is_roi_sensor(self: pyrealsense2.sensor) → bool

is_wheel_odometer(self: pyrealsense2.sensor) → bool

property name

open(*args, **kwargs)

Overloaded function.

1. open(self: pyrealsense2.sensor, profile: pyrealsense2.stream_profile) -> None

Open sensor for exclusive access, by commiting to a configuration

2. open(self: pyrealsense2.sensor, profiles: list[pyrealsense2.stream_profile]) -> None

Open sensor for exclusive access, by committing to a composite configuration, specifying one or more stream profiles.

property profiles

The list of stream profiles supported by the sensor. Identical to calling get_stream_profiles

set_notifications_callback(self: pyrealsense2.sensor, callback: Callable[[pyrealsense2.notification], None]) → None

Register Notifications callback

start(*args, **kwargs)

Overloaded function.

1. start(self: pyrealsense2.sensor, callback: Callable[[pyrealsense2.frame], None]) -> None

Start passing frames into user provided callback.

2. start(self: pyrealsense2.sensor, syncer: pyrealsense2.syncer) -> None

Start passing frames into user provided syncer.

3. start(self: pyrealsense2.sensor, queue: pyrealsense2.frame_queue) -> None

start passing frames into specified frame_queue

stop(self: pyrealsense2.sensor) → None

Stop streaming.

supports(*args, **kwargs)

Overloaded function.

1. supports(self: pyrealsense2.sensor, arg0: pyrealsense2.camera_info) -> bool

info

2. supports(self: pyrealsense2.sensor, arg0: pyrealsense2.option) -> bool

info