BaseFaceApiLocal (faceapi-码云(gitee.com))

java.lang.Object
- net.gdface.sdk.BaseFaceApi
- - net.gdface.sdk.BaseFaceApiLocal

All Implemented Interfaces:

CapacityFieldConstant, FaceApi
```
public abstract class BaseFaceApiLocal
extends BaseFaceApi
implements CapacityFieldConstant
```
FaceApi本地实现
SDK接口类本地实现必须从此类派生

Author:

guyadong

Field Summary

Fields
Modifier and Type	Field and Description
`protected static IAuxTool`	`auxTool`
`protected java.util.Map<java.lang.String,java.lang.String>`	`capacity`
`protected static net.gdface.utils.ShareLock`	`concurrentLock` 并发锁,限制建模的并发线程数,默认为CPU核数

Fields inherited from interface net.gdface.sdk.CapacityFieldConstant
C_CODEINFO_RELOCATE, C_FDDATA_SIZE, C_FDMAX_FACE_COUNT, C_FEATURE_SIZE, C_FSE_ENABLE, C_LOCAL_DETECT, C_MULTI_FACE_FEATURE, C_SDK_VERSION, C_WEAR_MASK

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseFaceApiLocal()

Constructors
Modifier	Constructor and Description
`protected`	`BaseFaceApiLocal()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`compareCode(byte[] code1, byte[] code2)` 特征码比对参数为`null`或长度不一致则抛出`IllegalArgumentException`异常,返回两个特征码之间的相似度（0.0~1）
`CodeInfo[]`	`detectAndGetCodeInfo(net.gdface.image.BaseLazyImage lazyImg, int faceNum)` 先对图像数据`imgData`进行人脸检测，然后提取人脸特征码
`CodeInfo[]`	`detectAndGetCodeInfo(byte[] imgData, int faceNum)` 先对图像数据`imgData`进行人脸检测，然后提取人脸特征码返回所有成功提取特征码的`CodeInfo`数组, 与`FaceApi.getCodeInfo(byte[], int, CodeInfo[])`的返回结果有差别，返回结果中不包含检测到人脸但提取特征码失败的对象
`java.util.List<CodeInfo>`	`detectFace(net.gdface.image.BaseLazyImage lazyImg)` 对图像(`lazyImg`)进行人脸检测，返回人脸位置数据对象`CodeInfo`列表
`CodeInfo[]`	`detectFace(byte[] imgData)` 对图像(`imgData`)进行人脸检测，返回人脸位置数据对象`CodeInfo`数组没有检测到人脸则返回空数组
`protected static byte[]`	`fromNv21(net.gdface.image.MatType matType, byte[] nv21, int width, int height)`
`CodeInfo`	`getCodeInfo(net.gdface.image.BaseLazyImage lazyImg, CodeInfo facePos)` 提取单个人脸特征
`java.util.List<CodeInfo>`	`getCodeInfo(net.gdface.image.BaseLazyImage lazyImg, int faceNum, java.util.List<CodeInfo> facePos)` 对图像(`lazyImg`)中指定的人脸位置`facePos`并提取特征码，返回生成人脸特征码数据数组对象（人脸可能不止一个）调用该方法时假设图像(`lazyImage`)能正常解码,所以当对图像解码出现异常时，将异常对象封装到`RuntimeException`抛出
`CodeInfo`	`getCodeInfo(byte[] imgData, CodeInfo facePos)` 根据`facePos`提供的人脸信息位置, 在`imgData`图像中提取特征码返回包含人脸特征的`CodeInfo`对象，提取特征失败则返回`null`
`CodeInfo[]`	`getCodeInfo(byte[] imgData, int faceNum, CodeInfo[] facePos)` 根据`facePos`提供的人脸信息位置, 在`imgData`图像中提取特征码与 `FaceApi.detectAndGetCodeInfo(byte[], int)`不同, 本方法不对图像数据`imgData`进行人脸检测, 假设`facePos`是 `FaceApi.detectFace(byte[])`或 `#detectFaceAgain(byte[], FRect[])` 的返回结果返回facePos,如果没有提取到特征码,则对应元素`CodeInfo.getCode()`返回`null`
`FeatureSe`	`getFeatureSe()` 返回当前`FaceApi`接口实例对应的搜索引擎接口实例，如果没有则返回`null`
`protected net.gdface.image.MatType`	`getNativeMatrixType()` 返回用于图像检测和建模的图像矩阵的(色彩空间)类型不可返回`null`
`boolean`	`isLocal()` 返回当前接口实现方式 false WebService类型 true 本地实现
`CodeInfo[]`	`matDetectAndGetCodeInfo(net.gdface.image.MatType matType, byte[] matData, int width, int height, int faceNum)` 先对图像矩阵数据`imgData`进行人脸检测，然后提取人脸特征码返回包含人脸特征数据的`CodeInfo`数组
`CodeInfo[]`	`matDetectFace(net.gdface.image.MatType matType, byte[] matData, int width, int height)` 对图像矩阵进行人脸检测返回人脸信息对象列表，没有检测到人脸返回空表
`CodeInfo`	`matGetCodeInfo(net.gdface.image.MatType matType, byte[] matData, int width, int height, CodeInfo facePos)` 根据`facePos`提供的人脸信息位置, 在图像矩阵中提取特征码返回包含人脸特征的`CodeInfo`对象，提取特征失败则返回`null`
`CodeInfo[]`	`matGetCodeInfo(net.gdface.image.MatType matType, byte[] matData, int width, int height, int facenum, CodeInfo[] facePos)` 根据facePos提供的人脸信息位置, 在图像矩阵中提取特征码包含人脸特征数据的facePos
`java.lang.Boolean`	`matWearMask(net.gdface.image.MatType matType, byte[] matData, int width, int height, CodeInfo faceInfo)` 检测指定的人脸是否戴口罩返回值有三种状态: `true` 戴口罩返回 `false` 未戴口罩返回 `null` 不知道
`protected abstract double`	`nativeCompareCode(byte[] code1, byte[] code2)` 参见 `compareCode(byte[], byte[])`
`CodeInfo[]`	`nativeDetectAndGetFeatures(byte[] imgMatrix, int width, int height)` 检测并提取特征
`abstract void`	`nativeDetectFace(byte[] imgMatrix, int width, int height, java.util.List<CodeInfo> faceInfo)` 检测人脸
`abstract byte[]`	`nativeGetFaceFeature(byte[] imgMatrix, int width, int height, CodeInfo faceInfo)` 对faceinfo指定的人脸位置提取特征
`java.util.List<CodeInfo>`	`nativeGetFaceFeatures(byte[] imgMatrix, int width, int height, int faceNum, java.util.List<CodeInfo> facePos)` 对图像矩阵中指定的人脸位置`facePos`并提取特征码，返回生成人脸特征码数据数组对象（人脸可能不止一个）
`byte[][]`	`nativeGetFaceFeatures(byte[] imgMatrix, int width, int height, java.util.List<CodeInfo> facePos)` 根据检测到的人脸位置`facePos`,提取一组特征
`CodeInfo[]`	`nativeNv21DetectAndGetFeatures(byte[] nv21, int width, int height)` 检测并提取特征
`void`	`nativeNv21DetectFace(byte[] nv21, int width, int height, java.util.List<CodeInfo> faceInfo)` 对从视频流中直接获取的NV21图像进行人脸检测
`byte[]`	`nativeNv21GetFaceFeature(byte[] nv21, int width, int height, CodeInfo facePos)` 根据facePos提供的人脸信息位置, 在NV21格式图像中提取特征码
`byte[][]`	`nativeNv21GetFaceFeatures(byte[] nv21, int width, int height, java.util.List<CodeInfo> facePos)` 根据facePos提供的人脸信息位置, 在NV21格式图像中提取特征码
`java.lang.Boolean`	`nativeNv21WearMask(byte[] nv21, int width, int height, CodeInfo faceInfo)` 戴口罩检测检测方法
`java.lang.Boolean`	`nativeWearMask(byte[] imgMatrix, int width, int height, CodeInfo faceInfo)` 戴口罩检测检测方法
`java.util.Map<java.lang.String,java.lang.String>`	`sdkCapacity()` 返回当前SDK特性(能力)描述,已定义字段: SDK_VERSION [string]SDK版本号 MULTI_FACE_FEATURE [boolean]算法是否支持多人脸合成特征 FACE_LIVE [boolean]是否支持活体检测 WEAR_MASK [boolean]是否支持口罩检测 FDDATA_SIZE [int]人脸检测数据的(byte)长度 FEATURE_SIZE [int]人脸特征数据(byte)长度 MAX_FACE_COUNT [int]最大检测人脸数目 FSE_ENABLE [boolean]是否支持特征内存搜索引擎 CODEINFO_RELOCATE [boolean]是否支持CodeInfo对象重定位 LOCAL_DETECT [boolean] 人脸检测是否为本地实现,未定义则为false 以上字段名常量定义参见`CapacityFieldConstant`
`FseResult[]`	`searchFeatures(byte[] feature, double similarty, int rows)` 1:N 人脸特征搜索搜索与`code`相似度大于`similarty`的记录(最多返回前`rows`个结果) 返回包含相似度计算结果的`FseResult`数组,返回结果以相似度降序排列相似度值通过 `FseResult#getSimilartys()` 获取对应的人脸特征ID由 `FseResult#getFeatureIds()`获取
`static void`	`setAuxTool(IAuxTool auxTool)`
`protected byte[]`	`toNativeMatrix(net.gdface.image.MatType matType, byte[] matData, int width, int height)` 将指定的图像矩阵转为图像检测和建模的图像矩阵的(色彩空间)类型(参见 `BaseFaceApi.getNativeMatrixType()`)
`protected static byte[]`	`toNv21(net.gdface.image.MatType matType, byte[] matData, int width, int height)`
`java.lang.Boolean`	`wearMask(byte[] imgData, CodeInfo faceInfo)` 检测指定的人脸是否戴口罩返回值有三种状态: `true` 戴口罩返回 `false` 未戴口罩返回 `null` 不知道

