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

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

```
@RestController
public class FaceApiSpringController
extends java.lang.Object
```
人脸识别SDK核心接口
此接口中mat前缀的方法图像数据参数为图像矩阵(要求图像宽高必须为偶数), 其他方法中所有byte[]类型的图像参数都指未解码的图像格式(如jpg,bmp,png...),
目前支持的图像格式类型依赖于JDK的支持能力

Author:

guyadong

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FaceApiSpringController.Compare2FaceArgs` argClass-1 wrap arguments for method `compare2Face(Compare2FaceArgs)`
`static class`	`FaceApiSpringController.CompareCodeArgs` argClass-2 wrap arguments for method `compareCode(CompareCodeArgs)`
`static class`	`FaceApiSpringController.CompareCodesArgs` argClass-3 wrap arguments for method `compareCodes(CompareCodesArgs)`
`static class`	`FaceApiSpringController.CompareFacesArgs` argClass-4 wrap arguments for method `compareFaces(CompareFacesArgs)`
`static class`	`FaceApiSpringController.CompareFeaturesArgs` argClass-5 wrap arguments for method `compareFeatures(CompareFeaturesArgs)`
`static class`	`FaceApiSpringController.DefaultResponse` `FaceApiSpringController.Response`默认实现
`static class`	`FaceApiSpringController.DefaultResponseFactory` `FaceApiSpringController.ResponseFactory`接口默认实现
`static class`	`FaceApiSpringController.DetectAndCompare2FaceArgs` argClass-6 wrap arguments for method `detectAndCompare2Face(DetectAndCompare2FaceArgs)`
`static class`	`FaceApiSpringController.DetectAndGetCodeInfoArgs` argClass-7 wrap arguments for method `detectAndGetCodeInfo(DetectAndGetCodeInfoArgs)`
`static class`	`FaceApiSpringController.DetectCenterFaceArgs` argClass-8 wrap arguments for method `detectCenterFace(DetectCenterFaceArgs)`
`static class`	`FaceApiSpringController.DetectFaceArgs` argClass-9 wrap arguments for method `detectFace(DetectFaceArgs)`
`static class`	`FaceApiSpringController.DetectMaxFaceArgs` argClass-10 wrap arguments for method `detectMaxFace(DetectMaxFaceArgs)`
`static class`	`FaceApiSpringController.GetCodeInfoArgs` argClass-11 wrap arguments for method `getCodeInfo(GetCodeInfoArgs)`
`static class`	`FaceApiSpringController.GetCodeInfoSingleArgs` argClass-12 wrap arguments for method `getCodeInfo(GetCodeInfoSingleArgs)`
`static class`	`FaceApiSpringController.GetFeatureArgs` argClass-13 wrap arguments for method `getFeature(GetFeatureArgs)`
`static class`	`FaceApiSpringController.HasFaceArgs` argClass-14 wrap arguments for method `hasFace(HasFaceArgs)`
`static interface`	`FaceApiSpringController.InstanceSupplier` 获取`FaceApi`实例的接口，用于应用层SPI方式提供`FaceApi`实例
`static class`	`FaceApiSpringController.MatDetectAndGetCodeInfoArgs` argClass-16 wrap arguments for method `matDetectAndGetCodeInfo(MatDetectAndGetCodeInfoArgs)`
`static class`	`FaceApiSpringController.MatDetectFaceArgs` argClass-17 wrap arguments for method `matDetectFace(MatDetectFaceArgs)`
`static class`	`FaceApiSpringController.MatDetectMaxFaceArgs` argClass-18 wrap arguments for method `matDetectMaxFace(MatDetectMaxFaceArgs)`
`static class`	`FaceApiSpringController.MatGetCodeInfoArgs` argClass-19 wrap arguments for method `matGetCodeInfo(MatGetCodeInfoArgs)`
`static class`	`FaceApiSpringController.MatGetCodeInfoSingleArgs` argClass-20 wrap arguments for method `matGetCodeInfo(MatGetCodeInfoSingleArgs)`
`static class`	`FaceApiSpringController.MatHasFaceArgs` argClass-21 wrap arguments for method `matHasFace(MatHasFaceArgs)`
`static class`	`FaceApiSpringController.MatSearchFacesArgs` argClass-22 wrap arguments for method `matSearchFaces(MatSearchFacesArgs)`
`static class`	`FaceApiSpringController.MatWearMaskArgs` argClass-23 wrap arguments for method `matWearMask(MatWearMaskArgs)`
`static interface`	`FaceApiSpringController.Response` web响应数据接口
`static interface`	`FaceApiSpringController.ResponseFactory` 获取`FaceApiSpringController.Response`接口实例的工厂类接口
`static class`	`FaceApiSpringController.SearchFacesArgs` argClass-25 wrap arguments for method `searchFaces(SearchFacesArgs)`
`static class`	`FaceApiSpringController.SearchFeaturesArgs` argClass-26 wrap arguments for method `searchFeatures(SearchFeaturesArgs)`
`static class`	`FaceApiSpringController.WearMaskArgs` argClass-27 wrap arguments for method `wearMask(WearMaskArgs)`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DESCRIPTION

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DESCRIPTION`

