pyrealsense2.software_sensor

class pyrealsense2.software_sensor

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
add_motion_stream(self, motion_stream[, ...])	Add motion stream to software sensor
add_option(self, option, range[, is_writable])	Register option that will be supported by the sensor
add_perception_stream(self, perception_stream)	Add perception stream to software sensor
add_pose_stream(self, pose_stream[, is_default])	Add pose stream to software sensor
add_read_only_option(self, option, val)	Register read-only option that will be supported by the sensor
add_video_stream(self, video_stream[, ...])	Add video stream to software sensor
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_motion_frame(self, frame)	Inject motion frame into the sensor
on_notification(self, notif)
on_options_changed(self, callback)	Sets a callback to notify in case options in this container change value
on_pose_frame(self, frame)	Inject pose frame into the sensor
on_video_frame(self, frame)	Inject video frame into the sensor
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_metadata(self, value, type)	Set frame metadata for the upcoming frames
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_read_only_option(self, option, val)	Update value of registered read-only option
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.

add_motion_stream(self: pyrealsense2.software_sensor, motion_stream: pyrealsense2.motion_stream, is_default: bool = False) → pyrealsense2.stream_profile

Add motion stream to software sensor

add_option(self: pyrealsense2.software_sensor, option: pyrealsense2.option, range: pyrealsense2.option_range, is_writable: bool = True) → None

Register option that will be supported by the sensor

add_perception_stream(self: pyrealsense2.software_sensor, perception_stream: pyrealsense2.perception_stream, is_default: bool = False) → pyrealsense2.stream_profile

Add perception stream to software sensor

add_pose_stream(self: pyrealsense2.software_sensor, pose_stream: pyrealsense2.pose_stream, is_default: bool = False) → pyrealsense2.stream_profile

Add pose stream to software sensor

add_read_only_option(self: pyrealsense2.software_sensor, option: pyrealsense2.option, val: float) → None

Register read-only option that will be supported by the sensor

add_video_stream(self: pyrealsense2.software_sensor, video_stream: pyrealsense2.video_stream, is_default: bool = False) → pyrealsense2.stream_profile

Add video stream to software sensor

on_motion_frame(self: pyrealsense2.software_sensor, frame: pyrealsense2.software_motion_frame) → None

Inject motion frame into the sensor

on_notification(self: pyrealsense2.software_sensor, notif: pyrealsense2.software_notification) → None

on_pose_frame(self: pyrealsense2.software_sensor, frame: pyrealsense2.software_pose_frame) → None

Inject pose frame into the sensor

on_video_frame(self: pyrealsense2.software_sensor, frame: pyrealsense2.software_video_frame) → None

Inject video frame into the sensor

set_metadata(self: pyrealsense2.software_sensor, value: pyrealsense2.frame_metadata_value, type: int) → None

Set frame metadata for the upcoming frames

set_read_only_option(self: pyrealsense2.software_sensor, option: pyrealsense2.option, val: float) → None

Update value of registered read-only option