Methods inherited from class net.gdface.sdk.BaseFaceApi
compare2Face, compareCodes, compareFaces, compareFeatures, detectAndCompare2Face, detectCenterFace, detectMaxFace, findMaxFace, getFeature, getFeatureSeInstance, hasFace, makeOpenedLazyImage, matDetectMaxFace, matHasFace, matSearchFaces, searchFaces

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - capacity
```
protected final java.util.Map<java.lang.String,java.lang.String> capacity
```
  - concurrentLock
```
protected static net.gdface.utils.ShareLock concurrentLock
```
    并发锁,限制建模的并发线程数,默认为CPU核数
  - auxTool
```
protected static IAuxTool auxTool
```
- Constructor Detail
  - BaseFaceApiLocal
```
protected BaseFaceApiLocal()
```
- Method Detail
  - setAuxTool
```
public static void setAuxTool(IAuxTool auxTool)
```
  - detectAndGetCodeInfo
```
public CodeInfo[] detectAndGetCodeInfo(byte[] imgData,
                                       int faceNum)
                                throws net.gdface.image.ImageErrorException,
                                       NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    先对图像数据imgData进行人脸检测，然后提取人脸特征码
    返回所有成功提取特征码的CodeInfo数组, 与FaceApi.getCodeInfo(byte[], int, CodeInfo[])的返回结果有差别，返回结果中不包含检测到人脸但提取特征码失败的对象
    
    Specified by:
    
    detectAndGetCodeInfo in interface FaceApi
    
    Parameters:
    
    imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
    
    faceNum - 参见 FaceApi.getCodeInfo(byte[], int, CodeInfo[])
    
    Returns:
    
    CodeInfo数组
    
    Throws:
    
    net.gdface.image.ImageErrorException
    
    NotFaceDetectedException - 没有检测人脸或提取到特征码的人脸数目不是要求的人脸数目(faceNum>0)
  - getCodeInfo
```
public java.util.List<CodeInfo> getCodeInfo(net.gdface.image.BaseLazyImage lazyImg,
                                            int faceNum,
                                            java.util.List<CodeInfo> facePos)
                                     throws NotFaceDetectedException