Constructor Summary

Constructors
Constructor and Description

FaceApiSpringController()

Constructors
Constructor and Description
`FaceApiSpringController()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FaceApiSpringController.Response`	`compare2Face(FaceApiSpringController.Compare2FaceArgs args)` 对人脸图像提取特征码，返回比较相似度结果 imgData1和imgData2相等或imgData2为`null`时,即比较同一张图像中的两张人脸的相似度调用该方法时假设图像(`imgData1`和`imgData2`)能正常解码, 所以当对图像解码出现异常时，将`ImageErrorException`异常对象封装到`RuntimeException`抛出任何参数为`null`则抛出`IllegalArgumentException`
`FaceApiSpringController.Response`	`compareCode(FaceApiSpringController.CompareCodeArgs args)` 特征码比对参数为`null`或长度不一致则抛出`IllegalArgumentException`异常,返回两个特征码之间的相似度（0.0~1）
`FaceApiSpringController.Response`	`compareCodes(FaceApiSpringController.CompareCodesArgs args)` 特征码比对1:N 返回对应的特征码相似度数组
`FaceApiSpringController.Response`	`compareFaces(FaceApiSpringController.CompareFacesArgs args)` 特征码比对1:N 对`imgData`图像数据检测人脸并提取特征，然后与`code`特征进行比对, 返回包含比对相似度结果的`CompareResult`实例
`FaceApiSpringController.Response`	`compareFeatures(FaceApiSpringController.CompareFeaturesArgs args)` 特征码比对1:N
`protected FaceApi`	`delegate()`
`FaceApiSpringController.Response`	`detectAndCompare2Face(FaceApiSpringController.DetectAndCompare2FaceArgs args)` 对两个图像指定范围(`FRect`)进行人脸检测,找到并提取唯一的人脸特征码,然后比较相似度,返回相似度结果 imgData1和imgData2相等或imgData2为`null`时, 即比较同一张图像中的两张人脸的相似度,这种情况下detectRect1和detectRect2都不能为`null` imgData1和imgData2不相等且都不为`null`时,detectRect1和detectRect2被忽略
`FaceApiSpringController.Response`	`detectAndGetCodeInfo(FaceApiSpringController.DetectAndGetCodeInfoArgs args)` 先对图像数据`imgData`进行人脸检测，然后提取人脸特征码返回所有成功提取特征码的`CodeInfo`数组, 与`#getCodeInfo(byte[], int, CodeInfo[])`的返回结果有差别，返回结果中不包含检测到人脸但提取特征码失败的对象
`FaceApiSpringController.Response`	`detectCenterFace(FaceApiSpringController.DetectCenterFaceArgs args)` 检测最中心的人脸返回人脸位置数据对象`CodeInfo`
`FaceApiSpringController.Response`	`detectFace(FaceApiSpringController.DetectFaceArgs args)` 对图像(`imgData`)进行人脸检测，返回人脸位置数据对象`CodeInfo`数组没有检测到人脸则返回空数组
`FaceApiSpringController.Response`	`detectMaxFace(FaceApiSpringController.DetectMaxFaceArgs args)` 检测最大的人脸返回人脸位置数据对象`CodeInfo`
`FaceApiSpringController.Response`	`getCodeInfo(FaceApiSpringController.GetCodeInfoArgs args)` 根据`facePos`提供的人脸信息位置, 在`imgData`图像中提取特征码与 `#detectAndGetCodeInfo(byte[], int)`不同, 本方法不对图像数据`imgData`进行人脸检测, 假设`facePos`是 `#detectFace(byte[])`或 `#detectFaceAgain(byte[], FRect[])` 的返回结果返回facePos,如果没有提取到特征码,则对应元素`CodeInfo.getCode()`返回`null`
`FaceApiSpringController.Response`	`getCodeInfo(FaceApiSpringController.GetCodeInfoSingleArgs args)` 根据`facePos`提供的人脸信息位置, 在`imgData`图像中提取特征码返回包含人脸特征的`CodeInfo`对象，提取特征失败则返回`null`
`FaceApiSpringController.Response`	`getFeature(FaceApiSpringController.GetFeatureArgs args)` 多张人脸提取特征(用于多张人脸合成一个特征的算法) 返回人脸特征数据 `#multiFaceFeature()`返回`false`时代表此方法未被实现，执行会抛出异常
`FaceApiSpringController.Response`	`hasFace(FaceApiSpringController.HasFaceArgs args)` 判断图像是否能提取到人脸特征码为`true`则能检测到人脸并能提取特征码
`FaceApiSpringController.Response`	`isLocal()` 返回当前接口实现方式 false WebService类型 true 本地实现
`FaceApiSpringController.Response`	`matDetectAndGetCodeInfo(FaceApiSpringController.MatDetectAndGetCodeInfoArgs args)` 先对图像矩阵数据`imgData`进行人脸检测，然后提取人脸特征码返回包含人脸特征数据的`CodeInfo`数组
`FaceApiSpringController.Response`	`matDetectFace(FaceApiSpringController.MatDetectFaceArgs args)` 对图像矩阵进行人脸检测返回人脸信息对象列表，没有检测到人脸返回空表
`FaceApiSpringController.Response`	`matDetectMaxFace(FaceApiSpringController.MatDetectMaxFaceArgs args)` 检测最大的人脸返回人脸位置数据对象`CodeInfo`
`FaceApiSpringController.Response`	`matGetCodeInfo(FaceApiSpringController.MatGetCodeInfoArgs args)` 根据facePos提供的人脸信息位置, 在图像矩阵中提取特征码包含人脸特征数据的facePos
`FaceApiSpringController.Response`	`matGetCodeInfo(FaceApiSpringController.MatGetCodeInfoSingleArgs args)` 根据`facePos`提供的人脸信息位置, 在图像矩阵中提取特征码返回包含人脸特征的`CodeInfo`对象，提取特征失败则返回`null`
`FaceApiSpringController.Response`	`matHasFace(FaceApiSpringController.MatHasFaceArgs args)` 判断图像矩阵是否能提取到人脸特征码返回为`true`则能检测到人脸并能提取特征码
`FaceApiSpringController.Response`	`matSearchFaces(FaceApiSpringController.MatSearchFacesArgs args)` 1:N 人脸图像搜索对`facePos`指定的人脸位置提取特征码,然后在数据库中搜索相似的人脸返回搜索结果。返回包含相似度计算结果的FseResult数组相似度值通过 FseResult.getSimilartys() 获取对应的人脸特征ID由 FseResult.getFeatureIds()获取
`FaceApiSpringController.Response`	`matWearMask(FaceApiSpringController.MatWearMaskArgs args)` 检测指定的人脸是否戴口罩返回值有三种状态: `true` 戴口罩返回 `false` 未戴口罩返回 `null` 不知道
`FaceApiSpringController.Response`	`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`
`FaceApiSpringController.Response`	`searchFaces(FaceApiSpringController.SearchFacesArgs args)` 1:N 人脸图像搜索对`facePos`指定的人脸位置提取特征码,然后在数据库中搜索相似的人脸返回搜索结果。返回包含相似度计算结果的FseResult数组相似度值通过 FseResult.getSimilartys() 获取对应的人脸特征ID由 FseResult.getFeatureIds()获取
`FaceApiSpringController.Response`	`searchFeatures(FaceApiSpringController.SearchFeaturesArgs args)` 1:N 人脸特征搜索搜索与`code`相似度大于`similarty`的记录(最多返回前`rows`个结果) 返回包含相似度计算结果的`FseResult`数组,返回结果以相似度降序排列相似度值通过 `FseResult#getSimilartys()` 获取对应的人脸特征ID由 `FseResult#getFeatureIds()`获取
`static void`	`setInstanceSupplier(FaceApiSpringController.InstanceSupplier instanceSupplier)`
`FaceApiSpringController.Response`	`wearMask(FaceApiSpringController.WearMaskArgs args)` 检测指定的人脸是否戴口罩返回值有三种状态: `true` 戴口罩返回 `false` 未戴口罩返回 `null` 不知道

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

