rm::HikCamera类 参考

海康机器人相机库 更多...

#include <rmvl/camera/hik_camera.h>

rm::HikCamera 的协作图:

Public 类型
using	ptr = std::unique_ptr<HikCamera>
using	const_ptr = std::unique_ptr<const HikCamera>

Public 成员函数
	HikCamera (CameraConfig cfg, std::string_view info="")
	创建 HikCamera 对象
void	load (const para::HikCameraParam &param) noexcept
	加载海康相机参数
template<typename Tp, typename Enable = std::enable_if_t<std::is_same_v<Tp, bool> || std::is_same_v<Tp, uint32_t> || std::is_same_v<Tp, float>>>
bool	set (CameraProperties propId, Tp value) noexcept
	设置相机参数
double	get (CameraProperties propId) const noexcept
	获取相机参数
bool	trigger (CameraEvents eventId) const noexcept
	触发相机事件
bool	isOpened () const noexcept
	相机是否打开
bool	read (cv::OutputArray image)
	从相机设备中读取图像
HikCamera &	operator>> (cv::Mat &image)
	从相机设备中读取图像
bool	reconnect ()
	相机重连

静态 Public 成员函数
static std::unique_ptr< HikCamera >	make_capture (CameraConfig cfg, std::string_view info="")
	构建 HikCamera 对象
static std::string	version ()
	获取相机库版本

详细描述

海康机器人相机库

示例

samples/camera/hik/sample_hik_manual_calib.cpp, samples/camera/hik/sample_hik_mono.cpp, samples/camera/hik/sample_hik_multi.cpp, samples/camera/hik/sample_hik_writer.cpp , 以及 samples/detector/hik/sample_hik_armor_collection.cpp.

成员类型定义说明

const_ptr

using rm::HikCamera::const_ptr = std::unique_ptr<const HikCamera>

ptr

using rm::HikCamera::ptr = std::unique_ptr<HikCamera>

示例

samples/detector/hik/sample_hik_armor_size_classify.cpp.

构造及析构函数说明

HikCamera()

rm::HikCamera::HikCamera	(	CameraConfig	cfg,
		std::string_view	info = "" )

Python:
	rm.HikCamera(	cfg[, info]	) ->	<HikCamera object>

创建 HikCamera 对象

参数

[in]	cfg	相机初始化配置模式，需要配置 rm::GrabMode 、 rm::RetrieveMode 和 rm::HandleMode
[in]	info	相机唯一标识

函数调用图:

成员函数说明

get()

double rm::HikCamera::get ( CameraProperties propId ) const

noexcept

Python:
	rm.HikCamera.get(	propId	) ->	value

获取相机参数

参数

[in]

propId

参数编号

返回

参数值

isOpened()

bool rm::HikCamera::isOpened ( ) const

noexcept

Python:
	rm.HikCamera.isOpened(		) ->	<opened ?>

相机是否打开

load()

void rm::HikCamera::load ( const para::HikCameraParam & param )

noexcept

加载海康相机参数

参数

[in]

param

相机参数对象

make_capture()

std::unique_ptr< HikCamera > rm::HikCamera::make_capture ( CameraConfig cfg, std::string_view info = "" )

inlinestatic

构建 HikCamera 对象

注解

此相机库仅支持 USB 相机设备，暂时对 GigE 网口相机不兼容

参数

[in]	cfg	相机初始化配置模式，需要配置 rm::GrabMode 、 rm::RetrieveMode 和 rm::HandleModes
[in]	info	相机唯一序列号

返回

HikCamera 对象独享指针

示例

samples/detector/hik/sample_hik_armor_size_classify.cpp.

operator>>()

HikCamera & rm::HikCamera::operator>> ( cv::Mat & image )

inline

从相机设备中读取图像

参数

[out]

image

待读入的图像

函数调用图:

read()

bool rm::HikCamera::read

(

cv::OutputArray

image

)

Python:
	rm.HikCamera.read(		) ->	res, img

从相机设备中读取图像

参数

[out]

image

待读入的图像

返回

是否读取成功

示例

samples/camera/hik/sample_hik_multi.cpp , 以及 samples/camera/hik/sample_hik_writer.cpp.

函数调用图:

reconnect()

bool rm::HikCamera::reconnect

(

)

Python:
	rm.HikCamera.reconnect(		) ->	<success ?>

相机重连

返回

是否成功重连

set()

template<typename Tp, typename Enable = std::enable_if_t<std::is_same_v<Tp, bool> || std::is_same_v<Tp, uint32_t> || std::is_same_v<Tp, float>>>

bool rm::HikCamera::set ( CameraProperties propId, Tp value )

noexcept

Python:
	rm.HikCamera.set(	propId[, value]	) ->	<success ?>

设置相机参数

参数

[in]	propId	参数编号
[in]	value	参数值

返回

是否设置成功

示例

samples/camera/hik/sample_hik_multi.cpp , 以及 samples/camera/hik/sample_hik_writer.cpp.

trigger()

bool rm::HikCamera::trigger ( CameraEvents eventId ) const

noexcept

触发相机事件

参数

[in]

eventId

事件编号

返回

是否触发成功

version()

std::string rm::HikCamera::version ( )

static

Python:
	rm.HikCamera.version(		) ->	<version string>

获取相机库版本