```
    对图像(lazyImg)中指定的人脸位置facePos并提取特征码，返回生成人脸特征码数据数组对象（人脸可能不止一个）
    调用该方法时假设图像(lazyImage)能正常解码,所以当对图像解码出现异常时，将异常对象封装到RuntimeException抛出
    
    Parameters:
    
    lazyImg - 图像对象,为null则抛出 IllegalArgumentException
    
    faceNum -
    
    facePos -
    
    Returns:
    
    返回CodeInfo对象列表
    对应于facePos中的每个FRect对象,返回一个CodeInfo对象(数组下标相同):
    如果FRect对象为null,则返回一个所有成员都为null的CodeInfo对象
    如果在FRect指定的范围没有提取到特征码,则CodeInfo.getCode(),CodeInfo.getEi()返回null
    
    Throws:
    
    NotFaceDetectedException
    
    See Also:
    
    #getCodeFromImageMatrix(byte[], int, int, CodeInfo, AtomicBoolean), FaceApi.getCodeInfo(byte[], int, CodeInfo[])
  - getCodeInfo
```
public CodeInfo getCodeInfo(net.gdface.image.BaseLazyImage lazyImg,
                            CodeInfo facePos)
```
    提取单个人脸特征
    
    Parameters:
    
    lazyImg -
    
    facePos -
    
    Returns:
  - getCodeInfo
```
public CodeInfo getCodeInfo(byte[] imgData,
                            CodeInfo facePos)
