ob2::capture类 参考

相机 capture，capture 是图像对象的载体，一个 capture 通常会包含一个或多个不同类型相机的一帧图像 更多...

#include <OB2Camera.hpp>

Public 成员函数
	capture ()
	capture 自定义构造函数 更多...
	capture (ob2_capture_t &&capture_handle)
	通过 capture 句柄构造（主要用于 device::get_capture ） 更多...
	capture (capture &&cap)
	通过其他 capture 对象构造（移动构造，主要用于派生类的实现） 更多...
virtual	~capture () noexcept
	capture 析构函数 更多...
virtual std::shared_ptr< image >	get_image (ob2_camera_type_t camera_type)
	获取指定相机图像 更多...
virtual std::shared_ptr< image >	get_color_image ()
	获取 Color 相机图像 更多...
virtual std::shared_ptr< image >	get_depth_image ()
	获取 Depth 相机图像 更多...
virtual std::shared_ptr< image >	get_ir_image ()
	获取 红外 相机图像 更多...
virtual void	set_image (ob2_camera_type_t camera_type, std::shared_ptr< image > im)
	设置指定相机图像 更多...
virtual void	set_color_image (std::shared_ptr< image > im)
	设置 Color 相机图像 更多...
virtual void	set_depth_image (std::shared_ptr< image > im)
	设置 Depth 相机图像 更多...
virtual void	set_ir_image (std::shared_ptr< image > im)
	设红外相机图像 更多...
virtual ob2_capture_t	get_handle ()
	获取 capture 句柄 更多...

Protected 属性
ob2_capture_t	m_capture_handle

详细描述

相机 capture，capture 是图像对象的载体，一个 capture 通常会包含一个或多个不同类型相机的一帧图像

在文件 OB2Camera.hpp 第 940 行定义.

构造及析构函数说明

capture() [1/3]

ob2::capture::capture ( )

inline

capture 自定义构造函数

在文件 OB2Camera.hpp 第 953 行定义.

capture() [2/3]

ob2::capture::capture ( ob2_capture_t &&  capture_handle )

inline

通过 capture 句柄构造（主要用于 device::get_capture ）

参数

capture_handle

capture 句柄

在文件 OB2Camera.hpp 第 974 行定义.

capture() [3/3]

ob2::capture::capture ( capture &&  cap )

inline

通过其他 capture 对象构造（移动构造，主要用于派生类的实现）

注意

调用该构造函数后，原对象将不再可以访问

参数

cap	其他 capture 对象

在文件 OB2Camera.hpp 第 997 行定义.

~capture()

virtual ob2::capture::~capture ( )

inlinevirtualnoexcept

capture 析构函数

在文件 OB2Camera.hpp 第 1013 行定义.

成员函数说明

get_image()

virtual std::shared_ptr< image > ob2::capture::get_image ( ob2_camera_type_t  camera_type )

inlinevirtual

获取指定相机图像

注意

如果当前 capture 内不包含指定相机的图像，将会抛出 std::logic_error 异常。 不包含指定相机的图像的原因可能为：

1. camera_type 指定的相机未使能
2. produce_capture_policy 默认策略被修改

参数

[in]

camera_type

相机类型

返回

std::shared_ptr<image> 返回图像对象智能指针

在文件 OB2Camera.hpp 第 1047 行定义.

get_color_image()

virtual std::shared_ptr< image > ob2::capture::get_color_image ( )

inlinevirtual

获取 Color 相机图像

注意

如果当前 capture 内不包含 Color 相机的图像，将会抛出 std::logic_error 异常。 不包含 Color 相机的图像的原因可能为：

1. 启动相机工作时 Color 相机未使能
2. 启动相机工作时 produce_capture_policy 默认策略被修改

返回

std::shared_ptr<image> 返回图像对象智能指针

在文件 OB2Camera.hpp 第 1079 行定义.

get_depth_image()

virtual std::shared_ptr< image > ob2::capture::get_depth_image ( )

inlinevirtual

获取 Depth 相机图像

注意

如果当前 capture 内不包含 Depth 相机的图像，将会抛出 std::logic_error 异常。 不包含 Depth 相机的图像的原因可能为：

1. 启动相机工作时 Depth 相机未使能
2. 启动相机工作时 produce_capture_policy 默认策略被修改

返回

std::shared_ptr<image> 返回图像对象智能指针

在文件 OB2Camera.hpp 第 1111 行定义.

get_ir_image()

virtual std::shared_ptr< image > ob2::capture::get_ir_image ( )

inlinevirtual

获取 红外 相机图像

注意

如果当前 capture 内不包含红外相机的图像，将会抛出 std::logic_error 异常。 不包含红外相机的图像的原因可能为：

1. 启动相机工作时红外相机未使能
2. 启动相机工作时 produce_capture_policy 默认策略被修改

返回

std::shared_ptr<image> 返回图像对象智能指针

在文件 OB2Camera.hpp 第 1143 行定义.

set_image()

virtual void ob2::capture::set_image ( ob2_camera_type_t  camera_type, std::shared_ptr< image >  im  )

inlinevirtual

设置指定相机图像

会将图像拷贝（浅拷贝）保存一份到 capture 内，如果 capture 已包含指定相机的图像，则会先将原图像释放。

参数

[in]	camera_type	相机类型
[in]	im	需要设置的相机图像

在文件 OB2Camera.hpp 第 1173 行定义.

set_color_image()

virtual void ob2::capture::set_color_image ( std::shared_ptr< image >  im )

inlinevirtual

设置 Color 相机图像

会将图像拷贝（浅拷贝）保存一份到 capture 内，如果 capture 已包含 Color 相机的图像，则会先将原图像释放。

参数

[in]

im

需要设置的相机图像

在文件 OB2Camera.hpp 第 1197 行定义.

set_depth_image()

virtual void ob2::capture::set_depth_image ( std::shared_ptr< image >  im )

inlinevirtual

设置 Depth 相机图像

会将图像拷贝（浅拷贝）保存一份到 capture 内，如果 capture 已包含 Depth 相机的图像，则会先将原图像释放。

参数

[in]

im

需要设置的相机图像

在文件 OB2Camera.hpp 第 1221 行定义.

set_ir_image()

virtual void ob2::capture::set_ir_image ( std::shared_ptr< image >  im )

inlinevirtual

设红外相机图像

会将图像拷贝（浅拷贝）保存一份到 capture 内，如果 capture 已包含红外相机的图像，则会先将原图像释放。

参数

[in]

im

需要设置的相机图像

在文件 OB2Camera.hpp 第 1245 行定义.

get_handle()

virtual ob2_capture_t ob2::capture::get_handle ( )

inlinevirtual

获取 capture 句柄

注意

获取句柄不会增加句柄引用计数，其生命周期还是由 capture 对象管理，即 capture 析构后会释放句柄

返回

ob2_capture_t 返回 capture 句柄

在文件 OB2Camera.hpp 第 1271 行定义.

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

类成员变量说明

m_capture_handle

ob2_capture_t ob2::capture::m_capture_handle

protected

在文件 OB2Camera.hpp 第 1276 行定义.

被这些函数引用 capture(), get_color_image(), get_depth_image(), get_handle(), get_image(), get_ir_image(), set_color_image(), set_depth_image(), set_image(), set_ir_image() , 以及 ~capture().

---

该类的文档由以下文件生成:

• C:/Users/hzcyf/projects/SensorSDK/libobsensor2/include/hpp/OB2Camera.hpp