6.5. Filters

Post-processing filters for enhancing and processing frames.

6.5.1. Class Hierarchy

The Filter class is the base class for all filter types.

digraph FilterHierarchyBasic {
rankdir=TB;
bgcolor=transparent;
node [shape=box, style="filled,rounded", fillcolor="#e3f2fd", color="#2196f3", fontname="Helvetica Neue, Helvetica, Arial, sans-serif", fontsize=11];
edge [color="#666666", arrowsize=0.8, penwidth=1.2];

Filter [label="Filter"];
AlignFilter [label="AlignFilter"];
DecimationFilter [label="DecimationFilter"];
HoleFillingFilter [label="HoleFillingFilter"];
NoiseRemovalFilter [label="NoiseRemovalFilter"];
SpatialAdvancedFilter [label="SpatialAdvancedFilter"];
TemporalFilter [label="TemporalFilter"];

Filter -> AlignFilter;
Filter -> DecimationFilter;
Filter -> HoleFillingFilter;
Filter -> NoiseRemovalFilter;
Filter -> SpatialAdvancedFilter;
Filter -> TemporalFilter;
}

digraph FilterHierarchyAdvanced {
rankdir=TB;
bgcolor=transparent;
node [shape=box, style="filled,rounded", fillcolor="#e3f2fd", color="#2196f3", fontname="Helvetica Neue, Helvetica, Arial, sans-serif", fontsize=11];
edge [color="#666666", arrowsize=0.8, penwidth=1.2];

Filter [label="Filter"];
PointCloudFilter [label="PointCloudFilter"];
SequenceIdFilter [label="SequenceIdFilter"];
HDRMergeFilter [label="HDRMergeFilter"];
ThresholdFilter [label="ThresholdFilter"];
FormatConvertFilter [label="FormatConvertFilter"];
DisparityTransform [label="DisparityTransform"];

Filter -> PointCloudFilter;
Filter -> SequenceIdFilter;
Filter -> HDRMergeFilter;
Filter -> ThresholdFilter;
Filter -> FormatConvertFilter;
Filter -> DisparityTransform;
}

6.5.2. Inheritance Overview

Class Inheritance Hierarchy
Class	Inherits From	Description
`Filter`	object	Base class for all filters
`AlignFilter`	`Filter`	Align depth to color or vice versa
`DecimationFilter`	`Filter`	Reduces depth scene complexity
`DisparityTransform`	`Filter`	Transform between disparity and depth
`FormatConvertFilter`	`Filter`	Convert between pixel formats
`HDRMergeFilter`	`Filter`	Merge HDR frames
`HoleFillingFilter`	`Filter`	Fill holes in depth images
`NoiseRemovalFilter`	`Filter`	Remove noise from depth images
`PointCloudFilter`	`Filter`	Generate point cloud from depth
`SequenceIdFilter`	`Filter`	Filter by sequence ID
`SpatialAdvancedFilter`	`Filter`	Advanced spatial filtering
`TemporalFilter`	`Filter`	Temporal noise reduction
`ThresholdFilter`	`Filter`	Threshold-based filtering

6.5.3. Classes

6.5.3.1. Filter

class pyorbbecsdk.Filter

Bases: pybind11_object

__init__(*args, **kwargs)

enable(self: pyorbbecsdk.Filter, arg0: bool) → None

get_config_schema_vec(self: pyorbbecsdk.Filter) → list[pyorbbecsdk.OBFilterConfigSchemaItem]

get_config_value(self: pyorbbecsdk.Filter, arg0: str) → float

get_name(self: pyorbbecsdk.Filter) → str

is_align_filter(self: pyorbbecsdk.Filter) → bool

is_decimation_filter(self: pyorbbecsdk.Filter) → bool

is_disparity_transform_filter(self: pyorbbecsdk.Filter) → bool

is_edge_noise_removal_filter(self: pyorbbecsdk.Filter) → bool

is_enabled(self: pyorbbecsdk.Filter) → bool

is_format_converter(self: pyorbbecsdk.Filter) → bool

is_hdr_merge_filter(self: pyorbbecsdk.Filter) → bool

is_hole_filling_filter(self: pyorbbecsdk.Filter) → bool

is_noise_removal_filter(self: pyorbbecsdk.Filter) → bool

is_point_cloud_filter(self: pyorbbecsdk.Filter) → bool

is_sequence_id_filter(self: pyorbbecsdk.Filter) → bool

is_spatial_advanced_filter(self: pyorbbecsdk.Filter) → bool

is_temporal_filter(self: pyorbbecsdk.Filter) → bool

is_threshold_filter(self: pyorbbecsdk.Filter) → bool

