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

java.lang.Object
- net.gdface.sdk.FaceApiDecorator

All Implemented Interfaces:

FaceApi

Direct Known Subclasses:

FaceApiGenericDecorator
```
public class FaceApiDecorator
extends java.lang.Object
implements FaceApi
```
decorator pattern 装饰者模式实现FaceApi接口
转发所有FaceApi接口方法到delegate()指定的实例,
unchecked后缀的方法将所有显式申明的异常封装到RuntimeException抛出
计算机生成代码(generated by automated tools DecoratorGenerator @author guyadong)

Author:

guyadong

Constructor Summary

Constructors
Constructor and Description

FaceApiDecorator(FaceApi delegate)

Constructors
Constructor and Description
`FaceApiDecorator(FaceApi delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`compare2Face(byte[] imgData1, CodeInfo facePos1, byte[] imgData2, CodeInfo facePos2)` 对人脸图像提取特征码，返回比较相似度结果 imgData1和imgData2相等或imgData2为`null`时,即比较同一张图像中的两张人脸的相似度调用该方法时假设图像(`imgData1`和`imgData2`)能正常解码, 所以当对图像解码出现异常时，将`ImageErrorException`异常对象封装到`RuntimeException`抛出任何参数为`null`则抛出`IllegalArgumentException`
`double`	`compare2FaceUnchecked(byte[] imgData1, CodeInfo facePos1, byte[] imgData2, CodeInfo facePos2)` `FaceApi.compare2Face(byte[],CodeInfo,byte[],CodeInfo)`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`double`	`compareCode(byte[] code1, byte[] code2)` 特征码比对参数为`null`或长度不一致则抛出`IllegalArgumentException`异常,返回两个特征码之间的相似度（0.0~1）
`double[]`	`compareCodes(byte[] code1, CodeInfo[] codes)` 特征码比对1:N 返回对应的特征码相似度数组
`CompareResult`	`compareFaces(byte[] code, byte[] imgData, int faceNum)` 特征码比对1:N 对`imgData`图像数据检测人脸并提取特征，然后与`code`特征进行比对, 返回包含比对相似度结果的`CompareResult`实例
`CompareResult`	`compareFacesUnchecked(byte[] code, byte[] imgData, int faceNum)` `FaceApi.compareFaces(byte[],byte[],int)`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`java.util.List<java.lang.Double>`	`compareFeatures(byte[] code1, java.util.List<byte[]> codes)` 特征码比对1:N
`FaceApi`	`delegate()`
`double`	`detectAndCompare2Face(byte[] imgData1, FRect detectRect1, byte[] imgData2, FRect detectRect2)` 对两个图像指定范围(`FRect`)进行人脸检测,找到并提取唯一的人脸特征码,然后比较相似度,返回相似度结果 imgData1和imgData2相等或imgData2为`null`时, 即比较同一张图像中的两张人脸的相似度,这种情况下detectRect1和detectRect2都不能为`null` imgData1和imgData2不相等且都不为`null`时,detectRect1和detectRect2被忽略
`double`	`detectAndCompare2FaceUnchecked(byte[] imgData1, FRect detectRect1, byte[] imgData2, FRect detectRect2)` `FaceApi.detectAndCompare2Face(byte[],FRect,byte[],FRect)`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`CodeInfo[]`	`detectAndGetCodeInfo(byte[] imgData, int faceNum)` 先对图像数据`imgData`进行人脸检测，然后提取人脸特征码返回所有成功提取特征码的`CodeInfo`数组, 与`FaceApi.getCodeInfo(byte[], int, CodeInfo[])`的返回结果有差别，返回结果中不包含检测到人脸但提取特征码失败的对象
`CodeInfo[]`	`detectAndGetCodeInfoUnchecked(byte[] imgData, int faceNum)` `FaceApi.detectAndGetCodeInfo(byte[],int)`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`CodeInfo`	`detectCenterFace(byte[] imgData)` 检测最中心的人脸返回人脸位置数据对象`CodeInfo`
`CodeInfo`	`detectCenterFaceUnchecked(byte[] imgData)` `FaceApi.detectCenterFace(byte[])`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`CodeInfo[]`	`detectFace(byte[] imgData)` 对图像(`imgData`)进行人脸检测，返回人脸位置数据对象`CodeInfo`数组没有检测到人脸则返回空数组
`CodeInfo[]`	`detectFaceUnchecked(byte[] imgData)` `FaceApi.detectFace(byte[])`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`CodeInfo`	`detectMaxFace(byte[] imgData)` 检测最大的人脸返回人脸位置数据对象`CodeInfo`
`CodeInfo`	`detectMaxFaceUnchecked(byte[] imgData)` `FaceApi.detectMaxFace(byte[])`对应的unchecked方法, 所有显式申明的异常都被封装到`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`
`CodeInfo[]`	`getCodeInfoUnchecked(byte[] imgData, int faceNum, CodeInfo[] facePos)` `FaceApi.getCodeInfo(byte[],int,net.gdface.sdk.CodeInfo[])`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`byte[]`	`getFeature(java.util.Map<java.nio.ByteBuffer,CodeInfo> faces)` 多张人脸提取特征(用于多张人脸合成一个特征的算法) 返回人脸特征数据 `#multiFaceFeature()`返回`false`时代表此方法未被实现，执行会抛出异常
`byte[]`	`getFeatureUnchecked(java.util.Map<java.nio.ByteBuffer,CodeInfo> faces)` `FaceApi.getFeature(Map)`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`boolean`	`hasFace(byte[] imgData)` 判断图像是否能提取到人脸特征码为`true`则能检测到人脸并能提取特征码
`boolean`	`hasFaceUnchecked(byte[] imgData)` `FaceApi.hasFace(byte[])`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`boolean`	`isLocal()` 返回当前接口实现方式 false WebService类型 true 本地实现
`static FaceApiDecorator`	`makeDecorator(FaceApi instance)` 将 `FaceApi` 对象封装为 FaceApiDecorator 实例如果 `FaceApi` 已经是 FaceApiDecorator 则返回 FaceApi}
`CodeInfo[]`	`matDetectAndGetCodeInfo(net.gdface.image.MatType matType, byte[] matData, int width, int height, int faceNum)` 先对图像矩阵数据`imgData`进行人脸检测，然后提取人脸特征码返回包含人脸特征数据的`CodeInfo`数组
`CodeInfo[]`	`matDetectAndGetCodeInfoUnchecked(net.gdface.image.MatType matType, byte[] matData, int width, int height, int faceNum)` `FaceApi.matDetectAndGetCodeInfo(MatType,byte[],int,int,int)`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`CodeInfo[]`	`matDetectFace(net.gdface.image.MatType matType, byte[] matData, int width, int height)` 对图像矩阵进行人脸检测返回人脸信息对象列表，没有检测到人脸返回空表
`CodeInfo`	`matDetectMaxFace(net.gdface.image.MatType matType, byte[] matData, int width, int height)` 检测最大的人脸返回人脸位置数据对象`CodeInfo`
`CodeInfo`	`matDetectMaxFaceUnchecked(net.gdface.image.MatType matType, byte[] matData, int width, int height)` `FaceApi.matDetectMaxFace(MatType,byte[],int,int)`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`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
`CodeInfo[]`	`matGetCodeInfoUnchecked(net.gdface.image.MatType matType, byte[] matData, int width, int height, int facenum, CodeInfo[] facePos)` `FaceApi.matGetCodeInfo(MatType,byte[],int,int,int,net.gdface.sdk.CodeInfo[])`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`boolean`	`matHasFace(net.gdface.image.MatType matType, byte[] matData, int width, int height)` 判断图像矩阵是否能提取到人脸特征码返回为`true`则能检测到人脸并能提取特征码
`FseResult[]`	`matSearchFaces(net.gdface.image.MatType matType, byte[] matData, int width, int height, CodeInfo facePos, double similarty, int rows)` 1:N 人脸图像搜索对`facePos`指定的人脸位置提取特征码,然后在数据库中搜索相似的人脸返回搜索结果。返回包含相似度计算结果的FseResult数组相似度值通过 FseResult.getSimilartys() 获取对应的人脸特征ID由 FseResult.getFeatureIds()获取
`FseResult[]`	`matSearchFacesUnchecked(net.gdface.image.MatType matType, byte[] matData, int width, int height, CodeInfo facePos, double similarty, int rows)` `FaceApi.matSearchFaces(MatType,byte[],int,int,CodeInfo,double,int)`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`java.lang.Boolean`	`matWearMask(net.gdface.image.MatType matType, byte[] matData, int width, int height, CodeInfo faceInfo)` 检测指定的人脸是否戴口罩返回值有三种状态: `true` 戴口罩返回 `false` 未戴口罩返回 `null` 不知道
`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[]`	`searchFaces(byte[] imgData, CodeInfo facePos, double similarty, int rows)` 1:N 人脸图像搜索对`facePos`指定的人脸位置提取特征码,然后在数据库中搜索相似的人脸返回搜索结果。返回包含相似度计算结果的FseResult数组相似度值通过 FseResult.getSimilartys() 获取对应的人脸特征ID由 FseResult.getFeatureIds()获取
`FseResult[]`	`searchFacesUnchecked(byte[] imgData, CodeInfo facePos, double similarty, int rows)` `FaceApi.searchFaces(byte[],CodeInfo,double,int)`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出
`FseResult[]`	`searchFeatures(byte[] feature, double similarty, int rows)` 1:N 人脸特征搜索搜索与`code`相似度大于`similarty`的记录(最多返回前`rows`个结果) 返回包含相似度计算结果的`FseResult`数组,返回结果以相似度降序排列相似度值通过 `FseResult#getSimilartys()` 获取对应的人脸特征ID由 `FseResult#getFeatureIds()`获取
`java.lang.Boolean`	`wearMask(byte[] imgData, CodeInfo faceInfo)` 检测指定的人脸是否戴口罩返回值有三种状态: `true` 戴口罩返回 `false` 未戴口罩返回 `null` 不知道
`java.lang.Boolean`	`wearMaskUnchecked(byte[] imgData, CodeInfo faceInfo)` `FaceApi.wearMask(byte[],CodeInfo)`对应的unchecked方法, 所有显式申明的异常都被封装到`RuntimeException`抛出

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

