pyrealsense2.embedded_filter

class pyrealsense2.embedded_filter

Define the embedded filter workflow.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
as_embedded_decimation_filter(self)
as_embedded_temporal_filter(self)
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.
get_type(self)	Get the embedded filter type
is_composite_option_read_only(self, option)	Check if a particular composite option is read only.
is_embedded_decimation_filter(self)
is_embedded_temporal_filter(self)
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.

as_embedded_decimation_filter(self: pyrealsense2.embedded_filter) → rs2::embedded_decimation_filter

as_embedded_temporal_filter(self: pyrealsense2.embedded_filter) → rs2::embedded_temporal_filter

get_type(self: pyrealsense2.embedded_filter) → pyrealsense2.embedded_filter_type

Get the embedded filter type

is_embedded_decimation_filter(self: pyrealsense2.embedded_filter) → bool

is_embedded_temporal_filter(self: pyrealsense2.embedded_filter) → bool