process(self: pyorbbecsdk.Filter, arg0: pyorbbecsdk.Frame) → object

push_frame(self: pyorbbecsdk.Filter, arg0: pyorbbecsdk.Frame) → None

reset(self: pyorbbecsdk.Filter) → None

set_callback(self: pyorbbecsdk.Filter, arg0: collections.abc.Callable) → None

set_config_value(self: pyorbbecsdk.Filter, arg0: str, arg1: SupportsFloat | SupportsIndex) → None

6.5.3.2. AlignFilter

class pyorbbecsdk.AlignFilter

Bases: Filter

__init__(self: pyorbbecsdk.AlignFilter, align_to_stream: pyorbbecsdk.OBStreamType) → None

get_align_to_stream_type(self: pyorbbecsdk.AlignFilter) → pyorbbecsdk.OBStreamType

6.5.3.3. DecimationFilter

class pyorbbecsdk.DecimationFilter

Bases: Filter

__init__(self: pyorbbecsdk.DecimationFilter) → None

get_scale_range(self: pyorbbecsdk.DecimationFilter) → pyorbbecsdk.OBUint8PropertyRange

get_scale_value(self: pyorbbecsdk.DecimationFilter) → int

set_scale_value(self: pyorbbecsdk.DecimationFilter, arg0: SupportsInt | SupportsIndex) → None

6.5.3.4. DisparityTransform

class pyorbbecsdk.DisparityTransform

Bases: Filter

__init__(self: pyorbbecsdk.DisparityTransform, activationKey: str = '') → None

6.5.3.5. FormatConvertFilter

class pyorbbecsdk.FormatConvertFilter

Bases: Filter

__init__(self: pyorbbecsdk.FormatConvertFilter) → None

set_format_convert_format(self: pyorbbecsdk.FormatConvertFilter, arg0: pyorbbecsdk.OBConvertFormat) → None: Set the format to convert to

6.5.3.6. HDRMergeFilter

class pyorbbecsdk.HDRMergeFilter

Bases: Filter

__init__(self: pyorbbecsdk.HDRMergeFilter) → None

6.5.3.7. HoleFillingFilter

class pyorbbecsdk.HoleFillingFilter

Bases: Filter

__init__(self: pyorbbecsdk.HoleFillingFilter) → None

get_filling_mode(self: pyorbbecsdk.HoleFillingFilter) → pyorbbecsdk.OBHoleFillingMode

set_filling_mode(self: pyorbbecsdk.HoleFillingFilter, arg0: pyorbbecsdk.OBHoleFillingMode) → None: Set the filling mode

6.5.3.8. NoiseRemovalFilter

class pyorbbecsdk.NoiseRemovalFilter

Bases: Filter

__init__(self: pyorbbecsdk.NoiseRemovalFilter) → None

get_disp_diff_range(self: pyorbbecsdk.NoiseRemovalFilter) → pyorbbecsdk.OBUint16PropertyRange

get_filter_params(self: pyorbbecsdk.NoiseRemovalFilter) → pyorbbecsdk.OBNoiseRemovalFilterParams

get_max_size_range(self: pyorbbecsdk.NoiseRemovalFilter) → pyorbbecsdk.OBUint16PropertyRange

set_filter_params(self: pyorbbecsdk.NoiseRemovalFilter, arg0: pyorbbecsdk.OBNoiseRemovalFilterParams) → None

6.5.3.9. PointCloudFilter

class pyorbbecsdk.PointCloudFilter

Bases: Filter

__init__(self: pyorbbecsdk.PointCloudFilter) → None

calculate(self: pyorbbecsdk.PointCloudFilter, arg0: pyorbbecsdk.Frame) → numpy.typing.NDArray[numpy.float32]

get_decimation_factor_range(self: pyorbbecsdk.PointCloudFilter) → pyorbbecsdk.OBIntPropertyRange

set_camera_param(self: pyorbbecsdk.PointCloudFilter, arg0: pyorbbecsdk.OBCameraParam) → None

set_color_data_normalization(self: pyorbbecsdk.PointCloudFilter, arg0: bool) → None

set_create_point_format(self: pyorbbecsdk.PointCloudFilter, arg0: pyorbbecsdk.OBFormat) → None

set_decimation_factor(self: pyorbbecsdk.PointCloudFilter, arg0: SupportsInt | SupportsIndex) → None

set_frame_align_state(self: pyorbbecsdk.PointCloudFilter, arg0: bool) → None

set_position_data_scaled(self: pyorbbecsdk.PointCloudFilter, arg0: SupportsFloat | SupportsIndex) → None