- Constructor Detail
  - FaceApiDecorator
```
public FaceApiDecorator(FaceApi delegate)
```
- Method Detail
  - makeDecorator
```
public static final FaceApiDecorator makeDecorator(FaceApi instance)
```
    将 FaceApi 对象封装为 FaceApiDecorator 实例
    如果 FaceApi 已经是 FaceApiDecorator 则返回 FaceApi}
    
    Parameters:
    
    instance -
    
    Returns:
    
    FaceApiDecorator 实例
  - delegate
```
public FaceApi delegate()
```
    Returns:
    
    FaceApi 返回被装饰的FaceApi实例
  - compare2Face
```
public double compare2Face(byte[] imgData1,
                           CodeInfo facePos1,
                           byte[] imgData2,
                           CodeInfo facePos2)
                    throws net.gdface.image.ImageErrorException,
                           NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    对人脸图像提取特征码，返回比较相似度结果
    imgData1和imgData2相等或imgData2为null时,即比较同一张图像中的两张人脸的相似度调用该方法时假设图像(imgData1和imgData2)能正常解码,
    所以当对图像解码出现异常时，将ImageErrorException异常对象封装到RuntimeException抛出
    任何参数为null则抛出IllegalArgumentException
    
    Specified by:
    
    compare2Face in interface FaceApi
    
    Parameters:
    
    imgData1 - 图像1数据(jpg,png...)字节数组
    
    facePos1 - 检测到的人脸/眼睛位置
    
    imgData2 - 图像1数据(jpg,png...)字节数组
    
    facePos2 - 检测到的人脸/眼睛位置
    
    Returns:
    
    两张人脸之间的相似度(0.0~1)
    
    Throws:
    
    net.gdface.image.ImageErrorException
    
    NotFaceDetectedException
    
    See Also:
    
    FaceApi.getCodeInfo(byte[], int, CodeInfo[]), FaceApi.compareCode(byte[], byte[])
  - compare2FaceUnchecked
```
public double compare2FaceUnchecked(byte[] imgData1,
                                    CodeInfo facePos1,
                                    byte[] imgData2,
                                    CodeInfo facePos2)
