pyrealsense2.pose_sensor

class pyrealsense2.pose_sensor

__init__(self: pyrealsense2.pose_sensor, sensor: pyrealsense2.sensor) → None

Methods

__init__(self, 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.
export_localization_map(self)	Get relocalization map that is currently on device, created and updated during most recent tracking session.
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_static_node(self, guid)	Gets the current pose of a static node that was created in the current map or in an imported map.
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.
import_localization_map(self, lmap_buf)	Load relocalization map onto device.
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.
remove_static_node	remove_static_node(self: pyrealsense2.pose_sensor, Removes a named virtual landmark in the current map, known as static node.
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_static_node(self, guid, pos, orient)	Creates a named virtual landmark in the current map, known as static node.
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.

export_localization_map(self: pyrealsense2.pose_sensor) → list[int]

Get relocalization map that is currently on device, created and updated during most recent tracking session. Can be called before or after stop().

get_static_node(self: pyrealsense2.pose_sensor, guid: str) → tuple[bool, pyrealsense2.vector, pyrealsense2.quaternion]

Gets the current pose of a static node that was created in the current map or in an imported map. Static nodes of imported maps are available after relocalizing the imported map. The static node’s pose is returned relative to the current origin of coordinates of device poses. Thus, poses of static nodes of an imported map are consistent with current device poses after relocalization. This function fails if the current tracker confidence is below 3 (high confidence).

import_localization_map(self: pyrealsense2.pose_sensor, lmap_buf: list[int]) → bool

Load relocalization map onto device. Only one relocalization map can be imported at a time; any previously existing map will be overwritten. The imported map exists simultaneously with the map created during the most recent tracking session after start(),and they are merged after the imported map is relocalized. This operation must be done before start().

remove_static_node()

remove_static_node(self: pyrealsense2.pose_sensor, Removes a named virtual landmark in the current map, known as static node. guid: str) -> bool

set_static_node(self: pyrealsense2.pose_sensor, guid: str, pos: pyrealsense2.vector, orient: pyrealsense2.quaternion) → bool

Creates a named virtual landmark in the current map, known as static node. The static node’s pose is provided relative to the origin of current coordinate system of device poses. This function fails if the current tracker confidence is below 3 (high confidence).