6.5.3.10. SequenceIdFilter

class pyorbbecsdk.SequenceIdFilter

Bases: Filter

__init__(self: pyorbbecsdk.SequenceIdFilter) → None

get_select_sequence_id(self: pyorbbecsdk.SequenceIdFilter) → int

get_sequence_id_list(self: pyorbbecsdk.SequenceIdFilter) → list

get_sequence_id_list_size(self: pyorbbecsdk.SequenceIdFilter) → int

select_sequence_id(self: pyorbbecsdk.SequenceIdFilter, arg0: SupportsInt | SupportsIndex) → None

6.5.3.11. SpatialAdvancedFilter

class pyorbbecsdk.SpatialAdvancedFilter

Bases: Filter

__init__(self: pyorbbecsdk.SpatialAdvancedFilter) → None

get_alpha_range(self: pyorbbecsdk.SpatialAdvancedFilter) → pyorbbecsdk.OBFloatPropertyRange: get alpha range

get_disp_diff_range(self: pyorbbecsdk.SpatialAdvancedFilter) → pyorbbecsdk.OBUint16PropertyRange

get_filter_params(self: pyorbbecsdk.SpatialAdvancedFilter) → pyorbbecsdk.OBSpatialAdvancedFilterParams

get_magnitude_range(self: pyorbbecsdk.SpatialAdvancedFilter) → pyorbbecsdk.OBIntPropertyRange

get_radius_range(self: pyorbbecsdk.SpatialAdvancedFilter) → pyorbbecsdk.OBUint16PropertyRange

set_filter_params(self: pyorbbecsdk.SpatialAdvancedFilter, arg0: pyorbbecsdk.OBSpatialAdvancedFilterParams) → None

6.5.3.12. TemporalFilter

class pyorbbecsdk.TemporalFilter

Bases: Filter

__init__(self: pyorbbecsdk.TemporalFilter) → None

get_diff_scale_range(self: pyorbbecsdk.TemporalFilter) → pyorbbecsdk.OBFloatPropertyRange: get diff scale range

get_weight_range(self: pyorbbecsdk.TemporalFilter) → pyorbbecsdk.OBFloatPropertyRange: get weight range

set_diff_scale(self: pyorbbecsdk.TemporalFilter, arg0: SupportsFloat | SupportsIndex) → None: set diff scale

set_weight(self: pyorbbecsdk.TemporalFilter, arg0: SupportsFloat | SupportsIndex) → None

6.5.3.13. ThresholdFilter

class pyorbbecsdk.ThresholdFilter

Bases: Filter

__init__(self: pyorbbecsdk.ThresholdFilter) → None

get_max_range(self: pyorbbecsdk.ThresholdFilter) → pyorbbecsdk.OBIntPropertyRange

get_min_range(self: pyorbbecsdk.ThresholdFilter) → pyorbbecsdk.OBIntPropertyRange

set_value_range(self: pyorbbecsdk.ThresholdFilter, arg0: SupportsInt | SupportsIndex, arg1: SupportsInt | SupportsIndex) → bool

6.5.4. Enumerations

6.5.4.1. OBFilterList

class pyorbbecsdk.OBFilterList

Bases: pybind11_object

__init__(*args, **kwargs)

get_count(self: pyorbbecsdk.OBFilterList) → int

get_filter(self: pyorbbecsdk.OBFilterList, arg0: SupportsInt | SupportsIndex) → pyorbbecsdk.Filter

6.5.4.2. OBFilterConfigSchemaItem

class pyorbbecsdk.OBFilterConfigSchemaItem

Bases: pybind11_object

__init__(self: pyorbbecsdk.OBFilterConfigSchemaItem) → None

property default

property desc

property max

property min

property name

property step

property type

6.5.4.3. OBFilterConfigValueType

class pyorbbecsdk.OBFilterConfigValueType

Bases: pybind11_object

OBFilterConfigValueType Members
Name	C++ Binding Object	Value	Description
`BOOLEAN`	`<OBFilterConfigValueType.BOOLEAN: 2>`	2	Auto-generated from C++ bindings
`FLOAT`	`<OBFilterConfigValueType.FLOAT: 1>`	1	Auto-generated from C++ bindings
`INT`	`<OBFilterConfigValueType.INT: 0>`	0	Auto-generated from C++ bindings
`INVALID`	`<OBFilterConfigValueType.INVALID: -1>`	-1	Auto-generated from C++ bindings

6.5.4.4. OBHoleFillingMode

class pyorbbecsdk.OBHoleFillingMode

Bases: pybind11_object