```
    Description copied from interface: FaceApi
    
    根据facePos提供的人脸信息位置, 在imgData图像中提取特征码
    返回包含人脸特征的CodeInfo对象，提取特征失败则返回null
    
    Specified by:
    
    getCodeInfo in interface FaceApi
    
    Parameters:
    
    imgData - 图像数据(jpg,png...)字节数组,为null则抛出 IllegalArgumentException
    
    facePos - 人脸位置信息对象，为null则抛出异常
    
    Returns:
    
    CodeInfo or null
  - wearMask
```
public java.lang.Boolean wearMask(byte[] imgData,
                                  CodeInfo faceInfo)
                           throws net.gdface.image.ImageErrorException
```
    Description copied from interface: FaceApi
    检测指定的人脸是否戴口罩
    返回值有三种状态:
    - true 戴口罩返回
    - false 未戴口罩返回
    - null 不知道
    Specified by:
    
    wearMask in interface FaceApi
    
    Parameters:
    
    imgData - 图像数据(jpg,png...)字节数组,为null则抛出 IllegalArgumentException
    
    faceInfo - 可见光图像人脸信息
    
    Returns:
    
    返回口罩检测结果
    
    Throws:
    
    net.gdface.image.ImageErrorException
  - detectAndGetCodeInfo
```
public CodeInfo[] detectAndGetCodeInfo(net.gdface.image.BaseLazyImage lazyImg,
                                       int faceNum)
                                throws net.gdface.image.ImageErrorException,
                                       NotFaceDetectedException
```
    先对图像数据imgData进行人脸检测，然后提取人脸特征码
    
    Parameters:
    
    lazyImg -
    
    faceNum -
    
    Returns:
    
    Throws:
    
    net.gdface.image.ImageErrorException
    
    NotFaceDetectedException
    
    See Also:
    
    detectAndGetCodeInfo(byte[], int)
  - detectFace
```
public CodeInfo[] detectFace(byte[] imgData)
                      throws net.gdface.image.ImageErrorException
```
    Description copied from interface: FaceApi
    
    对图像(imgData)进行人脸检测，返回人脸位置数据对象CodeInfo数组
    没有检测到人脸则返回空数组
    
    Specified by:
    
    detectFace in interface FaceApi
    
    Parameters:
    
    imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
    
    Returns:
    
    CodeInfo数组
    
    Throws:
    
    net.gdface.image.ImageErrorException - 图像读取错误
  - getCodeInfo
```
public CodeInfo[] getCodeInfo(byte[] imgData,
                              int faceNum,
                              CodeInfo[] facePos)
                       throws NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    根据facePos提供的人脸信息位置, 在imgData图像中提取特征码
    与 FaceApi.detectAndGetCodeInfo(byte[], int)不同, 本方法不对图像数据imgData进行人脸检测,
    假设facePos是 FaceApi.detectFace(byte[])或 #detectFaceAgain(byte[], FRect[]) 的返回结果
    返回facePos,如果没有提取到特征码,则对应元素CodeInfo.getCode()返回null
    
    Specified by:
    
    getCodeInfo in interface FaceApi
    
    Parameters:
    
    imgData - 图像数据(jpg,png...)字节数组,为null则抛出 IllegalArgumentException
    
    faceNum - 要求返回的人脸特征码数目
    大于0时，如果实际提取到的人脸特征码数目不等于faceNum,则抛出NotFaceDetectedException
    小于等于0时，返回所有提取到到人脸特征码
    
    facePos - 检测到的人脸位置对象列表
    为null或数组长度为0时抛出IllegalArgumentException
    如果元素为null,则跳过
    
    Returns:
    
    返回facePos
    
    Throws:
    
    NotFaceDetectedException - 提取特征码的人脸数目为0或没有提取到指定数目(faceNum大于0时)的特征码
  - compareCode