```
    FaceApi.compare2Face(byte[],CodeInfo,byte[],CodeInfo)对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    imgData1 - imgData1
    
    facePos1 - facePos1
    
    imgData2 - imgData2
    
    facePos2 - facePos2
    
    Returns:
    
    double
  - compareCode
```
public 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）
  - compareCodes
```
public double[] compareCodes(byte[] code1,
                             CodeInfo[] codes)
```
    Description copied from interface: FaceApi
    
    特征码比对1:N
    返回对应的特征码相似度数组
    
    Specified by:
    
    compareCodes in interface FaceApi
    
    Parameters:
    
    code1 - 待比对的特征码
    
    codes - 包含人脸特征的CodeInfo数组
    
    Returns:
    
    特征码相似度数组
  - compareFaces
```
public CompareResult compareFaces(byte[] code,
                                  byte[] imgData,
                                  int faceNum)
                           throws net.gdface.image.ImageErrorException,
                                  NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    特征码比对1:N
    对imgData图像数据检测人脸并提取特征，然后与code特征进行比对, 返回包含比对相似度结果的CompareResult实例
    
    Specified by:
    
    compareFaces in interface FaceApi
    
    Parameters:
    
    code - 人脸特征数据
    
    imgData - 待比对的图像(jpg,png...)(可能有多张人脸)
    
    faceNum - 参见 FaceApi.getCodeInfo(byte[], int, CodeInfo[])
    
    Returns:
    
    CompareResult实例
    
    Throws:
    
    net.gdface.image.ImageErrorException
    
    NotFaceDetectedException - 没有检测到人脸
    
    See Also:
    
    FaceApi.compareCodes(byte[], CodeInfo[]), FaceApi.detectAndGetCodeInfo(byte[], int)
  - compareFacesUnchecked
```
public CompareResult compareFacesUnchecked(byte[] code,
                                           byte[] imgData,
                                           int faceNum)