OBHoleFillingMode Members
Name	C++ Binding Object	Value	Description
`FURTHEST`	`<OBHoleFillingMode.FURTHEST: 2>`	2	Auto-generated from C++ bindings
`NEAREST`	`<OBHoleFillingMode.NEAREST: 1>`	1	Auto-generated from C++ bindings
`TOP`	`<OBHoleFillingMode.TOP: 0>`	0	Auto-generated from C++ bindings

6.5.4.5. OBNoiseRemovalFilterParams

class pyorbbecsdk.OBNoiseRemovalFilterParams

Bases: pybind11_object

__init__(self: pyorbbecsdk.OBNoiseRemovalFilterParams) → None

property disp_diff

property max_size

property type

6.5.4.6. OBEdgeNoiseRemovalType

class pyorbbecsdk.OBEdgeNoiseRemovalType

Bases: pybind11_object

OBEdgeNoiseRemovalType Members
Name	C++ Binding Object	Value	Description
`MGA_FILTER`	`<OBEdgeNoiseRemovalType.MGA_FILTER: 2>`	2	Auto-generated from C++ bindings
`MGC_FILTER`	`<OBEdgeNoiseRemovalType.MGC_FILTER: 3>`	3	Auto-generated from C++ bindings
`MGH_FILTER`	`<OBEdgeNoiseRemovalType.MGH_FILTER: 1>`	1	Auto-generated from C++ bindings
`MG_FILTER`	`<OBEdgeNoiseRemovalType.MG_FILTER: 0>`	0	Auto-generated from C++ bindings

6.5.4.7. OBEdgeNoiseRemovalFilterParams

class pyorbbecsdk.OBEdgeNoiseRemovalFilterParams

Bases: pybind11_object

__init__(self: pyorbbecsdk.OBEdgeNoiseRemovalFilterParams) → None

property enable_direction

property height

property limit_x_th

property limit_y_th

property margin_x_th

property margin_y_th

property width

6.5.4.8. OBDDONoiseRemovalType

class pyorbbecsdk.OBDDONoiseRemovalType

Bases: pybind11_object

OBDDONoiseRemovalType Members
Name	C++ Binding Object	Value	Description
`LUT`	`<OBDDONoiseRemovalType.LUT: 0>`	0	Auto-generated from C++ bindings
`OVERALL`	`<OBDDONoiseRemovalType.OVERALL: 1>`	1	Auto-generated from C++ bindings

6.5.4.9. OBSpatialAdvancedFilterParams

class pyorbbecsdk.OBSpatialAdvancedFilterParams

Bases: pybind11_object

__init__(self: pyorbbecsdk.OBSpatialAdvancedFilterParams) → None

property alpha

property disp_diff

property magnitude

property radius

6.5.4.10. OBConvertFormat

class pyorbbecsdk.OBConvertFormat

Bases: pybind11_object

OBConvertFormat Members
Name	C++ Binding Object	Value	Description
`BGR_TO_RGB`	`<OBConvertFormat.BGR_TO_RGB: 11>`	11	Auto-generated from C++ bindings
`I420_TO_RGB888`	`<OBConvertFormat.I420_TO_RGB888: 1>`	1	Auto-generated from C++ bindings
`MJPG_TO_BGR888`	`<OBConvertFormat.MJPG_TO_BGR888: 8>`	8	Auto-generated from C++ bindings
`MJPG_TO_BGRA`	`<OBConvertFormat.MJPG_TO_BGRA: 9>`	9	Auto-generated from C++ bindings
`MJPG_TO_I420`	`<OBConvertFormat.MJPG_TO_I420: 4>`	4	Auto-generated from C++ bindings
`MJPG_TO_NV21`	`<OBConvertFormat.MJPG_TO_NV21: 6>`	6	Auto-generated from C++ bindings
`MJPG_TO_RGB888`	`<OBConvertFormat.MJPG_TO_RGB888: 7>`	7	Auto-generated from C++ bindings
`NV12_TO_RGB888`	`<OBConvertFormat.NV12_TO_RGB888: 3>`	3	Auto-generated from C++ bindings
`NV21_TO_RGB888`	`<OBConvertFormat.NV21_TO_RGB888: 2>`	2	Auto-generated from C++ bindings
`RGB888_TO_BGR`	`<OBConvertFormat.RGB888_TO_BGR: 5>`	5	Auto-generated from C++ bindings
`UYVY_TO_RGB888`	`<OBConvertFormat.UYVY_TO_RGB888: 10>`	10	Auto-generated from C++ bindings
`YUYV_TO_RGB888`	`<OBConvertFormat.YUYV_TO_RGB888: 0>`	0	Auto-generated from C++ bindings