```
public final double compareCode(byte[] code1,
                                byte[] code2)
```
    Description copied from interface: FaceApi
    
    特征码比对
    参数为null或长度不一致则抛出IllegalArgumentException异常,返回两个特征码之间的相似度（0.0~1）
    
    Specified by:
    
    compareCode in interface FaceApi
    
    Parameters:
    
    code1 - 待比对的特征码
    
    code2 - 待比对的特征码
    
    Returns:
    
    相似度（0.0~1）
  - matDetectFace
```
public CodeInfo[] matDetectFace(net.gdface.image.MatType matType,
                                byte[] matData,
                                int width,
                                int height)
```
    Description copied from interface: FaceApi
    
    对图像矩阵进行人脸检测
    返回人脸信息对象列表，没有检测到人脸返回空表
    
    Specified by:
    
    matDetectFace in interface FaceApi
    
    Parameters:
    
    matType - 图像矩阵类型
    
    matData - 图像矩阵
    
    width - 图像宽度
    
    height - 图像高度
    
    Returns:
    
    人脸信息对象列表
  - matGetCodeInfo
```
public CodeInfo[] matGetCodeInfo(net.gdface.image.MatType matType,
                                 byte[] matData,
                                 int width,
                                 int height,
                                 int facenum,
                                 CodeInfo[] facePos)
                          throws NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    根据facePos提供的人脸信息位置, 在图像矩阵中提取特征码
    包含人脸特征数据的facePos
    
    Specified by:
    
    matGetCodeInfo in interface FaceApi
    
    Parameters:
    
    matType - 图像矩阵类型
    
    matData - 图像矩阵
    
    width - 图像宽度
    
    height - 图像高度
    
    facenum - 要求返回的人脸特征码数目
    大于0时，如果实际提取到的人脸特征码数目不等于faceNum,则抛出NotFaceDetectedException
    小于等于0时，返回所有提取到到人脸特征码
    
    facePos - 人脸位置信息对象,不可为null
    
    Returns:
    
    always facePos
    
    Throws:
    
    NotFaceDetectedException - 提取特征码的人脸数目为0或没有提取到指定数目(faceNum大于0时)的特征码
  - matGetCodeInfo
```
public CodeInfo matGetCodeInfo(net.gdface.image.MatType matType,
                               byte[] matData,
                               int width,
                               int height,
                               CodeInfo facePos)
```
    Description copied from interface: FaceApi
    
    根据facePos提供的人脸信息位置, 在图像矩阵中提取特征码
    返回包含人脸特征的CodeInfo对象，提取特征失败则返回null
    
    Specified by:
    
    matGetCodeInfo in interface FaceApi
    
    Parameters:
    
    matType - 图像矩阵类型
    
    matData - 图像矩阵
    
    width - 图像宽度
    
    height - 图像高度
    
    facePos - 人脸位置信息对象，为null则抛出异常
    
    Returns:
    
    CodeInfo or null
  - matDetectAndGetCodeInfo
```
public CodeInfo[] matDetectAndGetCodeInfo(net.gdface.image.MatType matType,
                                          byte[] matData,
                                          int width,
                                          int height,
                                          int faceNum)
                                   throws NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    先对图像矩阵数据imgData进行人脸检测，然后提取人脸特征码
    返回包含人脸特征数据的CodeInfo数组
    
    Specified by:
    
    matDetectAndGetCodeInfo in interface FaceApi
    
    Parameters:
    
    matType - 图像矩阵类型
    
    matData - 图像矩阵
    
    width - 图像宽度
    
    height - 图像高度
    
    faceNum - 参见 FaceApi.getCodeInfo(byte[], int, CodeInfo[])
    
    Returns:
    
    CodeInfo数组
    
    Throws:
    
    NotFaceDetectedException
  - matWearMask
