pyrealsense2.options

class pyrealsense2.options

Base class for options interface. Should be used via sensor or processing_block.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
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_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_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_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_composite_option_read_only(self, option)	Check if a particular composite option is read only.
is_option_read_only(self, option)	Check if particular option is read only.
on_options_changed(self, callback)	Sets a callback to notify in case options in this container change value
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_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.
supports(self, option)	Check if particular option is supported by a subdevice
supports_composite_option(self, option)	Check if a particular composite option is supported by this options container.

get_composite_option(self: pyrealsense2.options, option: pyrealsense2.composite_option_id) → bytes

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: pyrealsense2.options, option: pyrealsense2.composite_option_id) → str

Get a composite option’s human-readable description.

get_composite_option_range(self: pyrealsense2.options, option: pyrealsense2.composite_option_id) → bytes

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: pyrealsense2.options, option: pyrealsense2.composite_option_id) → pyrealsense2.decimation_filter_dpp_config

Typed counterpart to get_composite_option() for Decimation Filter DPP.

get_decimation_filter_dpp_range(self: pyrealsense2.options, option: pyrealsense2.composite_option_id) → pyrealsense2.decimation_filter_dpp_range

Typed counterpart to get_composite_option_range() for Decimation Filter DPP.

get_hdrd_control(self: pyrealsense2.options, option: pyrealsense2.composite_option_id) → pyrealsense2.hdrd_control

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: pyrealsense2.options, option: pyrealsense2.composite_option_id) → pyrealsense2.hdrd_control_range

Typed counterpart to get_composite_option_range() for Improved Close Range Control.

get_option(self: pyrealsense2.options, option: pyrealsense2.option) → float

Read option value from the device.

get_option_description(self: pyrealsense2.options, option: pyrealsense2.option) → str

Get option description.

get_option_range(self: pyrealsense2.options, option: pyrealsense2.option) → pyrealsense2.option_range

Retrieve the available range of values of a supported option

get_option_value(self: pyrealsense2.options, arg0: pyrealsense2.option) → pyrealsense2.option_value

get_option_value_description(self: pyrealsense2.options, option: pyrealsense2.option, value: float) → str

Get option value description (In case a specific option value holds special meaning)

get_supported_composite_options(self: pyrealsense2.options) → list[pyrealsense2.composite_option_id]

Retrieve the list of composite option ids this options container supports.

get_supported_option_values(self: pyrealsense2.options) → pyrealsense2.options_list

Retrieve the supported options, each with its value and range

get_supported_options(self: pyrealsense2.options) → list[pyrealsense2.option]

Retrieve list of supported options

get_temporal_filter_dpp_config(self: pyrealsense2.options, option: pyrealsense2.composite_option_id) → pyrealsense2.temporal_filter_dpp_config

Typed counterpart to get_composite_option() for Temporal Filter DPP.

get_temporal_filter_dpp_range(self: pyrealsense2.options, option: pyrealsense2.composite_option_id) → pyrealsense2.temporal_filter_dpp_range

Typed counterpart to get_composite_option_range() for Temporal Filter DPP.

is_composite_option_read_only(self: pyrealsense2.options, option: pyrealsense2.composite_option_id) → bool

Check if a particular composite option is read only.

is_option_read_only(self: pyrealsense2.options, option: pyrealsense2.option) → bool

Check if particular option is read only.

on_options_changed(self: pyrealsense2.options, callback: Callable[[pyrealsense2.options_list], None]) → None

Sets a callback to notify in case options in this container change value

set_composite_option(self: pyrealsense2.options, option: pyrealsense2.composite_option_id, data: Buffer) → None

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: pyrealsense2.options, option: pyrealsense2.composite_option_id, value: pyrealsense2.decimation_filter_dpp_config) → None

Typed counterpart to set_composite_option() for Decimation Filter DPP.

set_hdrd_control(self: pyrealsense2.options, option: pyrealsense2.composite_option_id, value: pyrealsense2.hdrd_control) → None

Typed counterpart to set_composite_option() for Improved Close Range Control.

set_option(self: pyrealsense2.options, option: pyrealsense2.option, value: float) → None

Write new value to device option

set_option_value(self: pyrealsense2.options, arg0: pyrealsense2.option, arg1: json) → None

set_temporal_filter_dpp_config(self: pyrealsense2.options, option: pyrealsense2.composite_option_id, value: pyrealsense2.temporal_filter_dpp_config) → None

Typed counterpart to set_composite_option() for Temporal Filter DPP.

supports(self: pyrealsense2.options, option: pyrealsense2.option) → bool

Check if particular option is supported by a subdevice

supports_composite_option(self: pyrealsense2.options, option: pyrealsense2.composite_option_id) → bool

Check if a particular composite option is supported by this options container.