ob2extension.h 文件参考

#include "ob2types.h"

浏览源代码.

函数
ob2_transformation_t	ob2_transformation_create (const ob2_cameras_calibration_t *calibration, ob2_status_t *status)
	创建图像转换器 更多...
void	ob2_transformation_destroy (ob2_transformation_t transformation_handle, ob2_status_t *status)
	销毁图像转换器 更多...
ob2_image_t	ob2_transformation_depth_image_to_point_cloud (ob2_transformation_t transformation_handle, const ob2_image_t depth_image_handle, float position_scale, ob2_status_t *status)
	深度图转点云图 更多...
ob2_image_t	ob2_transformation_depth_image_to_colored_point_cloud (ob2_transformation_t transformation_handle, const ob2_image_t depth_image_handle, const ob2_image_t color_image_handle, float position_scale, ob2_enable_ctrl_t color_normalization, ob2_status_t *status)
	深度图转点云图 更多...
ob2_image_format_converter_t	ob2_image_format_converter_create (ob2_status_t *status)
	创建图像格式转换器 更多...
void	ob2_image_format_converter_destroy (ob2_image_format_converter_t converter_handle, ob2_status_t *status)
	销毁图像格式转换器 更多...
ob2_image_t	ob2_image_format_converter_yuyv_to_rgb (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	YUYV 转 RGB 更多...
ob2_image_t	ob2_image_format_converter_uyvy_to_rgb (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	UYVY 转 RGB 更多...
ob2_image_t	ob2_image_format_converter_i420_to_rgb (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	I420 转 RGB 更多...
ob2_image_t	ob2_image_format_converter_nv21_to_rgb (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	NV21 转 RGB 更多...
ob2_image_t	ob2_image_format_converter_nv12_to_rgb (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	NV12 转 RGB 更多...
ob2_image_t	ob2_image_format_converter_rgb_to_bgr (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	RGB 转 BGR 更多...
ob2_image_t	ob2_image_format_converter_mjpg_to_i420 (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	MJPG 转 I420 更多...
ob2_image_t	ob2_image_format_converter_mjpg_to_nv21 (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	MJPG 转 NV21 更多...
ob2_image_t	ob2_image_format_converter_mjpg_to_rgb (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	MJPG 转 RGB 更多...
ob2_image_t	ob2_image_format_converter_mjpg_to_bgr (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	MJPG 转 BGR 更多...
ob2_image_t	ob2_image_format_converter_mjpg_to_bgra (ob2_image_format_converter_t converter_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	MJPG 转 BGRA 更多...
ob2_compression_t	ob2_image_compressor_create (ob2_status_t *status)
	创建图像数据压缩器 更多...
void	ob2_image_compressor_destroy (ob2_compression_t compression_handle, ob2_status_t *status)
	销毁图像数据压缩器 更多...
ob2_image_t	ob2_image_compress_lossless (ob2_compression_t compression_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	图像数据无损压缩 更多...
ob2_image_t	ob2_image_compress_lossy (ob2_compression_t compression_handle, const ob2_image_t source_image_handle, uint8_t threshold, ob2_status_t *status)
	图像数据有损压缩 更多...
ob2_decompression_t	ob2_image_decompressor_create (ob2_status_t *status)
	创建图像数据解压器 更多...
void	ob2_image_decompressor_destroy (ob2_decompression_t decompression_handle, ob2_status_t *status)
	销毁图像数据解压器 更多...
ob2_image_t	ob2_image_decompress (ob2_decompression_t decompression_handle, const ob2_image_t source_image_handle, ob2_status_t *status)
	图像数据解压 更多...

函数说明

ob2_transformation_create()

ob2_transformation_t ob2_transformation_create	(	const ob2_cameras_calibration_t *	calibration,
		ob2_status_t *	status
	)

创建图像转换器

图像转换器可完成深度图像转点云图及深度和 RGB 图像转彩色点云图的功能

注意

需要保证传入创建图像转换器的图像标定参数，与图像本身是相关连的（相机启动获取图像和获取内参使用的 cameras_config 配置是一样的）

成功创建图像转换器后，不再使用该图像转换器的话，需要调用 ob2_transformation_destroy 销毁，否则会导致内参泄漏。

参数

[in]	calibration	标定参数，图像的转换依赖相机标定参数
[out]	status	返回函数调用状态

返回

ob2_transformation_t 返回图像转换器句柄

被这些函数引用 ob2::transformation::transformation().

ob2_transformation_destroy()

void ob2_transformation_destroy	(	ob2_transformation_t	transformation_handle,
		ob2_status_t *	status
	)

销毁图像转换器

参数

[in]	transformation_handle	图像转换器句柄
[out]	status	返回函数调用状态

被这些函数引用 ob2::transformation::~transformation().

ob2_transformation_depth_image_to_point_cloud()

ob2_image_t ob2_transformation_depth_image_to_point_cloud	(	ob2_transformation_t	transformation_handle,
		const ob2_image_t	depth_image_handle,
		float	position_scale,
		ob2_status_t *	status
	)

深度图转点云图

注意

成功转换生成点云图后，无论点云图还是原始深度图，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	transformation_handle	图像转换器句柄
[in]	depth_image_handle	深度图句柄
[in]	position_scale	坐标缩放系数，不缩放可填 1.0f
[out]	status	返回函数调用状态

返回

ob2_image_t 返回点云图句柄

被这些函数引用 ob2::transformation::depth_image_to_point_cloud().

ob2_transformation_depth_image_to_colored_point_cloud()

ob2_image_t ob2_transformation_depth_image_to_colored_point_cloud	(	ob2_transformation_t	transformation_handle,
		const ob2_image_t	depth_image_handle,
		const ob2_image_t	color_image_handle,
		float	position_scale,
		ob2_enable_ctrl_t	color_normalization,
		ob2_status_t *	status
	)

深度图转点云图

注意

成功转换生成点云图后，无论点云图还是原始深度图和原始彩色图，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	transformation_handle	图像转换器句柄
[in]	depth_image_handle	深度图句柄
[in]	color_image_handle	彩色图句柄
[in]	position_scale	坐标缩放系数，不缩放可填 1.0f
[in]	color_normalization	彩色归一化，默认输出的彩色点云 RGB 各通道数值是 0~255，使能归一化功能以后，数值归一化为 0.0f~1.0f
[out]	status	返回函数调用状态

返回

ob2_image_t 返回彩色点云图句柄

被这些函数引用 ob2::transformation::depth_image_to_colored_point_cloud().

ob2_image_format_converter_create()

ob2_image_format_converter_t ob2_image_format_converter_create

(

ob2_status_t *

status

)

创建图像格式转换器

注意

成功创建图像格式转换器后，不再使用该图像格式转换器的话，需要调用 ob2_image_format_converter_destroy 销毁，否则会导致内参泄漏。

参数

[out]

status

返回函数调用状态

返回

ob2_image_format_converter_t 返回图像格式转换器句柄

被这些函数引用 ob2::image_format_converter::image_format_converter().

ob2_image_format_converter_destroy()

void ob2_image_format_converter_destroy	(	ob2_image_format_converter_t	converter_handle,
		ob2_status_t *	status
	)

销毁图像格式转换器

参数

[in]	converter_handle	图像格式转换器句柄
[out]	status	返回函数调用状态

被这些函数引用 ob2::image_format_converter::~image_format_converter().

ob2_image_format_converter_yuyv_to_rgb()

ob2_image_t ob2_image_format_converter_yuyv_to_rgb	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

YUYV 转 RGB

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

被这些函数引用 ob2::image_format_converter::yuyv_to_rgb().

ob2_image_format_converter_uyvy_to_rgb()

ob2_image_t ob2_image_format_converter_uyvy_to_rgb	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

UYVY 转 RGB

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

被这些函数引用 ob2::image_format_converter::i420_to_rgb(), ob2::image_format_converter::nv21_to_rgb() , 以及 ob2::image_format_converter::uyvy_to_rgb().

ob2_image_format_converter_i420_to_rgb()

ob2_image_t ob2_image_format_converter_i420_to_rgb	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

I420 转 RGB

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

ob2_image_format_converter_nv21_to_rgb()

ob2_image_t ob2_image_format_converter_nv21_to_rgb	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

NV21 转 RGB

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

ob2_image_format_converter_nv12_to_rgb()

ob2_image_t ob2_image_format_converter_nv12_to_rgb	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

NV12 转 RGB

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

被这些函数引用 ob2::image_format_converter::nv12_to_rgb().

ob2_image_format_converter_rgb_to_bgr()

ob2_image_t ob2_image_format_converter_rgb_to_bgr	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

RGB 转 BGR

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

被这些函数引用 ob2::image_format_converter::rgb_to_bgr().

ob2_image_format_converter_mjpg_to_i420()

ob2_image_t ob2_image_format_converter_mjpg_to_i420	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

MJPG 转 I420

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

被这些函数引用 ob2::image_format_converter::mjpg_to_i420().

ob2_image_format_converter_mjpg_to_nv21()

ob2_image_t ob2_image_format_converter_mjpg_to_nv21	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

MJPG 转 NV21

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

被这些函数引用 ob2::image_format_converter::mjpg_to_nv21().

ob2_image_format_converter_mjpg_to_rgb()

ob2_image_t ob2_image_format_converter_mjpg_to_rgb	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

MJPG 转 RGB

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

被这些函数引用 ob2::image_format_converter::mjpg_to_rgb().

ob2_image_format_converter_mjpg_to_bgr()

ob2_image_t ob2_image_format_converter_mjpg_to_bgr	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

MJPG 转 BGR

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

被这些函数引用 ob2::image_format_converter::mjpg_to_bgr().

ob2_image_format_converter_mjpg_to_bgra()

ob2_image_t ob2_image_format_converter_mjpg_to_bgra	(	ob2_image_format_converter_t	converter_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

MJPG 转 BGRA

注意

成功完成格式转换后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	converter_handle	图像格式转换器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 格式转换后输出的图像句柄

被这些函数引用 ob2::image_format_converter::mjpg_to_bgra().

ob2_image_compressor_create()

ob2_compression_t ob2_image_compressor_create

(

ob2_status_t *

status

)

创建图像数据压缩器

支持图像有损压缩和无损压缩，无论哪种压缩方式，都可以通过 decompressor 解压缩器进行解压

注意

当前图像数据压缩器仅支持深度和 IR 图像的 Y16 格式压缩

成功创建图像数据压缩器后，不再使用该图像数据压缩器的话，需要调用 ob2_image_compressor_destroy 销毁，否则会导致内参泄漏。

参数

[out]

status

返回函数调用状态

返回

ob2_compression_t 返回图像数据压缩器句柄

被这些函数引用 ob2::image_compressor::image_compressor().

ob2_image_compressor_destroy()

void ob2_image_compressor_destroy	(	ob2_compression_t	compression_handle,
		ob2_status_t *	status
	)

销毁图像数据压缩器

参数

[in]	compression_handle	图像数据压缩器句柄
[out]	status	返回函数调用状态

被这些函数引用 ob2::image_compressor::~image_compressor().

ob2_image_compress_lossless()

ob2_image_t ob2_image_compress_lossless	(	ob2_compression_t	compression_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

图像数据无损压缩

注意

成功完成图像压缩后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	compression_handle	图像数据压缩器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 图像压缩后输出的图像句柄

被这些函数引用 ob2::image_compressor::compress_lossless().

ob2_image_compress_lossy()

ob2_image_t ob2_image_compress_lossy	(	ob2_compression_t	compression_handle,
		const ob2_image_t	source_image_handle,
		uint8_t	threshold,
		ob2_status_t *	status
	)

图像数据有损压缩

注意

成功完成图像压缩后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

图像压缩阈值越高压缩率越高, 但是图像信息损失越大，所以用户需要结合自身使用场景，通过测试确认最合适的阈值。

参数

[in]	compression_handle	图像数据压缩器句柄
[in]	source_image_handle	原始图像句柄
[in]	threshold	有损压缩阈值，范围 [0~255]，推荐值为 9，阈值越高压缩率越高。
[out]	status	返回函数调用状态

返回

ob2_image_t 图像压缩后输出的图像句柄

被这些函数引用 ob2::image_compressor::compress_lossy().

ob2_image_decompressor_create()

ob2_decompression_t ob2_image_decompressor_create

(

ob2_status_t *

status

)

创建图像数据解压器

图像使用 compressor 经过有损压缩或无损压缩，都可以通过 decompressor 解解压器进行解压

注意

成功创建图像数据解压器后，不再使用该图像数据解压器的话，需要调用 ob2_image_compressor_destroy 销毁，否则会导致内参泄漏。

参数

[out]

status

返回函数调用状态

返回

ob2_compression_t 返回图像数据解压器句柄

被这些函数引用 ob2::image_decompressor::image_decompressor().

ob2_image_decompressor_destroy()

void ob2_image_decompressor_destroy	(	ob2_decompression_t	decompression_handle,
		ob2_status_t *	status
	)

销毁图像数据解压器

参数

[in]	decompression_handle	图像数据解压器句柄
[out]	status	返回函数调用状态

被这些函数引用 ob2::image_decompressor::~image_decompressor().

ob2_image_decompress()

ob2_image_t ob2_image_decompress	(	ob2_decompression_t	decompression_handle,
		const ob2_image_t	source_image_handle,
		ob2_status_t *	status
	)

图像数据解压

注意

成功完成图像解压后，无论输出图像还是原始图像，如果不再需要使用，需要调用 ob2_image_release 释放，否则会导致内参泄漏。

参数

[in]	decompression_handle	图像数据解压器句柄
[in]	source_image_handle	原始图像句柄
[out]	status	返回函数调用状态

返回

ob2_image_t 图像解压后输出的图像句柄

被这些函数引用 ob2::image_decompressor::decompress().