```
public java.lang.Boolean matWearMask(net.gdface.image.MatType matType,
                                     byte[] matData,
                                     int width,
                                     int height,
                                     CodeInfo faceInfo)
```
    Description copied from interface: FaceApi
    检测指定的人脸是否戴口罩
    返回值有三种状态:
    - true 戴口罩返回
    - false 未戴口罩返回
    - null 不知道
    Specified by:
    
    matWearMask in interface FaceApi
    
    Parameters:
    
    matType - 图像矩阵类型
    
    matData - 图像矩阵
    
    width - 图像宽度
    
    height - 图像高度
    
    faceInfo - 人脸位置信息
    
    Returns:
    
    返回口罩检测结果
  - getFeatureSe
```
public FeatureSe getFeatureSe()
```
    返回当前FaceApi接口实例对应的搜索引擎接口实例，如果没有则返回null
    
    Returns:
  - isLocal
```
public boolean isLocal()
```
    Description copied from interface: FaceApi
    
    返回当前接口实现方式
    false WebService类型
    true 本地实现
    
    Specified by:
    
    isLocal in interface FaceApi
    
    Returns:
    
    boolean
  - sdkCapacity
```
public java.util.Map<java.lang.String,java.lang.String> sdkCapacity()
```
    Description copied from interface: FaceApi
    返回当前SDK特性(能力)描述,已定义字段:
    - SDK_VERSION [string]SDK版本号
    - MULTI_FACE_FEATURE [boolean]算法是否支持多人脸合成特征
    - FACE_LIVE [boolean]是否支持活体检测
    - WEAR_MASK [boolean]是否支持口罩检测
    - FDDATA_SIZE [int]人脸检测数据的(byte)长度
    - FEATURE_SIZE [int]人脸特征数据(byte)长度
    - MAX_FACE_COUNT [int]最大检测人脸数目
    - FSE_ENABLE [boolean]是否支持特征内存搜索引擎
    - CODEINFO_RELOCATE [boolean]是否支持CodeInfo对象重定位
    - LOCAL_DETECT [boolean] 人脸检测是否为本地实现,未定义则为false
    以上字段名常量定义参见CapacityFieldConstant
    Specified by:
    
    sdkCapacity in interface FaceApi
    
    Returns:
    
    key-value 对描述算法能力的映射
  - detectFace
```
public java.util.List<CodeInfo> detectFace(net.gdface.image.BaseLazyImage lazyImg)
                                    throws net.gdface.image.UnsupportedFormatException
```
    对图像(lazyImg)进行人脸检测，返回人脸位置数据对象CodeInfo列表
    
    Parameters:
    
    lazyImg - 图像对象,为null时抛出IllegalArgumentException
    
    Returns:
    
    没有检测到人脸则返回空表
    
    Throws:
    
    net.gdface.image.UnsupportedFormatException
  - getNativeMatrixType
```
protected net.gdface.image.MatType getNativeMatrixType()
```
    Description copied from class: BaseFaceApi
    
    返回用于图像检测和建模的图像矩阵的(色彩空间)类型
    不可返回null
    
    Specified by:
    
    getNativeMatrixType in class BaseFaceApi
    
    Returns:
    
    矩阵类型
  - toNativeMatrix
```
protected byte[] toNativeMatrix(net.gdface.image.MatType matType,
                                byte[] matData,
                                int width,
                                int height)
```
    Description copied from class: BaseFaceApi
    
    将指定的图像矩阵转为图像检测和建模的图像矩阵的(色彩空间)类型(参见 BaseFaceApi.getNativeMatrixType())
    
    Specified by:
    
    toNativeMatrix in class BaseFaceApi
    
    Parameters:
    
    matType - 输入矩阵类型
    
    matData - 矩阵数据
    
    width - 矩阵宽度
    
    height - 矩阵高度
    
    Returns:
    
    转换后的矩阵数据
  - nativeCompareCode
```
protected abstract double nativeCompareCode(byte[] code1,
                                            byte[] code2)
```
    参见 compareCode(byte[], byte[])
    
    Parameters:
    
    code1 -
    
    code2 -
    
    Returns:
  - nativeDetectFace