```
    FaceApi.compareFaces(byte[],byte[],int)对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    code - code
    
    imgData - imgData
    
    faceNum - faceNum
    
    Returns:
    
    CompareResult
  - compareFeatures
```
public java.util.List<java.lang.Double> compareFeatures(byte[] code1,
                                                        java.util.List<byte[]> codes)
```
    Description copied from interface: FaceApi
    
    特征码比对1:N
    
    Specified by:
    
    compareFeatures in interface FaceApi
    
    Parameters:
    
    code1 - 人脸特征数据
    
    codes - 一组人脸特征
    
    Returns:
    
    返回对应的特征码相似度列表
  - detectAndCompare2Face
```
public double detectAndCompare2Face(byte[] imgData1,
                                    FRect detectRect1,
                                    byte[] imgData2,
                                    FRect detectRect2)
                             throws net.gdface.image.ImageErrorException,
                                    NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    对两个图像指定范围(FRect)进行人脸检测,找到并提取唯一的人脸特征码,然后比较相似度,返回相似度结果
    imgData1和imgData2相等或imgData2为null时, 即比较同一张图像中的两张人脸的相似度,这种情况下detectRect1和detectRect2都不能为null
    imgData1和imgData2不相等且都不为null时,detectRect1和detectRect2被忽略
    
    Specified by:
    
    detectAndCompare2Face in interface FaceApi
    
    Parameters:
    
    imgData1 - 图像1数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
    
    detectRect1 - 图片检测范围，为null时全图检测
    
    imgData2 - 图像2数据(jpg,png...)字节数组
    
    detectRect2 - 图片检测范围，为null时全图检测
    
    Returns:
    
    两张人脸之间的相似度(0.0~1)
    
    Throws:
    
    net.gdface.image.ImageErrorException
    
    NotFaceDetectedException
    
    See Also:
    
    FaceApi.detectAndGetCodeInfo(byte[], int), FaceApi.compareCode(byte[], byte[])
  - detectAndCompare2FaceUnchecked
```
public double detectAndCompare2FaceUnchecked(byte[] imgData1,
                                             FRect detectRect1,
                                             byte[] imgData2,
                                             FRect detectRect2)
```
    FaceApi.detectAndCompare2Face(byte[],FRect,byte[],FRect)对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    imgData1 - imgData1
    
    detectRect1 - detectRect1
    
    imgData2 - imgData2
    
    detectRect2 - detectRect2
    
    Returns:
    
    double
  - 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)
  - detectAndGetCodeInfoUnchecked