Field Detail

DESCRIPTION

public static java.lang.String DESCRIPTION

Constructor Detail
- FaceApiSpringController
```
public FaceApiSpringController()
```

Method Detail

setInstanceSupplier

public static void setInstanceSupplier(FaceApiSpringController.InstanceSupplier instanceSupplier)

Parameters:: instanceSupplier - 要设置的 instanceSupplier

delegate
```
protected FaceApi delegate()
```
Returns:

返回被装饰的FaceApi实例

compare2Face
```
@ResponseBody
 @RequestMapping(value="/FaceApi/compare2Face",
                method=POST)
public FaceApiSpringController.Response compare2Face(@RequestBody
                                                                                                                                                FaceApiSpringController.Compare2FaceArgs args)
```
对人脸图像提取特征码，返回比较相似度结果
imgData1和imgData2相等或imgData2为null时,即比较同一张图像中的两张人脸的相似度调用该方法时假设图像(imgData1和imgData2)能正常解码,
所以当对图像解码出现异常时，将ImageErrorException异常对象封装到RuntimeException抛出
任何参数为null则抛出IllegalArgumentException

Parameters:

imgData1 - 图像1数据(jpg,png...)字节数组

facePos1 - 检测到的人脸/眼睛位置

imgData2 - 图像1数据(jpg,png...)字节数组