```
public abstract void nativeDetectFace(byte[] imgMatrix,
                                      int width,
                                      int height,
                                      java.util.List<CodeInfo> faceInfo)
```
    检测人脸
    
    Parameters:
    
    imgMatrix - 图像矩阵数据,数据格式要求与算法相关
    
    width - 图像宽度
    
    height - 图像高度
    
    faceInfo - 保存检测到的人脸位置信息
  - nativeGetFaceFeature
```
public abstract byte[] nativeGetFaceFeature(byte[] imgMatrix,
                                            int width,
                                            int height,
                                            CodeInfo faceInfo)
```
    对faceinfo指定的人脸位置提取特征
    
    Parameters:
    
    imgMatrix - 图像矩阵数据,数据格式要求与算法相关
    
    width - 图像宽度
    
    height - 图像高度
    
    faceInfo -
    
    Returns:
    
    人脸特征数据,提取特征失败则返回null
  - nativeGetFaceFeatures
```
public java.util.List<CodeInfo> nativeGetFaceFeatures(byte[] imgMatrix,
                                                      int width,
                                                      int height,
                                                      int faceNum,
                                                      java.util.List<CodeInfo> facePos)
                                               throws NotFaceDetectedException
```
    对图像矩阵中指定的人脸位置facePos并提取特征码，返回生成人脸特征码数据数组对象（人脸可能不止一个）
    
    Parameters:
    
    imgMatrix - 图像矩阵数据,数据格式要求与算法相关
    
    width - 图像宽度
    
    height - 图像高度
    
    faceNum -
    
    facePos -
    
    Returns:
    
    返回CodeInfo对象列表
    对应于facePos中的每个FRect对象,返回一个CodeInfo对象(数组下标相同):
    如果FRect对象为null,则返回一个所有成员都为null的CodeInfo对象
    如果在FRect指定的范围没有提取到特征码,则CodeInfo.getCode(),CodeInfo.getEi()返回null
    
    Throws:
    
    NotFaceDetectedException
    
    See Also:
    
    #nativeGetFaceFeatures(byte[], int, int, List)}
  - nativeGetFaceFeatures
```
public byte[][] nativeGetFaceFeatures(byte[] imgMatrix,
                                      int width,
                                      int height,
                                      java.util.List<CodeInfo> facePos)
```
    根据检测到的人脸位置facePos,提取一组特征
    
    Parameters:
    
    imgMatrix - 图像矩阵数据,数据格式要求与算法相关
    
    width - 图像宽度
    
    height - 图像高度
    
    facePos -
    
    Returns:
    
    返回facePos列表中每个人脸位置对应的人脸特征数据，提取特征失败的对应为null
  - nativeDetectAndGetFeatures
```
public CodeInfo[] nativeDetectAndGetFeatures(byte[] imgMatrix,
                                             int width,
                                             int height)
```
    检测并提取特征
    
    Parameters:
    
    imgMatrix - 图像矩阵数据,数据格式要求与算法相关
    
    width - 图像宽度
    
    height - 图像高度
    
    Returns:
    
    包含人脸特征数据的CodeInfo数组
  - nativeNv21DetectFace
```
public void nativeNv21DetectFace(byte[] nv21,
                                 int width,
                                 int height,
                                 java.util.List<CodeInfo> faceInfo)
```
    对从视频流中直接获取的NV21图像进行人脸检测
    
    Parameters:
    
    nv21 - NV21格式图像
    
    width - 图像宽度
    
    height - 图像高度
    
    faceInfo - 人脸信息对象列表
  - nativeNv21GetFaceFeature
```
public byte[] nativeNv21GetFaceFeature(byte[] nv21,
                                       int width,
                                       int height,
                                       CodeInfo facePos)
```
    根据facePos提供的人脸信息位置, 在NV21格式图像中提取特征码
    
    Parameters:
    
    nv21 - NV21格式图像
    
    width - 图像宽度
    
    height - 图像高度
    
    facePos - 人脸位置信息对象,不可为null
    
    Returns:
    
    包含人脸特征数据的CodeInfo对象
  - nativeNv21GetFaceFeatures