```
public CodeInfo[] detectAndGetCodeInfoUnchecked(byte[] imgData,
                                                int faceNum)
```
    FaceApi.detectAndGetCodeInfo(byte[],int)对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    imgData - imgData
    
    faceNum - faceNum
    
    Returns:
    
    CodeInfo[]
  - detectCenterFace
```
public CodeInfo detectCenterFace(byte[] imgData)
                          throws net.gdface.image.ImageErrorException,
                                 NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    检测最中心的人脸
    返回人脸位置数据对象CodeInfo
    
    Specified by:
    
    detectCenterFace in interface FaceApi
    
    Parameters:
    
    imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
    
    Returns:
    
    CodeInfo
    
    Throws:
    
    net.gdface.image.ImageErrorException
    
    NotFaceDetectedException
  - detectCenterFaceUnchecked
```
public CodeInfo detectCenterFaceUnchecked(byte[] imgData)
```
    FaceApi.detectCenterFace(byte[])对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    imgData - imgData
    
    Returns:
    
    CodeInfo
  - 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 - 图像读取错误
  - detectFaceUnchecked
```
public CodeInfo[] detectFaceUnchecked(byte[] imgData)
```
    FaceApi.detectFace(byte[])对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    imgData - imgData
    
    Returns:
    
    CodeInfo[]
  - detectMaxFace
```
public CodeInfo detectMaxFace(byte[] imgData)
                       throws net.gdface.image.ImageErrorException,
                              NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    检测最大的人脸
    返回人脸位置数据对象CodeInfo
    
    Specified by:
    
    detectMaxFace in interface FaceApi
    
    Parameters:
    
    imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
    
    Returns:
    
    CodeInfo
    
    Throws:
    
    net.gdface.image.ImageErrorException
    
    NotFaceDetectedException
  - detectMaxFaceUnchecked
```
public CodeInfo detectMaxFaceUnchecked(byte[] imgData)
```
    FaceApi.detectMaxFace(byte[])对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    imgData - imgData
    
    Returns:
    
    CodeInfo
  - 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时)的特征码
  - getCodeInfoUnchecked
```
public CodeInfo[] getCodeInfoUnchecked(byte[] imgData,
                                       int faceNum,
                                       CodeInfo[] facePos)
```
    FaceApi.getCodeInfo(byte[],int,net.gdface.sdk.CodeInfo[])对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    imgData - imgData
    
    faceNum - faceNum
    
    facePos - facePos
    
    Returns:
    
    CodeInfo[]
  - 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
  - getFeature
```
public byte[] getFeature(java.util.Map<java.nio.ByteBuffer,CodeInfo> faces)
                  throws NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    多张人脸提取特征(用于多张人脸合成一个特征的算法)
    返回人脸特征数据 #multiFaceFeature()返回false时代表此方法未被实现，执行会抛出异常
    
    Specified by:
    
    getFeature in interface FaceApi
    
    Parameters:
    
    faces - 人脸图像数据(jpg,png...)与人脸位置信息对象的映射
    
    Returns:
    
    人脸特征数据
    
    Throws:
    
    NotFaceDetectedException
  - getFeatureUnchecked
```
public byte[] getFeatureUnchecked(java.util.Map<java.nio.ByteBuffer,CodeInfo> faces)
```
    FaceApi.getFeature(Map)对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    faces - faces
    
    Returns:
    
    byte[]
  - hasFace
```
public boolean hasFace(byte[] imgData)
                throws net.gdface.image.ImageErrorException
```
    Description copied from interface: FaceApi
    
    判断图像是否能提取到人脸特征码
    为true则能检测到人脸并能提取特征码
    
    Specified by:
    
    hasFace in interface FaceApi
    
    Parameters:
    
    imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
    
    Returns:
    
    为true则能检测到人脸并能提取特征码
    
    Throws:
    
    net.gdface.image.ImageErrorException
    
    See Also:
    
    FaceApi.detectAndGetCodeInfo(byte[], int)
  - hasFaceUnchecked
```
public boolean hasFaceUnchecked(byte[] imgData)
```
    FaceApi.hasFace(byte[])对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    imgData - imgData
    
    Returns:
    
    boolean
  - isLocal
```
public boolean isLocal()
```
    Description copied from interface: FaceApi
    
    返回当前接口实现方式
    false WebService类型
    true 本地实现
    
    Specified by:
    
    isLocal in interface FaceApi
    
    Returns:
    
    boolean
  - 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
  - matDetectAndGetCodeInfoUnchecked
```
public CodeInfo[] matDetectAndGetCodeInfoUnchecked(net.gdface.image.MatType matType,
                                                   byte[] matData,
                                                   int width,
                                                   int height,
                                                   int faceNum)