facePos2 - 检测到的人脸/眼睛位置

Returns:

两张人脸之间的相似度(0.0~1)

Throws:

NotFaceDetectedException

net.gdface.image.ImageErrorException

See Also:

#getCodeInfo(byte[], int, CodeInfo[]), #compareCode(byte[], byte[])

compareCode

@ResponseBody
 @RequestMapping(value="/FaceApi/compareCode",
                method=POST)
public FaceApiSpringController.Response compareCode(@RequestBody
                                                                                                                                              FaceApiSpringController.CompareCodeArgs args)

特征码比对
参数为null或长度不一致则抛出IllegalArgumentException异常,返回两个特征码之间的相似度（0.0~1）

Parameters:: code1 - 待比对的特征码; code2 - 待比对的特征码
Returns:: 相似度（0.0~1）

compareCodes

@ResponseBody
 @RequestMapping(value="/FaceApi/compareCodes",
                method=POST)
public FaceApiSpringController.Response compareCodes(@RequestBody
                                                                                                                                                FaceApiSpringController.CompareCodesArgs args)

特征码比对1:N
返回对应的特征码相似度数组

Parameters:: code1 - 待比对的特征码; codes - 包含人脸特征的CodeInfo数组
Returns:: 特征码相似度数组

compareFaces
```
@ResponseBody
 @RequestMapping(value="/FaceApi/compareFaces",
                method=POST)
public FaceApiSpringController.Response compareFaces(@RequestBody
                                                                                                                                                FaceApiSpringController.CompareFacesArgs args)
```
特征码比对1:N
对imgData图像数据检测人脸并提取特征，然后与code特征进行比对, 返回包含比对相似度结果的CompareResult实例

Parameters:

code - 人脸特征数据

imgData - 待比对的图像(jpg,png...)(可能有多张人脸)

faceNum - 参见 #getCodeInfo(byte[], int, CodeInfo[])

Returns:

CompareResult实例

Throws:

NotFaceDetectedException - 没有检测到人脸

net.gdface.image.ImageErrorException

See Also:

#compareCodes(byte[], CodeInfo[]), #detectAndGetCodeInfo(byte[], int)

compareFeatures