```
public byte[][] nativeNv21GetFaceFeatures(byte[] nv21,
                                          int width,
                                          int height,
                                          java.util.List<CodeInfo> facePos)
```
    根据facePos提供的人脸信息位置, 在NV21格式图像中提取特征码
    
    Parameters:
    
    nv21 - NV21格式图像
    
    width - 图像宽度
    
    height - 图像高度
    
    facePos - 人脸位置信息对象,不可为null
    
    Returns:
    
    包含人脸特征数据的CodeInfo对象
  - nativeNv21DetectAndGetFeatures
```
public CodeInfo[] nativeNv21DetectAndGetFeatures(byte[] nv21,
                                                 int width,
                                                 int height)
```
    检测并提取特征
    
    Parameters:
    
    nv21 - NV21格式图像矩阵数据
    
    width - 图像宽度
    
    height - 图像高度
    
    Returns:
    
    包含人脸特征数据的CodeInfo数组
  - nativeWearMask
```
public java.lang.Boolean nativeWearMask(byte[] imgMatrix,
                                        int width,
                                        int height,
                                        CodeInfo faceInfo)
```
    戴口罩检测检测方法
    
    Parameters:
    
    imgMatrix - 图像矩阵数据,数据格式要求与算法相关
    
    width - 图像宽度
    
    height - 图像高度
    
    faceInfo - 可见光图像人脸信息
    
    Returns:
    
    戴口罩返回true,否则返回false,null 不知道
  - nativeNv21WearMask
```
public java.lang.Boolean nativeNv21WearMask(byte[] nv21,
                                            int width,
                                            int height,
                                            CodeInfo faceInfo)
```
    戴口罩检测检测方法
    
    Parameters:
    
    nv21 - NV21格式图像矩阵数据
    
    width - 图像宽度
    
    height - 图像高度
    
    faceInfo - 可见光图像人脸信息
    
    Returns:
    
    戴口罩返回true,否则返回false,null 不知道
  - searchFeatures
```
public FseResult[] searchFeatures(byte[] feature,
                                  double similarty,
                                  int rows)
```
    Description copied from interface: FaceApi
    
    1:N 人脸特征搜索
    搜索与code相似度大于similarty的记录(最多返回前rows个结果)
    返回包含相似度计算结果的FseResult数组,返回结果以相似度降序排列
    相似度值通过 FseResult#getSimilartys() 获取
    对应的人脸特征ID由 FseResult#getFeatureIds()获取
    
    Specified by:
    
    searchFeatures in interface FaceApi
    
    Parameters:
    
    feature - 要搜索的特征码
    
    similarty - 相似度阀值
    
    rows - 最多返回的记录数目
    
    Returns:
    
    包含相似度计算结果的FseResult数组
  - fromNv21
```
protected static byte[] fromNv21(net.gdface.image.MatType matType,
                                 byte[] nv21,
                                 int width,
                                 int height)
```
  - toNv21
```
protected static byte[] toNv21(net.gdface.image.MatType matType,
                               byte[] matData,
                               int width,
                               int height)
```

Class BaseFaceApiLocal

Field Summary

Fields inherited from interface net.gdface.sdk.CapacityFieldConstant

Constructor Summary

Method Summary

Methods inherited from class net.gdface.sdk.BaseFaceApi

Methods inherited from class java.lang.Object

Field Detail

capacity

concurrentLock

auxTool

Constructor Detail

BaseFaceApiLocal

Method Detail

setAuxTool

detectAndGetCodeInfo

getCodeInfo

getCodeInfo

getCodeInfo

wearMask

detectAndGetCodeInfo

detectFace

getCodeInfo

compareCode

matDetectFace

matGetCodeInfo

matGetCodeInfo

matDetectAndGetCodeInfo

matWearMask

getFeatureSe

isLocal

sdkCapacity

detectFace

getNativeMatrixType

toNativeMatrix

nativeCompareCode

nativeDetectFace

nativeGetFaceFeature

nativeGetFaceFeatures

nativeGetFaceFeatures

nativeDetectAndGetFeatures

nativeNv21DetectFace

nativeNv21GetFaceFeature

nativeNv21GetFaceFeatures

nativeNv21DetectAndGetFeatures

nativeWearMask

nativeNv21WearMask

searchFeatures

fromNv21

toNv21