OrbbecSDK  1.5.7
OrbbecSDK: Software-Development-Kit for Orbbec 3D-Sensor devices
Functions
Filter.h File Reference

The processing unit of the SDK can perform point cloud generation, format conversion and other functions. More...

#include "ObTypes.h"

Go to the source code of this file.

Functions

ob_filterob_create_pointcloud_filter (ob_error **error)
 Create PointCloud Filter. More...
 
void ob_pointcloud_filter_set_camera_param (ob_filter *filter, ob_camera_param param, ob_error **error)
 PointCloud Filter device camera parameters. More...
 
void ob_pointcloud_filter_set_point_format (ob_filter *filter, ob_format type, ob_error **error)
 Set point cloud type parameters. More...
 
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. More...
 
void ob_pointcloud_filter_set_position_data_scale (ob_filter *filter, float scale, ob_error **error)
 Set the point cloud data scaling factor. More...
 
void ob_pointcloud_filter_set_color_data_normalization (ob_filter *filter, bool state, ob_error **error)
 Set point cloud color data normalization. More...
 
ob_filterob_create_format_convert_filter (ob_error **error)
 Create FormatConvet Filter. More...
 
void ob_format_convert_filter_set_format (ob_filter *filter, ob_convert_format type, ob_error **error)
 Set the type of format conversion. More...
 
ob_filterob_create_compression_filter (ob_error **error)
 Create compression Filter. More...
 
void ob_compression_filter_set_compression_params (ob_filter *filter, ob_compression_mode mode, void *params, ob_error **error)
 Set compression parameters. More...
 
ob_filterob_create_decompression_filter (ob_error **error)
 Create decompression Filter. More...
 
void ob_filter_reset (ob_filter *filter, ob_error **error)
 Filter reset, cache clear, state reset. If the asynchronous interface is used, the processing thread will also be stopped and the pending cache frames will be cleared. More...
 
ob_frameob_filter_process (ob_filter *filter, ob_frame *frame, ob_error **error)
 Filter processing (synchronous interface) More...
 
void ob_filter_set_callback (ob_filter *filter, ob_filter_callback callback, void *user_data, ob_error **error)
 Filter Set the processing result callback function (asynchronous callback interface) More...
 
void ob_filter_push_frame (ob_filter *filter, ob_frame *frame, ob_error **error)
 filter Push the frame into the pending cache (asynchronous callback interface) More...
 
void ob_delete_filter (ob_filter *filter, ob_error **error)
 Delete Filter. More...
 

Detailed Description

The processing unit of the SDK can perform point cloud generation, format conversion and other functions.

Definition in file Filter.h.

Function Documentation

ob_filter* ob_create_pointcloud_filter ( ob_error **  error)

Create PointCloud Filter.

Parameters
[out]errorLog error messages
Returns
filter pointcloud_filter object
void ob_pointcloud_filter_set_camera_param ( ob_filter filter,
ob_camera_param  param,
ob_error **  error 
)

PointCloud Filter device camera parameters.

Parameters
[in]filterpointcloud_filter object
[in]paramCamera parameters
[out]errorLog error messages
void ob_pointcloud_filter_set_point_format ( ob_filter filter,
ob_format  type,
ob_error **  error 
)

Set point cloud type parameters.

Parameters
[in]filterpointcloud_filter object
[in]typePoint cloud type: depth point cloud or RGBD point cloud
[out]errorLog error messages
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.

Parameters
[in]filterpointcloud_filter object
[in]stateAlignment status, True: aligned; False: unaligned
[out]errorLog error messages
void ob_pointcloud_filter_set_position_data_scale ( ob_filter filter,
float  scale,
ob_error **  error 
)

Set the point cloud data scaling factor.

Attention
Calling this function to set the scale will change the point coordinate scaling factor of the output point cloud frame: posScale = posScale / scale.The point coordinate scaling factor for the output point cloud frame can be obtained via ob_points_frame_get_position_value_scale function
Parameters
[in]filterobject
[in]scaleSet the point cloud coordinate data zoom factor
[out]errorLog error messages
void ob_pointcloud_filter_set_color_data_normalization ( ob_filter filter,
bool  state,
ob_error **  error 
)

Set point cloud color data normalization.

Parameters
[in]filterobject
[in]stateSets whether the point cloud color data is normalized
[out]errorLog error messages
ob_filter* ob_create_format_convert_filter ( ob_error **  error)

Create FormatConvet Filter.

Parameters
[out]errorLog error messages
Returns
filter format_convert object
void ob_format_convert_filter_set_format ( ob_filter filter,
ob_convert_format  type,
ob_error **  error 
)

Set the type of format conversion.

Parameters
[in]filterformatconvet_filter object
[in]typeFormat conversion type
[out]errorLog error messages
ob_filter* ob_create_compression_filter ( ob_error **  error)

Create compression Filter.

Parameters
[out]errorLog error messages
Returns
filter depth_filter object
void ob_compression_filter_set_compression_params ( ob_filter filter,
ob_compression_mode  mode,
void *  params,
ob_error **  error 
)

Set compression parameters.

Parameters
[in]filtercompression_filter object
[in]modeCompression mode OB_COMPRESSION_LOSSLESS or OB_COMPRESSION_LOSSY
[in]paramsCompression params, struct ob_compression_params, when mode is OB_COMPRESSION_LOSSLESS, params is NULL
[out]errorLog error messages
ob_filter* ob_create_decompression_filter ( ob_error **  error)

Create decompression Filter.

Parameters
[out]errorLog error messages
Returns
filter decompression Filter object
void ob_filter_reset ( ob_filter filter,
ob_error **  error 
)

Filter reset, cache clear, state reset. If the asynchronous interface is used, the processing thread will also be stopped and the pending cache frames will be cleared.

Parameters
[in]filterfilter object
[out]errorLog error messages
ob_frame* ob_filter_process ( ob_filter filter,
ob_frame frame,
ob_error **  error 
)

Filter processing (synchronous interface)

Parameters
[in]filterfilter object
[in]framepointer to the frame object to be processed
[out]errorLog error messages
Returns
ob_frame The frame object processed by the filter
void ob_filter_set_callback ( ob_filter filter,
ob_filter_callback  callback,
void *  user_data,
ob_error **  error 
)

Filter Set the processing result callback function (asynchronous callback interface)

Parameters
[in]filterfilter object
[in]callback
[in]user_dataArbitrary user data pointer can be passed in and returned from the callback
[out]errorLog error messages
void ob_filter_push_frame ( ob_filter filter,
ob_frame frame,
ob_error **  error 
)

filter Push the frame into the pending cache (asynchronous callback interface)

Parameters
[in]filterfilter object
[out]errorLog error messages
void ob_delete_filter ( ob_filter filter,
ob_error **  error 
)

Delete Filter.

Parameters
[in]filterfilter object
[out]errorLog error messages