@ResponseBody
 @RequestMapping(value="/FaceApi/compareFeatures",
                method=POST)
public FaceApiSpringController.Response compareFeatures(@RequestBody
                                                                                                                                                      FaceApiSpringController.CompareFeaturesArgs args)

特征码比对1:N

Parameters:: code1 - 人脸特征数据; codes - 一组人脸特征
Returns:: 返回对应的特征码相似度列表

detectAndCompare2Face
```
@ResponseBody
 @RequestMapping(value="/FaceApi/detectAndCompare2Face",
                method=POST)
public FaceApiSpringController.Response detectAndCompare2Face(@RequestBody
                                                                                                                                                                  FaceApiSpringController.DetectAndCompare2FaceArgs args)
```
对两个图像指定范围(FRect)进行人脸检测,找到并提取唯一的人脸特征码,然后比较相似度,返回相似度结果
imgData1和imgData2相等或imgData2为null时, 即比较同一张图像中的两张人脸的相似度,这种情况下detectRect1和detectRect2都不能为null
imgData1和imgData2不相等且都不为null时,detectRect1和detectRect2被忽略

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:

#detectAndGetCodeInfo(byte[], int), #compareCode(byte[], byte[])

detectAndGetCodeInfo
```
@ResponseBody
 @RequestMapping(value="/FaceApi/detectAndGetCodeInfo",
                method=POST)
public FaceApiSpringController.Response detectAndGetCodeInfo(@RequestBody
                                                                                                                                                                FaceApiSpringController.DetectAndGetCodeInfoArgs args)
```
先对图像数据imgData进行人脸检测，然后提取人脸特征码
返回所有成功提取特征码的CodeInfo数组, 与#getCodeInfo(byte[], int, CodeInfo[])的返回结果有差别，返回结果中不包含检测到人脸但提取特征码失败的对象

Parameters:

imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException

faceNum - 参见 #getCodeInfo(byte[], int, CodeInfo[])

Returns:

CodeInfo数组

Throws:

net.gdface.image.ImageErrorException

NotFaceDetectedException - 没有检测人脸或提取到特征码的人脸数目不是要求的人脸数目(faceNum>0)

detectCenterFace

@ResponseBody
 @RequestMapping(value="/FaceApi/detectCenterFace",
                method=POST)
public FaceApiSpringController.Response detectCenterFace(@RequestBody
                                                                                                                                                        FaceApiSpringController.DetectCenterFaceArgs args)

检测最中心的人脸
返回人脸位置数据对象CodeInfo

Parameters:: imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
Returns:: CodeInfo
Throws:: NotFaceDetected - 没有检测到人脸; ImageError - 图像读取错误

detectFace

@ResponseBody
 @RequestMapping(value="/FaceApi/detectFace",
                method=POST)
public FaceApiSpringController.Response detectFace(@RequestBody
                                                                                                                                            FaceApiSpringController.DetectFaceArgs args)

对图像(imgData)进行人脸检测，返回人脸位置数据对象CodeInfo数组
没有检测到人脸则返回空数组

Parameters:: imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
Returns:: CodeInfo数组
Throws:: net.gdface.image.ImageErrorException - 图像读取错误

detectMaxFace

@ResponseBody
 @RequestMapping(value="/FaceApi/detectMaxFace",
                method=POST)
public FaceApiSpringController.Response detectMaxFace(@RequestBody
                                                                                                                                                  FaceApiSpringController.DetectMaxFaceArgs args)

检测最大的人脸
返回人脸位置数据对象CodeInfo

Parameters:: imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
Returns:: CodeInfo
Throws:: NotFaceDetected - 没有检测到人脸; ImageError - 图像读取错误

getCodeInfo
```
@ResponseBody
 @RequestMapping(value="/FaceApi/getCodeInfo",
                method=POST)
public FaceApiSpringController.Response getCodeInfo(@RequestBody
                                                                                                                                              FaceApiSpringController.GetCodeInfoArgs args)
```
根据facePos提供的人脸信息位置, 在imgData图像中提取特征码
与 #detectAndGetCodeInfo(byte[], int)不同, 本方法不对图像数据imgData进行人脸检测,
假设facePos是 #detectFace(byte[])或 #detectFaceAgain(byte[], FRect[]) 的返回结果
返回facePos,如果没有提取到特征码,则对应元素CodeInfo.getCode()返回null

