Class FaceDetectionRecognition

FaceRecognitionResult Class

说明

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

语法

class FaceRecognitionResult

成员

公共构造函数
FaceRecognitionResult::FaceRecognitionResult	构造一个 FaceDetectionResult 对象
公共方法
FaceRecognitionResult::name	获取已识别人脸的名称。
FaceRecognitionResult::xMin	获取包含已识别人脸的边界框左上角的 x 坐标。
FaceRecognitionResult::xMax	获取包含已识别人脸的边界框右下角的 x 坐标。
FaceRecognitionResult::yMin	获取包含已识别人脸的边界框左上角的 y 坐标。
FaceRecognitionResult::yMax	获取包含已识别人脸的边界框右下角的 y 坐标。

FaceRecognitionResult::name

说明

获取已识别人脸的名称。

语法

const char* name(void);

参数

NA

返回值

返回指向包含已识别人脸名称的字符数组的指针。

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

FaceRecognitionResult::xMin

说明

获取包含已识别人脸的边界框左上角的 x 坐标。

语法

float xMin(void);

参数

NA

返回值

返回一个范围在 0.00 到 1.00 的浮点数，其中 0.00 表示输入视频帧的左边缘，1.00 表示输入视频帧的右边缘。

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

FaceRecognitionResult::yMin

说明

获取包含已识别人脸的边界框左上角的 y 坐标。

语法

float yMin(void);

参数

NA

返回值

返回一个范围在 0.00 到 1.00 的浮点数，其中 0.00 表示输入视频帧的顶部边缘，1.00 表示输入视频帧的底部边缘。

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

FaceRecognitionResult::xMax

说明

获取包含已识别人脸的边界框右下角的 x 坐标。

语法

float xMax(void);

参数

NA

返回值

返回一个范围在 0.00 到 1.00 的浮点数，其中 0.00 表示输入视频帧的左边缘，1.00 表示输入视频帧的右边缘。

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

FaceRecognitionResult::yMax

说明

获取包含已识别人脸的边界框右下角的 y 坐标。

语法

float yMax(void);

参数

NA

返回值

返回一个范围在 0.00 到 1.00 的浮点数，其中 0.00 表示输入视频帧的顶部边缘，1.00 表示输入视频帧的底部边缘。

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

NNFaceDetectionRecognition Class

说明

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

语法

class NNFaceDetectionRecognition

成员

公共构造函数
NNFaceDetectionRecognition::NNFaceDetectionRecognition	构造一个 NNFaceDetectionRecognition 对象。
公共方法
NNFaceDetectionRecognition::begin	在输入视频上启动人脸识别处理。
NNFaceDetectionRecognition::end	停止输入视频上的人脸识别处理。
NNFaceDetectionRecognition::registerFace	注册检测到的人脸并为其指定名称。
NNFaceDetectionRecognition::exitRegisterMode	退出人脸注册模式。
NNFaceDetectionRecognition::resetRegisteredFace	重置所有已注册的人脸。
NNFaceDetectionRecognition::backupRegisteredFace	将当前已注册的人脸保存到闪存中。
NNFaceDetectionRecognition::restoreRegisteredFace	从闪存中加载已注册的人脸。
NNFaceDetectionRecognition::setThreshold	设置人脸识别置信度阈值的最小值。
NNFaceDetectionRecognition::setResultCallback	设置一个回调函数用于接收人脸识别结果。
NNFaceDetectionRecognition::getResultCount	获取人脸识别结果的数量。
NNFaceDetectionRecognition::getResult	获取人脸识别结果。

NNFaceDetectionRecognition::begin

说明

在输入视频上启动人脸识别处理。

语法

void begin(void);

参数

NA

返回值

NA

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

NNFaceDetectionRecognition::end

说明

停止输入视频上的人脸识别处理。

语法

void end(void);

参数

NA

返回值

NA

示例代码

NA

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

NNFaceDetectionRecognition::registerFace

说明

注册检测到的人脸并为其指定名称。

语法

void registerFace(String name);
void registerFace(const char* name);

参数

name：要分配给新注册人脸的名称，以 String 类对象或指向字符数组的指针表示。

返回值

NA

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

NNFaceDetectionRecognition::exitRegisterMode

说明

退出人脸注册模式。

语法

void exitRegisterMode(void);

参数

NA

返回值

NA

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

NNFaceDetectionRecognition::resetRegisteredFace

说明

重置所有已注册的人脸。

语法

void resetRegisteredFace(void);

参数

NA

返回值

NA

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

NNFaceDetectionRecognition::backupRegisteredFace

说明

将当前已注册的人脸保存到闪存中。

语法

void backupRegisteredFace(void);

参数

NA

返回值

NA

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

NNFaceDetectionRecognition::restoreRegisteredFace

说明

从闪存中加载已注册的人脸。

语法

void restoreRegisteredFace(void);

参数

NA

返回值

NA

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

NNFaceDetectionRecognition::setThreshold

说明

设置人脸识别置信度阈值的最小值。

语法

void setThreshold(uint8_t threshold);

参数

threshold：人脸识别置信度阈值，以无符号整数表示。

0 到 100（默认值为 1）

返回值

NA

示例代码

NA

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。较高的阈值会导致更严格的人脸识别过程。例如，增加阈值可能会导致人脸侧向时识别失败。默认值 1 经过测试，可在最大程度减少误报的同时，最大化识别已注册人脸的条件。

NNFaceDetectionRecognition::setResultCallback

说明

设置一个回调函数用于接收人脸识别结果。

语法

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

参数

fr_callback：一个回调函数，接受包含 FaceRecognitionResult 类对象的 vector 作为参数，返回值为 void。

返回值

NA

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。回调函数将在每次迭代中使用最新结果被调用。

NNFaceDetectionRecognition::getResultCount

说明

获取人脸识别结果的数量。

语法

uint16_t getResultCount(void);

参数

NA

返回值

返回最近一组结果中已识别人脸的数量，以无符号整数表示。

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。

NNFaceDetectionRecognition::getResult

说明

获取人脸识别结果。

语法

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

参数

index：要获取的特定人脸识别结果的索引。

返回值

如果未指定索引，该函数返回一个包含 FaceRecognitionResult 类对象 vector 的所有已识别人脸。

如果指定了索引，该函数返回 FaceRecognitionResult 类对象中包含的特定已识别人脸。

示例代码

示例：RTSPFaceRecognition

备注

使用该类函数前必须包含 "NNFaceRecognition.h"。