根据目录可以大致看到一套完整的SDK 函数分类。使用时根据demo按需查看sdk.
旷视SDK API接口
目录
旷视SDK API接口
1.整体SDK的操作
1.1 获取版本信息getVersion
1.2 初始化 init
1.3 释放release
1.4 设置日志等级 setLogLevel
1.5 设置参数 set_detect_config
2.人脸位置轨迹坐标信息
2.1 获取人脸位置信息 detect
2.2 视频流人脸位置 detectAndTrack
2.3 获取人脸坐标 getFaceRect
2.4 获取跟踪轨迹编号 getTrackId
2.5 获取⼈脸关键点 getFaceLandmark
2.6 重置跟踪器 resetTrack
2.7 释放人脸结构体 releaseFace
2.8 ⼈脸⻆度模糊度属性 getPoseBlurAttribute
2.9 获取人脸关键点refineLandmark
3.2 释放特征值 releaseFeature
3.3 比较特征值 compare
4.活体检测
4.1可见光 getLiveness_bgr
4.2 红外getLiveness_ir
4.3 红外可见光 getLiveness_bgrir
4.4 双目配置参数 set_match_config
红外电子屏过滤 ir_filter
可见光和红外图形对比 BGR_IR_match
5.人脸特征信息
5.1 getFaceAttrResult
5.2 getFaceOcclResult
2.底库的操作
2.1 创建底库
2.2 插入特征值
2.3 删除底库中指定人脸
2.4 底库总数
2.5 清空底库
2.6 释放底库releaseFaceGroup
2.7 底库中检索目标特征
identifyFromFaceGroup
2.8 底库检索返回前K个
top_k_FromFaceGroup
1.整体SDK的操作
1.1 获取版本信息getVersion
获取SDK版本和编译时间。
返回值:常量字符串地址
eg const char* versionPtr = getVersion();
1.2 初始化 init
初始化函数,使⽤SDK必须⾸先调⽤该函数并确保返回 RET_OK 。
1.3 释放release
释放 SDK 的各种内部资源。
1.4 设置日志等级 setLogLevel
设置⽇志级别以打印必要的信息。
1.5 设置参数 set_detect_config
配置检测算法的内部参数。
根据模型不同需要设置相应的值,请根据模型发布时的说明配置
2.人脸位置轨迹坐标信息
2.1 获取人脸位置信息 detect
静态图⽚⼈脸检测。输⼊图⽚,调⽤算法检测出⼈脸的位置。⼈脸位置等信息保存在 FaceHandle 数据
结构中,可调⽤相应接口获取
2.2 视频流人脸位置 detectAndTrack
视频流⼈脸检测。输⼊视频帧,调⽤算法检测出⼈脸的位置。⼈脸位置等信息保存在 FaceHandle 数据
结构中,可调⽤相应接口获取
2.3 获取人脸坐标 getFaceRect
获取⼈脸坐标。
2.4 获取跟踪轨迹编号 getTrackId
获取跟踪轨迹编号。 仅在执⾏ detectAndTrack 函数后调⽤该接口
2.5 获取⼈脸关键点 getFaceLandmark
获取⼈脸关键点。
2.6 重置跟踪器 resetTrack
重置跟踪器及轨迹。
2.7 释放人脸结构体 releaseFace
释放从 detect 或 detectAndTrack 获得的⼈脸数据结构体
2.8 ⼈脸⻆度模糊度属性 getPoseBlurAttribute
获取⼈脸⻆度模糊度属性。
2.9 获取人脸关键点refineLandmark
精调 pf 模型输出的⼈脸关键点。
- 人脸特征值
- 获取人脸特征值extract
抽取⼈脸特征。
3.2 释放特征值 releaseFeature
释放特征值。extract 返回的特征值数组需要通过该接口释放
3.3 比较特征值 compare
⽐较两组特征值,返回⽐对分数
4.活体检测
4.1可见光 getLiveness_bgr
可⻅光活体算法,获取活体分数
4.2 红外getLiveness_ir
近红外活体算法,获取活体分数。
4.3 红外可见光 getLiveness_bgrir
红外活体算法,获取红外活体分数
4.4 双目配置参数 set_match_config
配置双⽬匹配参数。红外电⼦屏过滤或双⽬匹配需要考虑双摄像头的位置偏移,该函数即⽤于配置这个
偏移量
红外电子屏过滤 ir_filter
红外电⼦屏过滤。输⼊成对的彩⾊与红外检测结果,输出红外过滤的结果。红外电⼦屏过滤的相关知识 请看专⻔⽂档
可见光和红外图形对比 BGR_IR_match
对可⻅光图像 handle 数组和近红外图像的 ir_handle 数组进⾏匹配,找到可⻅光图像中每⼀个
FaceHandle 对应的近红外图像⼈脸。
5.人脸特征信息
5.1 getFaceAttrResult
获取⼈脸属性特征:年龄、性别、头发、胡⼦、眼镜等特征
5.2 getFaceOcclResult
获取⼈脸遮挡属性:额头、眼睛、⿐⼦、脸颊、嘴和下巴等
2.底库的操作
2.1 创建底库
createFaceGroup
创建底库,进⾏1:N 搜索前必须先创建底库,可以加速搜索
2.2 插入特征值
insertFaceGroup
将⼀个⼈脸特征数组插⼊底库。
2.3 删除底库中指定人脸
removeFaceGroup
删除底库中指定⼈脸
2.4 底库总数
getFaceGroupCount
获取底库总数。
2.5 清空底库
resetFaceGroup
清空底库。
2.6 释放底库releaseFaceGroup
释放底库。
2.7 底库中检索目标特征
identifyFromFaceGroup
在底库中检索⽬标特征,返回底库中相似度分数最⾼的特征的 id 和分数。通常所讲的"1:N"接口,进⾏ ⼈脸识别底库搜索。
2.8 底库检索返回前K个
top_k_FromFaceGroup
⽀持 TopK 查询的"1:N"⼈脸识别接口。在底库中对⽬标特征值进⾏⽐对搜索,返回⽐对分数最⾼的前k 个特征的id和⽐对分数