```
    FaceApi.matDetectAndGetCodeInfo(MatType,byte[],int,int,int)对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    matType - matType
    
    matData - matData
    
    width - width
    
    height - height
    
    faceNum - faceNum
    
    Returns:
    
    CodeInfo[]
  - 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:
    
    人脸信息对象列表
  - matDetectMaxFace
```
public CodeInfo matDetectMaxFace(net.gdface.image.MatType matType,
                                 byte[] matData,
                                 int width,
                                 int height)
                          throws NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    检测最大的人脸
    返回人脸位置数据对象CodeInfo
    
    Specified by:
    
    matDetectMaxFace in interface FaceApi
    
    Returns:
    
    CodeInfo
    
    Throws:
    
    NotFaceDetectedException
  - matDetectMaxFaceUnchecked
```
public CodeInfo matDetectMaxFaceUnchecked(net.gdface.image.MatType matType,
                                          byte[] matData,
                                          int width,
                                          int height)
```
    FaceApi.matDetectMaxFace(MatType,byte[],int,int)对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    matType - matType
    
    matData - matData
    
    width - width
    
    height - height
    
    Returns:
    
    CodeInfo
  - 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时)的特征码
  - matGetCodeInfoUnchecked
```
public CodeInfo[] matGetCodeInfoUnchecked(net.gdface.image.MatType matType,
                                          byte[] matData,
                                          int width,
                                          int height,
                                          int facenum,
                                          CodeInfo[] facePos)
```
    FaceApi.matGetCodeInfo(MatType,byte[],int,int,int,net.gdface.sdk.CodeInfo[])对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    matType - matType
    
    matData - matData
    
    width - width
    
    height - height
    
    facenum - facenum
    
    facePos - facePos
    
    Returns:
    
    CodeInfo[]
  - 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
  - matHasFace
```
public boolean matHasFace(net.gdface.image.MatType matType,
                          byte[] matData,
                          int width,
                          int height)
```
    Description copied from interface: FaceApi
    
    判断图像矩阵是否能提取到人脸特征码
    返回为true则能检测到人脸并能提取特征码
    
    Specified by:
    
    matHasFace in interface FaceApi
    
    Parameters:
    
    matType - 图像矩阵类型
    
    matData - 图像矩阵,为null则抛出IllegalArgumentException
    
    width - 图像宽度
    
    height - 图像高度
    
    Returns:
    
    为true则能检测到人脸并能提取特征码
  - matSearchFaces
```
public FseResult[] matSearchFaces(net.gdface.image.MatType matType,
                                  byte[] matData,
                                  int width,
                                  int height,
                                  CodeInfo facePos,
                                  double similarty,
                                  int rows)
                           throws net.gdface.image.ImageErrorException,
                                  NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    1:N 人脸图像搜索
    对facePos指定的人脸位置提取特征码,然后在数据库中搜索相似的人脸返回搜索结果。
    返回包含相似度计算结果的FseResult数组
    相似度值通过 FseResult.getSimilartys() 获取
    对应的人脸特征ID由 FseResult.getFeatureIds()获取
    
    Specified by:
    
    matSearchFaces in interface FaceApi
    
    Parameters:
    
    matType - 图像矩阵类型
    
    matData - 图像矩阵
    
    width - 图像宽度
    
    facePos - 人脸位置对象
    为null时,先做人脸检测再提取特征码
    不为null时,直接在指定的位置提取特征码
    
    similarty - 相似度阀值
    
    rows - 最多返回的记录数目
    
    Returns:
    
    包含相似度计算结果的FseResult数组
    
    Throws:
    
    net.gdface.image.ImageErrorException - -
    
    NotFaceDetectedException - -
    
    See Also:
    
    FaceApi.getCodeInfo(byte[], int, CodeInfo[]), FaceApi.searchFeatures(byte[], double, int)
  - matSearchFacesUnchecked
```
public FseResult[] matSearchFacesUnchecked(net.gdface.image.MatType matType,
                                           byte[] matData,
                                           int width,
                                           int height,
                                           CodeInfo facePos,
                                           double similarty,
                                           int rows)
