PockerFace 离线版人证比对 SDK 编程指南
深圳市喜汇信息科技有限公司(PockerFace)是一家通过深度学习框架打造新一代人脸识别技术的科技创新公司，具有完全自主知识产权的核心技术，在人脸检测、人脸识别、人脸属性检测、活体检测、人脸搜索等多个领域均有原创性创新。检出率、错检率、误检率、检测速度、支持旋转角度等标准均处于全球领先水平。(www.xihuitech.com)
一、SDK说明
l SDK支持C#，C++,QT，VB，Dephie等编程调用。
l SDK需要直接控制摄像头，获取摄像头流数据，从而获得高质量图片，提高比对准确率，避免由于采集的图片质量过差影响使用效果。
l 此人像库需要UKEY才能正常使用，在无UKEY的情况下，可调用摄像头，抓拍照片，比对照片将会报错。
l 文件夹 model 需要与EXE同级目录，库文件包含如下图所示
l 主要功能：获取摄像头视频流；抓拍照片；根据写入的模板照片，比对照片是否为同一人。
二、C#函数调用顺序
1. 函数调用说明：
包含引入文件：PockerFace_Api.cs
在调用的页面 using PockerFace;
1.1 初始SDK库PockerFace_Api_Init()
函数：public static bool PockerFace_Api_Init()
参数：无
返回值：true表示初始化成功，false表示初始化失败
说明：无
1.2打开摄像头PockerFace_Api_Start()
函数：public static int PockerFace_Api_Start(IntPtr window, int camera_id =0)
参数：IntPtr window 控件句柄，用于显示摄像头视频
int camera_id USB摄像头ID编号，一般默认为0
返回值：0为正确，其它错误码参数附件错误代码
说明：无
1.3传入比对模板照片 PockerFace_Api_SetIDImage()
函数：public static int PockerFace_Api_SetIDImage(byte[] data, int len)
参数：byte[] data 照片二进制数据流
int len 照片数据长度
返回值：0为正确，其它错误码参数附件错误代码
说明：无
1.4比对照片PockerFace_Api_Verify()
函数：public static int PockerFace_Api_Verify(ref float sim, ref bool same_people)
参数：ref float sim 两张照片相似度
ref bool same_people 是否为同一人
返回值：0为正确，其它错误码参数附件错误代码
说明：
sim(相似度) 大于等于0.69可认为相似度高, 请结合业务调整。
same_people：底层基于SmartFilter算法根据视频流中多张照片筛选过滤判断是否同一个人。所以有时候相似度值极高的情况下，same_people也可能为false，可根据业务以及场景需要进行调整判断。如调用者无特别算法，一般以same_people为准。
1.5实时抓拍照片PockerFace_Api_CaptureImage()
函数：public static int PockerFace_Api_CaptureImage(ref IntPtr data, ref intlen)
参数： ref IntPtr data 返回抓拍照片内存地址
ref int len 返回照片长度
返回值：0为正确，其它错误码参数附件错误代码
说明：无
1.6最后一次比对抓拍的照片PockerFace_Api_GetVerificationImage()
函数：public static int PockerFace_Api_GetVerificationImage(ref IntPtr data,ref int len)
参数：ref IntPtr data 返回抓拍照片内存地址
ref int len 返回照片长度
说明：无
附件
错误代码：
消息类型 |
错误码 |
说明 |
kOK |
0 |
成功 |
kParamError |
-1 |
参数错误 |
kInitCameraFail |
-2 |
初始化摄像头失败 |
kImageFormatError |
-3 |
图片格式不正确 支持BMP,JPG格式图片 |
kNotStart |
-4 |
未调用START函数 |
kNoFaceDetected |
-5 |
未检测到人脸 |
kExtractFeatureFail |
-6 |
生成特征失败 |
kCaptureImageFail |
-7 |
抓拍失败 |
kCompareFeatureFail |
-8 |
对比特征失败 |
kEncodeImageFail |
-9 |
编码图像失败 |