Parameters:

imgData - 图像数据(jpg,png...)字节数组,为null则抛出 IllegalArgumentException

faceNum - 要求返回的人脸特征码数目
大于0时，如果实际提取到的人脸特征码数目不等于faceNum,则抛出NotFaceDetectedException
小于等于0时，返回所有提取到到人脸特征码

facePos - 检测到的人脸位置对象列表
为null或数组长度为0时抛出IllegalArgumentException
如果元素为null,则跳过

Returns:

返回facePos

Throws:

NotFaceDetectedException - 提取特征码的人脸数目为0或没有提取到指定数目(faceNum大于0时)的特征码

getCodeInfo

@ResponseBody
 @RequestMapping(value="/FaceApi/getCodeInfoSingle",
                method=POST)
public FaceApiSpringController.Response getCodeInfo(@RequestBody
                                                                                                                                                    FaceApiSpringController.GetCodeInfoSingleArgs args)

根据facePos提供的人脸信息位置, 在imgData图像中提取特征码
返回包含人脸特征的CodeInfo对象，提取特征失败则返回null

Parameters:: imgData - 图像数据(jpg,png...)字节数组,为null则抛出 IllegalArgumentException; facePos - 人脸位置信息对象，为null则抛出异常
Returns:: CodeInfo or null

getFeature

@ResponseBody
 @RequestMapping(value="/FaceApi/getFeature",
                method=POST)
public FaceApiSpringController.Response getFeature(@RequestBody
                                                                                                                                            FaceApiSpringController.GetFeatureArgs args)

多张人脸提取特征(用于多张人脸合成一个特征的算法)
返回人脸特征数据 #multiFaceFeature()返回false时代表此方法未被实现，执行会抛出异常

Parameters:: faces - 人脸图像数据(jpg,png...)与人脸位置信息对象的映射
Returns:: 人脸特征数据
Throws:: NotFaceDetectedException

hasFace

@ResponseBody
 @RequestMapping(value="/FaceApi/hasFace",
                method=POST)
public FaceApiSpringController.Response hasFace(@RequestBody
                                                                                                                                      FaceApiSpringController.HasFaceArgs args)

判断图像是否能提取到人脸特征码
为true则能检测到人脸并能提取特征码

Parameters:: imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
Returns:: 为true则能检测到人脸并能提取特征码
Throws:: net.gdface.image.ImageErrorException
See Also:: #detectAndGetCodeInfo(byte[], int)

isLocal

@ResponseBody
 @RequestMapping(value="/FaceApi/isLocal",
                method=POST)
public FaceApiSpringController.Response isLocal()

返回当前接口实现方式
false WebService类型
true 本地实现

Returns:: boolean

matDetectAndGetCodeInfo

@ResponseBody
 @RequestMapping(value="/FaceApi/matDetectAndGetCodeInfo",
                method=POST)
public FaceApiSpringController.Response matDetectAndGetCodeInfo(@RequestBody
                                                                                                                                                                      FaceApiSpringController.MatDetectAndGetCodeInfoArgs args)

先对图像矩阵数据imgData进行人脸检测，然后提取人脸特征码
返回包含人脸特征数据的CodeInfo数组

Parameters:: matType - 图像矩阵类型; matData - 图像矩阵; width - 图像宽度; height - 图像高度; faceNum - 参见 #getCodeInfo(byte[], int, CodeInfo[])
Returns:: CodeInfo数组
Throws:: NotFaceDetectedException
Since:: 2.1.9

matDetectFace

@ResponseBody
 @RequestMapping(value="/FaceApi/matDetectFace",
                method=POST)
public FaceApiSpringController.Response matDetectFace(@RequestBody
                                                                                                                                                  FaceApiSpringController.MatDetectFaceArgs args)

对图像矩阵进行人脸检测
返回人脸信息对象列表，没有检测到人脸返回空表

Parameters:: matType - 图像矩阵类型; matData - 图像矩阵; width - 图像宽度; height - 图像高度
Returns:: 人脸信息对象列表
Since:: 2.1.9

matDetectMaxFace

