Class FaceDetection

FaceDetectionResult 类

说明

一个用于表示和检索人脸检测神经网络检测到的人脸相关数据的类。

语法

class FaceDetectionResult

成员

公共构造函数
FaceDetectionResult::FaceDetectionResult	构造一个 FaceDetectionResult 对象。
公共方法
FaceDetectionResult::name	获取检测结果的名称。
FaceDetectionResult::score	获取检测到的人脸的置信度分数。
FaceDetectionResult::xMin	获取包含检测到的人脸的边界框左上角的 x 坐标。
FaceDetectionResult::xMax	获取包含检测到的人脸的边界框右下角的 x 坐标。
FaceDetectionResult::yMin	获取包含检测到的人脸的边界框左上角的 y 坐标。
FaceDetectionResult::yMax	获取包含检测到的人脸的边界框右下角的 y 坐标。
FaceDetectionResult::xFeature	获取检测到的人脸上特征点的 x 坐标。
FaceDetectionResult::yFeature	获取检测到的人脸上特征点的 y 坐标。

FaceDetectionResult::name

说明

获取检测结果的名称。

语法

const char* name(void);

参数

NA

返回值

指向包含类别名称的字符数组的指针。对于人脸检测，类别名称为 "Face"。

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

FaceDetectionResult::score

说明

获取检测到的人脸的置信度分数。

语法

int score(void);

参数

NA

返回值

一个介于 0 到 100 之间的整数，表示检测到的人脸的置信度。

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

FaceDetectionResult::xMin

说明

获取包含检测到的人脸的边界框左上角的 x 坐标。

语法

float xMin(void);

参数

NA

返回值

一个介于 0.00 到 1.00 之间的浮点数，0.00 表示输入视频帧的左边缘，1.00 表示输入视频帧的右边缘。

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

FaceDetectionResult::xMax

说明

获取包含检测到的人脸的边界框右下角的 x 坐标。

语法

float xMax(void);

参数

NA

返回值

一个介于 0.00 到 1.00 之间的浮点数，0.00 表示输入视频帧的左边缘，1.00 表示输入视频帧的右边缘。

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

FaceDetectionResult::yMin

说明

获取包含检测到的人脸的边界框左上角的 y 坐标。

语法

float yMin(void);

参数

NA

返回值

一个介于 0.00 到 1.00 之间的浮点数，0.00 表示输入视频帧的顶部边缘，1.00 表示输入视频帧的底部边缘。

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

FaceDetectionResult::yMax

说明

获取包含检测到的人脸的边界框右下角的 y 坐标。

语法

float yMax(void);

参数

NA

返回值

一个介于 0.00 到 1.00 之间的浮点数，0.00 表示输入视频帧的顶部边缘，1.00 表示输入视频帧的底部边缘。

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

FaceDetectionResult::xFeature

说明

获取检测到的人脸上特征点的 x 坐标。

语法

float xFeature(uint8_t index);

参数

index：人脸特征点的索引编号

0（右眼）
1（左眼）
2（鼻子）
3（右嘴角）
4（左嘴角）

返回值

一个介于 0.00 到 1.00 之间的浮点数，0.00 表示输入视频帧的左边缘，1.00 表示输入视频帧的右边缘。

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

FaceDetectionResult::yFeature

说明

获取检测到的人脸上特征点的 y 坐标。

语法

float yFeature(uint8_t index);

参数

index：人脸特征点的索引编号。

0（右眼）
1（左眼）
2（鼻子）
3（右嘴角）
4（左嘴角）

返回值

一个介于 0.00 到 1.00 之间的浮点数，0.00 表示输入视频帧的左边缘，1.00 表示输入视频帧的右边缘。

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

NNFaceDetection 类

说明

一个用于配置、运行和检索人脸检测神经网络模型结果的类。

语法

class NNFaceDetection

成员

公共构造函数
NNFaceDetection::NNFaceDetection	构造一个 NNFaceDetection 对象。
公共方法
NNFaceDetection::configVideo	配置输入视频流参数。
NNFaceDetection::configFaceRecogCascadedMode	配置在人脸检测后运行人脸识别。
NNFaceDetection::begin	在输入视频上启动人脸检测过程。
NNFaceDetection::end	停止输入视频上的人脸检测过程。
NNFaceDetection::setResultCallback	设置回调函数以接收人脸检测结果。
NNFaceDetection::getResultCount	获取人脸检测结果的数量。
NNFaceDetection::getResult	获取人脸检测结果。

NNFaceDetection::configVideo

说明

配置输入视频流参数。

语法

void configVideo(VideoSetting& config);

参数

config：包含所需视频配置的 VideoSetting 类对象。

返回值

NA

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

NNFaceDetection::configFaceRecogCascadedMode

说明

配置在人脸检测后运行人脸识别。

语法

void configFaceRecogCascadedMode(uint8_t enable);

参数

enable：1 表示启用配置，在人脸检测后运行人脸识别神经网络模型。

返回值

NA

示例代码

示例：RTSPFaceRecognition

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

NNFaceDetection::begin

说明

在输入视频上启动人脸检测过程。

语法

void begin(void);

参数

NA

返回值

NA

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

NNFaceDetection::end

说明

停止输入视频上的人脸检测过程。

语法

void end(void);

参数

NA

返回值

NA

示例代码

NA

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

NNFaceDetection::setResultCallback

说明

设置回调函数以接收人脸检测结果。

语法

void setResultCallback(void (*fd_callback)(std::vector));

参数

fd_callback：一个回调函数，接受 FaceDetectionResult 类对象的 vector 作为参数并返回 void。

返回值

NA

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

NNFaceDetection::getResultCount

说明

获取人脸检测结果的数量。

语法

uint16_t getResultCount(void);

参数

NA

返回值

返回最近一组结果中检测到的人脸数量，以无符号整数表示。

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。

NNFaceDetection::getResult

说明

获取人脸检测结果。

语法

FaceDetectionResult getResult(uint16_t index);
std::vector getResult(void);

参数

index：要检索的特定人脸检测结果的索引。

返回值

如果未指定索引，函数返回包含所有检测到的人脸的 FaceDetectionResult 类对象的 vector。

如果指定了索引，函数返回包含在 FaceDetectionResult 类对象中的特定检测到的人脸。

示例代码

示例：RTSPFaceDetection

备注

必须包含 "NNFaceDetection.h" 才能使用该类函数。