| OrbbecSDK 1.5.7 OrbbecSDK: Software-Development-Kit for Orbbec 3D-Sensor devices

- 首页
- 命名空间
- 类
- 文件

- 文件列表
- 文件成员

函数
Filter.h 文件参考

SDK的处理单元，可以进行点云的生成，格式转换等功能 更多...

`#include "ObTypes.h"`

浏览源代码.

## 函数
ob_filter * | ob_create_pointcloud_filter (ob_error **error)
| 创建PointCloud Filter 更多...
void | ob_pointcloud_filter_set_camera_param (ob_filter *filter, ob_camera_param param, ob_error **error)
| PointCloud Filter设备相机参数 更多...
void | ob_pointcloud_filter_set_point_format (ob_filter *filter, ob_format type, ob_error **error)
| 设置点云类型参数 更多...
void | ob_pointcloud_filter_set_frame_align_state (ob_filter *filter, bool state, ob_error **error)
| 设置将要输入用于生产点云的帧的对齐状态 更多...
void | ob_pointcloud_filter_set_position_data_scale (ob_filter *filter, float scale, ob_error **error)
| 设置点云数据缩放比例 更多...
void | ob_pointcloud_filter_set_color_data_normalization (ob_filter *filter, bool state, ob_error **error)
| 设置点云颜色数据归一化 更多...
ob_filter * | ob_create_format_convert_filter (ob_error **error)
| 创建FormatConvet Filter 更多...
void | ob_format_convert_filter_set_format (ob_filter *filter, ob_convert_format type, ob_error **error)
| 设置格式转化的类型 更多...
ob_filter * | ob_create_compression_filter (ob_error **error)
| 创建compression Filter 更多...
void | ob_compression_filter_set_compression_params (ob_filter *filter, ob_compression_mode mode, void *params, ob_error **error)
| 设置压缩类型 更多...
ob_filter * | ob_create_decompression_filter (ob_error **error)
| 创建decompressionr Filter 更多...
void | ob_filter_reset (ob_filter *filter, ob_error **error)
| Filter重置, 缓存清空，状态复位。如果是使用异步方式接口，还会停止处理线程，清空待处理的缓存帧 更多...
ob_frame * | ob_filter_process (ob_filter *filter, ob_frame *frame, ob_error **error)
| Filter 处理(同步接口) 更多...
void | ob_filter_set_callback (ob_filter *filter, ob_filter_callback callback, void *user_data, ob_error **error)
| Filter 设置处理结果回调函数(异步回调接口) 更多...
void | ob_filter_push_frame (ob_filter *filter, ob_frame *frame, ob_error **error)
| filter 压入frame到待处理缓存(异步回调接口) 更多...
void | ob_delete_filter (ob_filter *filter, ob_error **error)
| 删除Filter 更多...

## 详细描述

SDK的处理单元，可以进行点云的生成，格式转换等功能

在文件 Filter.h 中定义.

## 函数说明

ob_filter* ob_create_pointcloud_filter | ( | ob_error ** | error | ) |

创建PointCloud Filter

参数

  [out] | error | 记录错误信息

返回
  filter pointcloud_filter对象

void ob_pointcloud_filter_set_camera_param | ( | ob_filter * | filter,
|  | ob_camera_param | param,
|  | ob_error ** | error
| ) |  |

PointCloud Filter设备相机参数

参数

  [in] | filter | pointcloud_filter对象
  [in] | param | 相机参数
  [out] | error | 记录错误信息

void ob_pointcloud_filter_set_point_format | ( | ob_filter * | filter,
|  | ob_format | type,
|  | ob_error ** | error
| ) |  |

设置点云类型参数

参数

  [in] | filter | pointcloud_filter对象
  [in] | type | 点云类型 深度点云或RGBD点云
  [out] | error | 记录错误信息

void ob_pointcloud_filter_set_frame_align_state | ( | ob_filter * | filter,
|  | bool | state,
|  | ob_error ** | error
| ) |  |

设置将要输入用于生产点云的帧的对齐状态