@ResponseBody
 @RequestMapping(value="/FaceApi/matDetectMaxFace",
                method=POST)
public FaceApiSpringController.Response matDetectMaxFace(@RequestBody
                                                                                                                                                        FaceApiSpringController.MatDetectMaxFaceArgs args)

检测最大的人脸
返回人脸位置数据对象CodeInfo

Parameters:: imgData - 图像数据(jpg,png...)字节数组,为null则抛出IllegalArgumentException
Returns:: CodeInfo
Throws:: NotFaceDetected - 没有检测到人脸
Since:: 2.1.9

matGetCodeInfo
```
@ResponseBody
 @RequestMapping(value="/FaceApi/matGetCodeInfo",
                method=POST)
public FaceApiSpringController.Response matGetCodeInfo(@RequestBody
                                                                                                                                                    FaceApiSpringController.MatGetCodeInfoArgs args)
```
根据facePos提供的人脸信息位置, 在图像矩阵中提取特征码
包含人脸特征数据的facePos

Parameters:

matType - 图像矩阵类型

matData - 图像矩阵

width - 图像宽度

height - 图像高度

facenum - 要求返回的人脸特征码数目
大于0时，如果实际提取到的人脸特征码数目不等于faceNum,则抛出NotFaceDetectedException
小于等于0时，返回所有提取到到人脸特征码

facePos - 人脸位置信息对象,不可为null

Returns:

always facePos

Throws:

NotFaceDetectedException - 提取特征码的人脸数目为0或没有提取到指定数目(faceNum大于0时)的特征码

Since:

2.1.9

matGetCodeInfo

@ResponseBody
 @RequestMapping(value="/FaceApi/matGetCodeInfoSingle",
                method=POST)
public FaceApiSpringController.Response matGetCodeInfo(@RequestBody
                                                                                                                                                          FaceApiSpringController.MatGetCodeInfoSingleArgs args)

根据facePos提供的人脸信息位置, 在图像矩阵中提取特征码
返回包含人脸特征的CodeInfo对象，提取特征失败则返回null

Parameters:: matType - 图像矩阵类型; matData - 图像矩阵; width - 图像宽度; height - 图像高度; facePos - 人脸位置信息对象，为null则抛出异常
Returns:: CodeInfo or null

matHasFace

@ResponseBody
 @RequestMapping(value="/FaceApi/matHasFace",
                method=POST)
public FaceApiSpringController.Response matHasFace(@RequestBody
                                                                                                                                            FaceApiSpringController.MatHasFaceArgs args)

判断图像矩阵是否能提取到人脸特征码
返回为true则能检测到人脸并能提取特征码

Parameters:: matType - 图像矩阵类型; matData - 图像矩阵,为null则抛出IllegalArgumentException; width - 图像宽度; height - 图像高度
Returns:: 为true则能检测到人脸并能提取特征码
Since:: 2.1.9

matSearchFaces
```
@ResponseBody
 @RequestMapping(value="/FaceApi/matSearchFaces",
                method=POST)
public FaceApiSpringController.Response matSearchFaces(@RequestBody
                                                                                                                                                    FaceApiSpringController.MatSearchFacesArgs args)
```
1:N 人脸图像搜索
对facePos指定的人脸位置提取特征码,然后在数据库中搜索相似的人脸返回搜索结果。
返回包含相似度计算结果的FseResult数组
相似度值通过 FseResult.getSimilartys() 获取
对应的人脸特征ID由 FseResult.getFeatureIds()获取

Parameters:

matType - 图像矩阵类型

matData - 图像矩阵

width - 图像宽度

facePos - 人脸位置对象
为null时,先做人脸检测再提取特征码
不为null时,直接在指定的位置提取特征码

similarty - 相似度阀值

rows - 最多返回的记录数目

Returns:

包含相似度计算结果的FseResult数组

Throws:

NotFaceDetectedException - -

net.gdface.image.ImageErrorException - -

java.lang.UnsupportedOperationException - 没有人脸识别算法(FaceApi实例)支持

Since:

3.0.0

See Also:

#getCodeInfo(byte[], int, CodeInfo[]), #searchFeatures(byte[], double, int)

matWearMask

@ResponseBody
 @RequestMapping(value="/FaceApi/matWearMask",
                method=POST)
