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_perception_sensor`(self)
`as_pose_sensor`(self)
`as_roi_sensor`(self)
`as_safety_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_composite_option`(self, option)	Read a composite option's current raw payload, atomically, in ONE UVC transaction - cast the returned bytes against the option's documented wire layout.
`get_composite_option_description`(self, option)	Get a composite option's human-readable description.
`get_composite_option_range`(self, option)	Read a composite option's supported {min,max,step,def} bounds, packed together - cast the returned bytes against the option's documented range struct.
`get_decimation_filter_dpp_config`(self, option)	Typed counterpart to get_composite_option() for Decimation Filter DPP.
`get_decimation_filter_dpp_range`(self, option)	Typed counterpart to get_composite_option_range() for Decimation Filter DPP.
`get_embedded_close_range_filter`(self)	Return the embedded Improved Close Range Depth filter in the sensor.
`get_embedded_decimation_filter`(self)	Return the embedded decimation filter in the sensor.
`get_embedded_filter`(self, filter_type)	Return the embedded filter in the sensor by filter type.
`get_embedded_temporal_filter`(self)	Return the embedded temporal filter in the sensor.
`get_hdrd_control`(self, option)	Typed counterpart to get_composite_option() for Improved Close Range Control - returns a hdrd_control object (bound directly against the real C struct) instead of raw bytes.
`get_hdrd_control_range`(self, option)	Typed counterpart to get_composite_option_range() for Improved Close Range Control.
`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_composite_options`(self)	Retrieve the list of composite option ids this options container supports.
`get_supported_option_values`(self)	Retrieve the supported options, each with its value and range
`get_supported_options`(self)	Retrieve list of supported options
`get_temporal_filter_dpp_config`(self, option)	Typed counterpart to get_composite_option() for Temporal Filter DPP.
`get_temporal_filter_dpp_range`(self, option)	Typed counterpart to get_composite_option_range() for Temporal Filter DPP.
`is_color_sensor`(self)
`is_composite_option_read_only`(self, option)	Check if a particular composite option is read only.
`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_perception_sensor`(self)
`is_pose_sensor`(self)
`is_roi_sensor`(self)
`is_safety_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.
`query_embedded_filters`(self)	Return the list of embedded filters in the sensor.
`set_composite_option`(self, option, data)	Write new value to a composite option, atomically, in ONE UVC transaction - data must match the option's documented wire layout byte-for-byte (e.g. bytes(struct.pack(...))).
`set_decimation_filter_dpp_config`(self, ...)	Typed counterpart to set_composite_option() for Decimation Filter DPP.
`set_hdrd_control`(self, option, value)	Typed counterpart to set_composite_option() for Improved Close Range Control.
`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)
`set_temporal_filter_dpp_config`(self, option, ...)	Typed counterpart to set_composite_option() for Temporal Filter DPP.
`start`(args, *kwargs)	Overloaded function.
`stop`(self)	Stop streaming.
`supports`(args, *kwargs)	Overloaded function.
`supports_composite_option`(self, option)	Check if a particular composite option is supported by this options container.

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_perception_sensor(self: pyrealsense2.sensor) → rs2::perception_sensor¶

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

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

as_safety_sensor(self: pyrealsense2.sensor) → rs2::safety_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_embedded_close_range_filter(self: pyrealsense2.sensor) → rs2::embedded_close_range_filter¶: Return the embedded Improved Close Range Depth filter in the sensor.

get_embedded_decimation_filter(self: pyrealsense2.sensor) → pyrealsense2.embedded_decimation_filter¶: Return the embedded decimation filter in the sensor.

get_embedded_filter(self: pyrealsense2.sensor, filter_type: pyrealsense2.embedded_filter_type) → pyrealsense2.embedded_filter¶: Return the embedded filter in the sensor by filter type.

get_embedded_temporal_filter(self: pyrealsense2.sensor) → pyrealsense2.embedded_temporal_filter¶: Return the embedded temporal filter in 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_perception_sensor(self: pyrealsense2.sensor) → bool¶

is_pose_sensor(self: pyrealsense2.sensor) → bool¶

is_roi_sensor(self: pyrealsense2.sensor) → bool¶

is_safety_sensor(self: pyrealsense2.sensor) → bool¶

is_wheel_odometer(self: pyrealsense2.sensor) → bool¶

property name¶

open(*args, **kwargs)¶

Overloaded function.

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

Open sensor for exclusive access, by commiting to a configuration

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

query_embedded_filters(self: pyrealsense2.sensor) → list[pyrealsense2.embedded_filter]¶: Return the list of embedded filters in the sensor.

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

start(*args, **kwargs)¶

Overloaded function.

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

Start passing frames into user provided callback.

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

Start passing frames into user provided syncer.

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.

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

info

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

info

pyrealsense2.sensor¶

Table of Contents

This Page