| OrbbecSDK 1.10.18 OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras

Loading...
Searching...
No Matches
Filter.h
Go to the documentation of this file.
1
5#pragma once
6
7#ifdef __cplusplus
8 extern "C" {
9#endif
10
11#include "ObTypes.h"
12
20 ob_filter *ob_create_pointcloud_filter(ob_error **error);
21
29 void ob_pointcloud_filter_set_camera_param(ob_filter *filter, ob_camera_param param, ob_error **error);
30
38 void ob_pointcloud_filter_set_point_format(ob_filter *filter, ob_format type, ob_error **error);
39
47 void ob_pointcloud_filter_set_frame_align_state(ob_filter *filter, bool state, ob_error **error);
48
59 void ob_pointcloud_filter_set_position_data_scale(ob_filter *filter, float scale, ob_error **error);
60
68 void ob_pointcloud_filter_set_color_data_normalization(ob_filter *filter, bool state, ob_error **error);
69
77 void ob_pointcloud_filter_set_coordinate_system(ob_filter *filter, ob_coordinate_system_type type, ob_error **error);
78
86 ob_filter *ob_create_format_convert_filter(ob_error **error);
87
95 void ob_format_convert_filter_set_format(ob_filter *filter, ob_convert_format type, ob_error **error);
96
104 ob_filter *ob_create_compression_filter(ob_error **error);
105
114 void ob_compression_filter_set_compression_params(ob_filter *filter, ob_compression_mode mode, void *params, ob_error **error);
115
123 ob_filter *ob_create_decompression_filter(ob_error **error);
124
132 ob_filter *ob_create_holefilling_filter(ob_error **error);
133
141 void ob_holefilling_filter_set_mode(ob_filter *filter, ob_hole_filling_mode mode, ob_error **error);
142
150 ob_hole_filling_mode ob_holefilling_filter_get_mode(ob_filter *filter, ob_error **error);
151
159 ob_filter *ob_create_temporal_filter(ob_error **error);
160
168 ob_float_property_range ob_temporal_filter_get_diffscale_range(ob_filter *filter, ob_error **error);
169
177 void ob_temporal_filter_set_diffscale_value(ob_filter *filter, float value, ob_error **error);
178
185 ob_float_property_range ob_temporal_filter_get_weight_range(ob_filter *filter, ob_error **error);
186
194 void ob_temporal_filter_set_weight_value(ob_filter *filter, float value, ob_error **error);
195
201 ob_filter *ob_create_spatial_advanced_filter(ob_error **error);
202
210 ob_float_property_range ob_spatial_advanced_filter_get_alpha_range(ob_filter *filter, ob_error **error);
211
219 ob_uint16_property_range ob_spatial_advanced_filter_get_disp_diff_range(ob_filter *filter, ob_error **error);
220
228 ob_uint16_property_range ob_spatial_advanced_filter_get_radius_range(ob_filter *filter, ob_error **error);
229
237 ob_int_property_range ob_spatial_advanced_filter_get_magnitude_range(ob_filter *filter, ob_error **error);
238
246 ob_spatial_advanced_filter_params ob_spatial_advanced_filter_get_filter_params(ob_filter *filter, ob_error **error);
247
255 void ob_spatial_advanced_filter_set_filter_params(ob_filter *filter, ob_spatial_advanced_filter_params params, ob_error **error);
256
262 ob_filter *ob_create_spatial_fast_filter(ob_error **error);
263
271 ob_uint8_property_range ob_spatial_fast_filter_get_size_range(ob_filter *filter, ob_error **error);
272
280 void ob_spatial_fast_filter_set_filter_params(ob_filter *filter, ob_spatial_fast_filter_params params, ob_error **error);
281
289 ob_spatial_fast_filter_params ob_spatial_fast_filter_get_filter_params(ob_filter *filter, ob_error **error);
290
296 ob_filter *ob_create_spatial_moderate_filter(ob_error **error);
304 ob_uint16_property_range ob_spatial_moderate_filter_get_disp_diff_range(ob_filter *filter, ob_error **error);
312 ob_uint8_property_range ob_spatial_moderate_filter_get_magnitude_range(ob_filter *filter, ob_error **error);
320 ob_uint8_property_range ob_spatial_moderate_filter_get_size_range(ob_filter *filter, ob_error **error);
328 ob_spatial_moderate_filter_params ob_spatial_moderate_filter_get_filter_params(ob_filter *filter, ob_error **error);
336 void ob_spatial_moderate_filter_set_filter_params(ob_filter *filter, ob_spatial_moderate_filter_params params, ob_error **error);
337
343 ob_filter *ob_create_noise_removal_filter(ob_error **error);
344
352 ob_uint16_property_range ob_noise_removal_filter_get_disp_diff_range(ob_filter *filter, ob_error **error);
353
361 ob_int_property_range ob_noise_removal_filter_get_max_size_range(ob_filter *filter, ob_error **error);
362
370 void ob_noise_removal_filter_set_filter_params(ob_filter *filter, ob_noise_removal_filter_params params, ob_error **error);
371
379 ob_noise_removal_filter_params ob_noise_removal_filter_get_filter_params(ob_filter *filter, ob_error **error);
380
386 ob_filter *ob_create_edge_noise_removal_filter(ob_error **error);
387
395 void ob_edge_noise_removal_filter_set_filter_params(ob_filter *filter, ob_edge_noise_removal_filter_params params, ob_error **error);
396
404 ob_edge_noise_removal_filter_params ob_edge_noise_removal_filter_get_filter_params(ob_filter *filter, ob_error **error);
405
406
414 ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_left_th_range(ob_filter *filter, ob_error **error);
415
423 ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_right_th_range(ob_filter *filter, ob_error **error);
424
432 ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_top_th_range(ob_filter *filter, ob_error **error);
433
441 ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_bottom_th_range(ob_filter *filter, ob_error **error);
442
443
449 ob_filter *ob_create_decimation_filter(ob_error **error);
450
457 ob_uint8_property_range ob_decimation_filter_get_scale_range(ob_filter *filter, ob_error **error);
458
466 void ob_decimation_filter_set_scale_value(ob_filter *filter, uint8_t value, ob_error **error);
467
475uint8_t ob_decimation_filter_get_scale_value(ob_filter *filter, ob_error **error);
476
482 ob_filter *ob_create_threshold_filter(ob_error **error);
483
490 ob_int_property_range ob_threshold_filter_get_min_range(ob_filter *filter, ob_error **error);
491
498 ob_int_property_range ob_threshold_filter_get_max_range(ob_filter *filter, ob_error **error);
499
508 bool ob_threshold_filter_set_scale_value(ob_filter *filter, uint16_t min, uint16_t max, ob_error **error);
509
515 ob_filter *ob_create_sequenceId_filter(ob_error **error);
516
524 void ob_sequence_id_filter_select_sequence_id(ob_filter *filter, int sequence_id, ob_error **error);
525
533 int ob_sequence_id_filter_get_sequence_id(ob_filter *filter, ob_error **error);
534
535
542 ob_sequence_id_item *ob_sequence_id_filter_get_sequence_id_list(ob_filter *filter, ob_error **error);
543
550 int ob_sequence_id_filter_get_sequence_id_list_size(ob_filter *filter, ob_error **error);
551
557 ob_filter *ob_create_hdr_merge(ob_error **error);
558
565 ob_filter *ob_create_align(ob_error **error, ob_stream_type align_to_stream);
566
574 ob_stream_type ob_align_get_to_stream_type(ob_filter *filter, ob_error **error);
575
582 ob_filter *ob_create_disparity_transform(ob_error **error, bool depth_to_disparity);
583
591 void ob_filter_reset(ob_filter *filter, ob_error **error);
592
602 ob_frame *ob_filter_process(ob_filter *filter, ob_frame *frame, ob_error **error);
603
611 void ob_filter_enable(ob_filter *filter, bool enable, ob_error **error);
612
621 bool ob_filter_is_enable(ob_filter *filter, ob_error **error);
622
631 void ob_filter_set_callback(ob_filter *filter, ob_filter_callback callback, void *user_data, ob_error **error);
632
640 void ob_filter_push_frame(ob_filter *filter, ob_frame *frame, ob_error **error);
641
648 void ob_delete_filter(ob_filter *filter, ob_error **error);
649
650#ifdef __cplusplus
651}
652#endif
ob_threshold_filter_get_max_range
ob_int_property_range ob_threshold_filter_get_max_range(ob_filter *filter, ob_error **error)
Get the threshold filter max range.
ob_spatial_moderate_filter_get_size_range
ob_uint8_property_range ob_spatial_moderate_filter_get_size_range(ob_filter *filter, ob_error **error)
Get the spatial moderate filter window size range.
ob_align_get_to_stream_type
ob_stream_type ob_align_get_to_stream_type(ob_filter *filter, ob_error **error)
Get the algin stream type.
ob_threshold_filter_set_scale_value
bool ob_threshold_filter_set_scale_value(ob_filter *filter, uint16_t min, uint16_t max, ob_error **error)
Set the threshold filter scale range.
ob_edge_noise_removal_filter_get_margin_bottom_th_range
ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_bottom_th_range(ob_filter *filter, ob_error **error)
Get the noise removal filter margin bottom th range.
ob_spatial_advanced_filter_get_alpha_range
ob_float_property_range ob_spatial_advanced_filter_get_alpha_range(ob_filter *filter, ob_error **error)
Get the spatial advanced filter alpha range.
ob_temporal_filter_get_weight_range
ob_float_property_range ob_temporal_filter_get_weight_range(ob_filter *filter, ob_error **error)
Get the TemporalFilter weight range.
ob_create_noise_removal_filter
ob_filter * ob_create_noise_removal_filter(ob_error **error)
Create a noise removal filter.
ob_create_threshold_filter
ob_filter * ob_create_threshold_filter(ob_error **error)
Create a threshold filter.
ob_edge_noise_removal_filter_get_filter_params
ob_edge_noise_removal_filter_params ob_edge_noise_removal_filter_get_filter_params(ob_filter *filter, ob_error **error)
Get the edge noise removal filter params.
ob_pointcloud_filter_set_position_data_scale
void ob_pointcloud_filter_set_position_data_scale(ob_filter *filter, float scale, ob_error **error)
Set the point cloud data scaling factor.
ob_sequence_id_filter_get_sequence_id_list_size
int ob_sequence_id_filter_get_sequence_id_list_size(ob_filter *filter, ob_error **error)
Get the current sequence id list size.
ob_spatial_fast_filter_get_size_range
ob_uint8_property_range ob_spatial_fast_filter_get_size_range(ob_filter *filter, ob_error **error)
Get the spatial fast filter window size range.
ob_threshold_filter_get_min_range
ob_int_property_range ob_threshold_filter_get_min_range(ob_filter *filter, ob_error **error)
Get the threshold filter min range.
ob_spatial_advanced_filter_get_magnitude_range
ob_int_property_range ob_spatial_advanced_filter_get_magnitude_range(ob_filter *filter, ob_error **error)
Get the spatial advanced filter magnitude range.
ob_holefilling_filter_get_mode
ob_hole_filling_mode ob_holefilling_filter_get_mode(ob_filter *filter, ob_error **error)
Get the HoleFillingFilter mode.
ob_pointcloud_filter_set_frame_align_state
void ob_pointcloud_filter_set_frame_align_state(ob_filter *filter, bool state, ob_error **error)
Set the alignment state of the frames that will be input to produce the point cloud.
ob_create_temporal_filter
ob_filter * ob_create_temporal_filter(ob_error **error)
Create a Temporal Filter.
ob_create_decompression_filter
ob_filter * ob_create_decompression_filter(ob_error **error)
Create a decompression Filter.
ob_temporal_filter_set_diffscale_value
void ob_temporal_filter_set_diffscale_value(ob_filter *filter, float value, ob_error **error)
Set the TemporalFilter diffscale value.
ob_spatial_fast_filter_get_filter_params
ob_spatial_fast_filter_params ob_spatial_fast_filter_get_filter_params(ob_filter *filter, ob_error **error)
Get the spatial fast filter params.
ob_spatial_advanced_filter_get_disp_diff_range
ob_uint16_property_range ob_spatial_advanced_filter_get_disp_diff_range(ob_filter *filter, ob_error **error)
Get the spatial advanced filter disp diff range.
ob_holefilling_filter_set_mode
void ob_holefilling_filter_set_mode(ob_filter *filter, ob_hole_filling_mode mode, ob_error **error)
Set the HoleFillingFilter mode.
ob_create_spatial_moderate_filter
ob_filter * ob_create_spatial_moderate_filter(ob_error **error)
Create a spatial moderate filter.
ob_create_spatial_fast_filter
ob_filter * ob_create_spatial_fast_filter(ob_error **error)
Create a spatial fast filter.
ob_spatial_advanced_filter_set_filter_params
void ob_spatial_advanced_filter_set_filter_params(ob_filter *filter, ob_spatial_advanced_filter_params params, ob_error **error)
Set the spatial advanced filter params.
ob_filter_enable
void ob_filter_enable(ob_filter *filter, bool enable, ob_error **error)
Enable the frame post processing.
ob_create_disparity_transform
ob_filter * ob_create_disparity_transform(ob_error **error, bool depth_to_disparity)
Create a disparity transform.
ob_pointcloud_filter_set_color_data_normalization
void ob_pointcloud_filter_set_color_data_normalization(ob_filter *filter, bool state, ob_error **error)
Set the point cloud color data normalization.
ob_delete_filter
void ob_delete_filter(ob_filter *filter, ob_error **error)
Delete the filter.
ob_pointcloud_filter_set_coordinate_system
void ob_pointcloud_filter_set_coordinate_system(ob_filter *filter, ob_coordinate_system_type type, ob_error **error)
Set the point cloud coordinate system.
ob_spatial_advanced_filter_get_filter_params
ob_spatial_advanced_filter_params ob_spatial_advanced_filter_get_filter_params(ob_filter *filter, ob_error **error)
Get the spatial advanced filter params.
ob_create_format_convert_filter
ob_filter * ob_create_format_convert_filter(ob_error **error)
Create a format convert Filter.
ob_spatial_moderate_filter_get_magnitude_range
ob_uint8_property_range ob_spatial_moderate_filter_get_magnitude_range(ob_filter *filter, ob_error **error)
Get the spatial moderate filter magnitude range.
ob_filter_is_enable
bool ob_filter_is_enable(ob_filter *filter, ob_error **error)
Get the enable status of the frame post processing.
ob_filter_reset
void ob_filter_reset(ob_filter *filter, ob_error **error)
Reset the filter, clears the cache, and resets the state. If the asynchronous interface is used,...
ob_create_sequenceId_filter
ob_filter * ob_create_sequenceId_filter(ob_error **error)
Create a SequenceId filter.
ob_spatial_moderate_filter_set_filter_params
void ob_spatial_moderate_filter_set_filter_params(ob_filter *filter, ob_spatial_moderate_filter_params params, ob_error **error)
Set the spatial moderate filter params.
ob_decimation_filter_get_scale_range
ob_uint8_property_range ob_decimation_filter_get_scale_range(ob_filter *filter, ob_error **error)
Get the decimation filter scale range.
ob_decimation_filter_set_scale_value
void ob_decimation_filter_set_scale_value(ob_filter *filter, uint8_t value, ob_error **error)
Set the decimation filter scale value.
ob_sequence_id_filter_select_sequence_id
void ob_sequence_id_filter_select_sequence_id(ob_filter *filter, int sequence_id, ob_error **error)
Set the sequence id filter select sequence id.
ob_pointcloud_filter_set_camera_param
void ob_pointcloud_filter_set_camera_param(ob_filter *filter, ob_camera_param param, ob_error **error)
Set the camera parameters for the PointCloud Filter.
ob_create_pointcloud_filter
ob_filter * ob_create_pointcloud_filter(ob_error **error)
Create a PointCloud Filter.
ob_spatial_moderate_filter_get_disp_diff_range
ob_uint16_property_range ob_spatial_moderate_filter_get_disp_diff_range(ob_filter *filter, ob_error **error)
Get the spatial moderate filter disp diff range.
ob_create_edge_noise_removal_filter
ob_filter * ob_create_edge_noise_removal_filter(ob_error **error)
Create a edge noise removal filter.
ob_filter_push_frame
void ob_filter_push_frame(ob_filter *filter, ob_frame *frame, ob_error **error)
Push the frame into the pending cache for the filter (asynchronous callback interface).
ob_create_holefilling_filter
ob_filter * ob_create_holefilling_filter(ob_error **error)
Create a HoleFilling Filter.
ob_spatial_fast_filter_set_filter_params
void ob_spatial_fast_filter_set_filter_params(ob_filter *filter, ob_spatial_fast_filter_params params, ob_error **error)
Set the spatial fast filter params.
ob_noise_removal_filter_set_filter_params
void ob_noise_removal_filter_set_filter_params(ob_filter *filter, ob_noise_removal_filter_params params, ob_error **error)
Set the noise removal filter params.
ob_create_compression_filter
ob_filter * ob_create_compression_filter(ob_error **error)
Create a compression Filter.
ob_decimation_filter_get_scale_value
uint8_t ob_decimation_filter_get_scale_value(ob_filter *filter, ob_error **error)
Get the decimation filter scale value.
ob_spatial_moderate_filter_get_filter_params
ob_spatial_moderate_filter_params ob_spatial_moderate_filter_get_filter_params(ob_filter *filter, ob_error **error)
Get the spatial moderate filter params.
ob_sequence_id_filter_get_sequence_id
int ob_sequence_id_filter_get_sequence_id(ob_filter *filter, ob_error **error)
Get the current sequence id.
ob_create_align
ob_filter * ob_create_align(ob_error **error, ob_stream_type align_to_stream)
Create a align.
ob_temporal_filter_get_diffscale_range
ob_float_property_range ob_temporal_filter_get_diffscale_range(ob_filter *filter, ob_error **error)
Get the TemporalFilter diffscale range.
ob_sequence_id_filter_get_sequence_id_list
ob_sequence_id_item * ob_sequence_id_filter_get_sequence_id_list(ob_filter *filter, ob_error **error)
Get the current sequence id list.
ob_edge_noise_removal_filter_get_margin_left_th_range
ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_left_th_range(ob_filter *filter, ob_error **error)
Get the noise removal filter margin left th range.
ob_edge_noise_removal_filter_get_margin_top_th_range
ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_top_th_range(ob_filter *filter, ob_error **error)
Get the noise removal filter margin top th range.
ob_temporal_filter_set_weight_value
void ob_temporal_filter_set_weight_value(ob_filter *filter, float value, ob_error **error)
Set the TemporalFilter weight range.
ob_noise_removal_filter_get_disp_diff_range
ob_uint16_property_range ob_noise_removal_filter_get_disp_diff_range(ob_filter *filter, ob_error **error)
Get the noise removal filter disp diff range.
ob_filter_set_callback
void ob_filter_set_callback(ob_filter *filter, ob_filter_callback callback, void *user_data, ob_error **error)
Set the processing result callback function for the filter (asynchronous callback interface).
ob_noise_removal_filter_get_filter_params
ob_noise_removal_filter_params ob_noise_removal_filter_get_filter_params(ob_filter *filter, ob_error **error)
Get the noise removal filter params.
ob_pointcloud_filter_set_point_format
void ob_pointcloud_filter_set_point_format(ob_filter *filter, ob_format type, ob_error **error)
Set the point cloud type parameters for the PointCloud Filter.
ob_create_hdr_merge
ob_filter * ob_create_hdr_merge(ob_error **error)
Create a hdr merge.
ob_spatial_advanced_filter_get_radius_range
ob_uint16_property_range ob_spatial_advanced_filter_get_radius_range(ob_filter *filter, ob_error **error)
Get the spatial advanced filter radius range.
ob_create_spatial_advanced_filter
ob_filter * ob_create_spatial_advanced_filter(ob_error **error)
Create a spatial advanced filter.
ob_compression_filter_set_compression_params
void ob_compression_filter_set_compression_params(ob_filter *filter, ob_compression_mode mode, void *params, ob_error **error)
Set the compression parameters for the compression Filter.
ob_format_convert_filter_set_format
void ob_format_convert_filter_set_format(ob_filter *filter, ob_convert_format type, ob_error **error)
Set the type of format conversion for the format convert Filter.
ob_filter_process
ob_frame * ob_filter_process(ob_filter *filter, ob_frame *frame, ob_error **error)
Process the frame (synchronous interface).
ob_create_decimation_filter
ob_filter * ob_create_decimation_filter(ob_error **error)
Create a decimation filter.
ob_edge_noise_removal_filter_get_margin_right_th_range
ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_right_th_range(ob_filter *filter, ob_error **error)
Get the noise removal filter margin right th range.
ob_edge_noise_removal_filter_set_filter_params
void ob_edge_noise_removal_filter_set_filter_params(ob_filter *filter, ob_edge_noise_removal_filter_params params, ob_error **error)
Set the edge noise removal filter params.
ob_noise_removal_filter_get_max_size_range
ob_int_property_range ob_noise_removal_filter_get_max_size_range(ob_filter *filter, ob_error **error)
Get the noise removal filter max size range.
ObTypes.h
Provide structs commonly used in the SDK, enumerating constant definitions.
ob_format
enum OBFormat ob_format
ob_frame
struct CFrameImpl ob_frame
Definition ObTypes.h:63
ob_compression_mode
enum OBCompressionMode ob_compression_mode
ob_hole_filling_mode
enum OBHoleFillingMode ob_hole_filling_mode
ob_coordinate_system_type
enum OB_COORDINATE_SYSTEM_TYPE ob_coordinate_system_type
ob_convert_format
enum OBConvertFormat ob_convert_format
ob_filter_callback
#define ob_filter_callback
Definition ObTypes.h:1759
ob_stream_type
enum OBStreamType ob_stream_type
ob_filter
struct FilterImpl ob_filter
Definition ObTypes.h:64
OBCameraParam
Structure for camera parameters.
Definition ObTypes.h:462
OBEdgeNoiseRemovalFilterParams
Definition ObTypes.h:1011
OBFloatPropertyRange
Structure for float range.
Definition ObTypes.h:336
OBIntPropertyRange
Structure for integer range.
Definition ObTypes.h:325
OBNoiseRemovalFilterParams
Definition ObTypes.h:1028
OBSequenceIdItem
SequenceId fliter list item.
Definition ObTypes.h:969
OBSpatialAdvancedFilterParams
Definition ObTypes.h:984
OBSpatialFastFilterParams
Definition ObTypes.h:992
OBSpatialModerateFilterParams
Definition ObTypes.h:997
OBUint16PropertyRange
Structure for float range.
Definition ObTypes.h:347
OBUint8PropertyRange
Structure for float range.
Definition ObTypes.h:358
ob_error
The error class exposed by the SDK, users can get detailed error information according to the error.
Definition ObTypes.h:151