参数

  [in] | filter | pointcloud_filter对象
  [in] | state | 对齐状态，True：已对齐； False：未对齐
  [out] | error | 记录错误信息

void ob_pointcloud_filter_set_position_data_scale | ( | ob_filter * | filter,
|  | float | scale,
|  | ob_error ** | error
| ) |  |

设置点云数据缩放比例

注意
  调用该函数设置缩放比例会改变输出点云帧的点坐标缩放系数：posScale = posScale / scale; 输出点云帧的点坐标缩放系数可通过 ob_points_frame_get_position_value_scale 函数获取

参数

  [in] | filter | pointcloud_filter对象
  [in] | scale | 设置点云坐标数据缩放比例
  [out] | error | 记录错误信息

void ob_pointcloud_filter_set_color_data_normalization | ( | ob_filter * | filter,
|  | bool | state,
|  | ob_error ** | error
| ) |  |

设置点云颜色数据归一化

参数

  [in] | filter | pointcloud_filter对象
  [in] | state | 设置点云颜色数据是否归一化
  [out] | error | 记录错误信息

ob_filter* ob_create_format_convert_filter | ( | ob_error ** | error | ) |

创建FormatConvet Filter

参数

  [out] | error | 记录错误信息

返回
  filter format_convert 对象

void ob_format_convert_filter_set_format | ( | ob_filter * | filter,
|  | ob_convert_format | type,
|  | ob_error ** | error
| ) |  |

设置格式转化的类型

参数

  [in] | filter | formatconvet_filter对象
  [in] | type | 格式转化类型
  [out] | error | 记录错误信息

ob_filter* ob_create_compression_filter | ( | ob_error ** | error | ) |

创建compression Filter

参数

  [out] | error | 记录错误信息

返回
  filter depth_filter 对象

void ob_compression_filter_set_compression_params | ( | ob_filter * | filter,
|  | ob_compression_mode | mode,
|  | void * | params,
|  | ob_error ** | error
| ) |  |

设置压缩类型

参数

  [in] | filter | compression_filter对象
  [in] | mode | 压缩模式 OB_COMPRESSION_LOSSLESS or OB_COMPRESSION_LOSSY
  [in] | params | 压缩参数，结构体 ob_compression_params，当mode为OB_COMPRESSION_LOSSLESS时，params为NULL
  [out] | error | 记录错误信息

ob_filter* ob_create_decompression_filter | ( | ob_error ** | error | ) |

创建decompressionr Filter

参数

  [out] | error | 记录错误信息

返回
  filter decompression Filter 对象

void ob_filter_reset | ( | ob_filter * | filter,
|  | ob_error ** | error
| ) |  |

Filter重置, 缓存清空，状态复位。如果是使用异步方式接口，还会停止处理线程，清空待处理的缓存帧

参数

  [in] | filter | filter对象
  [out] | error | 记录错误信息

ob_frame* ob_filter_process | ( | ob_filter * | filter,
|  | ob_frame * | frame,
|  | ob_error ** | error
| ) |  |

Filter 处理(同步接口)

参数

  [in] | filter | filter对象
  [in] | frame | 需要被处理的frame对象指针
  [out] | error | 记录错误信息

返回
  ob_frame filter处理后的frame对象

void ob_filter_set_callback | ( | ob_filter * | filter,
|  | ob_filter_callback | callback,
|  | void * | user_data,
|  | ob_error ** | error
| ) |  |

Filter 设置处理结果回调函数(异步回调接口)

参数

  [in] | filter | filter对象
  [in] | callback | 回调函数
  [in] | user_data | 可以传入任意用户数据指针，并从回调返回该数据指针
  [out] | error | 记录错误信息

void ob_filter_push_frame | ( | ob_filter * | filter,
|  | ob_frame * | frame,
|  | ob_error ** | error
| ) |  |

filter 压入frame到待处理缓存(异步回调接口)

参数

  [in] | filter | filter对象
  [out] | error | 记录错误信息

void ob_delete_filter | ( | ob_filter * | filter,
|  | ob_error ** | error
| ) |  |

删除Filter

参数

  [in] | filter | filter 对象
  [out] | error | 记录错误信息