public FaceApiSpringController.Response matWearMask(@RequestBody
                                                                                                                                              FaceApiSpringController.MatWearMaskArgs args)

检测指定的人脸是否戴口罩
返回值有三种状态:

true 戴口罩返回
false 未戴口罩返回
null 不知道

Parameters:: matType - 图像矩阵类型; matData - 图像矩阵; width - 图像宽度; height - 图像高度; faceInfo - 人脸位置信息
Returns:: 返回口罩检测结果
Since:: 2.1.9

sdkCapacity
```
@ResponseBody
 @RequestMapping(value="/FaceApi/sdkCapacity",
                method=POST)
public FaceApiSpringController.Response 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
Returns:

key-value 对描述算法能力的映射

Since:

2.2.7

searchFaces
```
@ResponseBody
 @RequestMapping(value="/FaceApi/searchFaces",
                method=POST)
public FaceApiSpringController.Response searchFaces(@RequestBody
                                                                                                                                              FaceApiSpringController.SearchFacesArgs args)
```
1:N 人脸图像搜索
对facePos指定的人脸位置提取特征码,然后在数据库中搜索相似的人脸返回搜索结果。
返回包含相似度计算结果的FseResult数组
相似度值通过 FseResult.getSimilartys() 获取
对应的人脸特征ID由 FseResult.getFeatureIds()获取

Parameters:

imgData - 图片字节数组

facePos - 人脸位置对象
为null时,先做人脸检测再提取特征码
不为null时,直接在指定的位置提取特征码

similarty - 相似度阀值

rows - 最多返回的记录数目

Returns:

包含相似度计算结果的FseResult数组

Throws:

NotFaceDetectedException - -

net.gdface.image.ImageErrorException - -

java.lang.UnsupportedOperationException - 没有人脸识别算法(FaceApi实例)支持

Since:

3.0.0

See Also:

#getCodeInfo(byte[], int, CodeInfo[]), #searchFeatures(byte[], double, int)

searchFeatures
```
@ResponseBody
 @RequestMapping(value="/FaceApi/searchFeatures",
                method=POST)
public FaceApiSpringController.Response searchFeatures(@RequestBody
                                                                                                                                                    FaceApiSpringController.SearchFeaturesArgs args)
```
1:N 人脸特征搜索
搜索与code相似度大于similarty的记录(最多返回前rows个结果)
返回包含相似度计算结果的FseResult数组,返回结果以相似度降序排列
相似度值通过 FseResult#getSimilartys() 获取
对应的人脸特征ID由 FseResult#getFeatureIds()获取

Parameters:

feature - 要搜索的特征码

similarty - 相似度阀值

rows - 最多返回的记录数目

Returns:

包含相似度计算结果的FseResult数组

Throws:

java.lang.UnsupportedOperationException - 没有人脸识别算法(FaceApi实例)支持

Since:

3.0.0

wearMask

@ResponseBody
 @RequestMapping(value="/FaceApi/wearMask",
                method=POST)
public FaceApiSpringController.Response wearMask(@RequestBody
                                                                                                                                        FaceApiSpringController.WearMaskArgs args)

检测指定的人脸是否戴口罩
返回值有三种状态:

true 戴口罩返回
false 未戴口罩返回
null 不知道

Parameters:: imgData - 图像数据(jpg,png...)字节数组,为null则抛出 IllegalArgumentException; faceInfo - 可见光图像人脸信息
Returns:: 返回口罩检测结果
Throws:: net.gdface.image.ImageErrorException
Since:: 2.1.9

Class FaceApiSpringController

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DESCRIPTION

Constructor Detail

FaceApiSpringController

Method Detail

setInstanceSupplier

delegate

compare2Face

compareCode

compareCodes

compareFaces

compareFeatures

detectAndCompare2Face

detectAndGetCodeInfo

detectCenterFace

detectFace

detectMaxFace

getCodeInfo

getCodeInfo

getFeature

hasFace

isLocal

matDetectAndGetCodeInfo

matDetectFace

matDetectMaxFace

matGetCodeInfo

matGetCodeInfo

matHasFace

matSearchFaces

matWearMask

sdkCapacity

searchFaces

searchFeatures

wearMask