```
    FaceApi.matSearchFaces(MatType,byte[],int,int,CodeInfo,double,int)对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    matType - matType
    
    matData - matData
    
    width - width
    
    height - height
    
    facePos - facePos
    
    similarty - similarty
    
    rows - rows
    
    Returns:
    
    FseResult[]
  - 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:
    
    返回口罩检测结果
  - 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 对描述算法能力的映射
  - searchFaces
```
public FseResult[] searchFaces(byte[] imgData,
                               CodeInfo facePos,
                               double similarty,
                               int rows)
                        throws net.gdface.image.ImageErrorException,
                               NotFaceDetectedException
```
    Description copied from interface: FaceApi
    
    1:N 人脸图像搜索
    对facePos指定的人脸位置提取特征码,然后在数据库中搜索相似的人脸返回搜索结果。
    返回包含相似度计算结果的FseResult数组
    相似度值通过 FseResult.getSimilartys() 获取
    对应的人脸特征ID由 FseResult.getFeatureIds()获取
    
    Specified by:
    
    searchFaces in interface FaceApi
    
    Parameters:
    
    imgData - 图片字节数组
    
    facePos - 人脸位置对象
    为null时,先做人脸检测再提取特征码
    不为null时,直接在指定的位置提取特征码
    
    similarty - 相似度阀值
    
    rows - 最多返回的记录数目
    
    Returns:
    
    包含相似度计算结果的FseResult数组
    
    Throws:
    
    net.gdface.image.ImageErrorException - -
    
    NotFaceDetectedException - -
    
    See Also:
    
    FaceApi.getCodeInfo(byte[], int, CodeInfo[]), FaceApi.searchFeatures(byte[], double, int)
  - searchFacesUnchecked
```
public FseResult[] searchFacesUnchecked(byte[] imgData,
                                        CodeInfo facePos,
                                        double similarty,
                                        int rows)
```
    FaceApi.searchFaces(byte[],CodeInfo,double,int)对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    imgData - imgData
    
    facePos - facePos
    
    similarty - similarty
    
    rows - rows
    
    Returns:
    
    FseResult[]
  - 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数组
  - 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
  - wearMaskUnchecked
```
public java.lang.Boolean wearMaskUnchecked(byte[] imgData,
                                           CodeInfo faceInfo)
```
    FaceApi.wearMask(byte[],CodeInfo)对应的unchecked方法, 所有显式申明的异常都被封装到RuntimeException抛出
    
    Parameters:
    
    imgData - imgData
    
    faceInfo - faceInfo
    
    Returns:
    
    Boolean

Class FaceApiDecorator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FaceApiDecorator

Method Detail

makeDecorator

delegate

compare2Face

compare2FaceUnchecked

compareCode

compareCodes

compareFaces

compareFacesUnchecked

compareFeatures

detectAndCompare2Face

detectAndCompare2FaceUnchecked

detectAndGetCodeInfo

detectAndGetCodeInfoUnchecked

detectCenterFace

detectCenterFaceUnchecked

detectFace

detectFaceUnchecked

detectMaxFace

detectMaxFaceUnchecked

getCodeInfo

getCodeInfoUnchecked

getCodeInfo

getFeature

getFeatureUnchecked

hasFace

hasFaceUnchecked

isLocal

matDetectAndGetCodeInfo

matDetectAndGetCodeInfoUnchecked

matDetectFace

matDetectMaxFace

matDetectMaxFaceUnchecked

matGetCodeInfo

matGetCodeInfoUnchecked

matGetCodeInfo

matHasFace

matSearchFaces

matSearchFacesUnchecked

matWearMask

sdkCapacity

searchFaces

searchFacesUnchecked

searchFeatures

wearMask

wearMaskUnchecked