CommonFaceRecModel (face 1.0.27 API)

java.lang.Object
- cn.smartjavaai.face.model.facerec.CommonFaceRecModel

所有已实现的接口:

FaceRecModel, AutoCloseable
```
public class CommonFaceRecModel
extends Object
implements FaceRecModel
```
FaceNet 人脸特征提取模型

作者:

dwj

字段概要

字段
限定符和类型字段和说明

static boolean NORMALIZE_SIMILARITY
是否归一化相似度

字段
限定符和类型	字段和说明
`static boolean`	`NORMALIZE_SIMILARITY` 是否归一化相似度

构造器概要

构造器
构造器和说明

CommonFaceRecModel()

构造器
构造器和说明
`CommonFaceRecModel()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`float`	`calculSimilar(float[] feature1, float[] feature2)` 计算相似度，返回归一化结果
`void`	`clearFace()` 清空人脸库数据
`void`	`close()`
`ai.djl.modality.cv.Image`	`drawSearchResult(ai.djl.modality.cv.Image image, FaceSearchParams params, String displayField)` 绘制人脸搜索结果
`R<DetectionResponse>`	`extractFeatures(BufferedImage image)` 特征提取（所有人脸）适用于多人脸场景
`R<DetectionResponse>`	`extractFeatures(byte[] imageData)` 特征提取（所有人脸）适用于多人脸场景
`R<DetectionResponse>`	`extractFeatures(ai.djl.modality.cv.Image image)` 特征提取（所有人脸）适用于多人脸场景
`R<float[]>`	`extractFeatures(ai.djl.modality.cv.Image image, DetectionInfo detectionInfo)`
`R<DetectionResponse>`	`extractFeatures(String imagePath)` 特征提取（所有人脸）适用于多人脸场景
`R<float[]>`	`extractTopFaceFeature(BufferedImage image)` 特征提取（提取分数最高人脸特征）适用于单人脸场景
`R<float[]>`	`extractTopFaceFeature(byte[] imageData)` 特征提取（提取分数最高人脸特征）适用于单人脸场景
`R<float[]>`	`extractTopFaceFeature(ai.djl.modality.cv.Image image)` 特征提取（提取分数最高人脸特征）适用于单人脸场景
`R<float[]>`	`extractTopFaceFeature(String imagePath)` 特征提取（提取分数最高人脸特征）适用于单人脸场景
`R<Float>`	`featureComparison(BufferedImage sourceImage1, BufferedImage sourceImag2)` 特征比较
`R<Float>`	`featureComparison(byte[] imageData1, byte[] imageData2)` 特征比较
`R<Float>`	`featureComparison(ai.djl.modality.cv.Image image1, ai.djl.modality.cv.Image image2)` 特征比较
`R<Float>`	`featureComparison(String imagePath1, String imagePath2)` 特征比较
`float[]`	`featureExtraction(ai.djl.modality.cv.Image image)`
`R<FaceVector>`	`getFaceInfoById(String id)` 使用人脸ID获取人脸信息
`org.apache.commons.pool2.impl.GenericObjectPool<ai.djl.inference.Predictor<ai.djl.modality.cv.Image,float[]>>`	`getPool()`
`boolean`	`isFromFactory()`
`boolean`	`isLoadFaceCompleted()` 是否加载人脸库完成
`R<List<FaceVector>>`	`listFaces(long pageNum, long pageSize)` 获取人脸列表
`void`	`loadFaceFeatures()` 加载人脸特征
`void`	`loadModel(FaceRecConfig config)` 加载人脸特征提取模型
`R<String>`	`register(FaceRegisterInfo faceRegisterInfo, BufferedImage sourceImage)` 注册人脸提取分数最高人脸进行注册
`R<String>`	`register(FaceRegisterInfo faceRegisterInfo, byte[] imageData)` 注册人脸提取分数最高人脸进行注册
`R<String>`	`register(FaceRegisterInfo faceRegisterInfo, float[] feature)` 注册人脸提取分数最高人脸进行注册
`R<String>`	`register(FaceRegisterInfo faceRegisterInfo, ai.djl.modality.cv.Image image)` 注册人脸提取分数最高人脸进行注册
`R<String>`	`register(FaceRegisterInfo faceRegisterInfo, InputStream inputStream)` 注册人脸提取分数最高人脸进行注册
`R<String>`	`register(FaceRegisterInfo faceRegisterInfo, String imagePath)` 注册人脸提取分数最高人脸进行注册
`void`	`releaseFaceFeatures()` 释放人脸特征缓存
`void`	`removeRegister(String... keys)` 删除已注册人脸
`R<DetectionResponse>`	`search(BufferedImage sourceImage, FaceSearchParams params)` 查询人脸（查询图片中所有人脸）适用于多人脸场景
`R<DetectionResponse>`	`search(byte[] imageData, FaceSearchParams params)` 查询人脸（查询图片中所有人脸）适用于多人脸场景
`List<FaceSearchResult>`	`search(float[] feature, FaceSearchParams params)` 查询人脸适用于多人脸场景
`R<DetectionResponse>`	`search(ai.djl.modality.cv.Image image, FaceSearchParams params)` 查询人脸（查询图片中所有人脸）
`R<DetectionResponse>`	`search(String imagePath, FaceSearchParams params)` 查询人脸（查询图片中所有人脸）
`R<List<FaceSearchResult>>`	`searchByTopFace(BufferedImage sourceImage, FaceSearchParams params)` 查询人脸从图像中提取分数最高的人脸特征，并在人脸库中进行 1:N 查询适用于单人脸场景
`R<List<FaceSearchResult>>`	`searchByTopFace(byte[] imageData, FaceSearchParams params)` 查询人脸从图像中提取分数最高的人脸特征，并在人脸库中进行 1:N 查询适用于单人脸场景
`R<List<FaceSearchResult>>`	`searchByTopFace(ai.djl.modality.cv.Image image, FaceSearchParams params)` 查询人脸从图像中提取分数最高的人脸特征，并在人脸库中进行 1:N 查询适用于单人脸场景
`R<List<FaceSearchResult>>`	`searchByTopFace(String imagePath, FaceSearchParams params)` 查询人脸从图像中提取分数最高的人脸特征，并在人脸库中进行 1:N 查询适用于单人脸场景
`void`	`setFromFactory(boolean fromFactory)`
`void`	`upsertFace(FaceRegisterInfo faceRegisterInfo, BufferedImage sourceImage)` 更新或注册人脸自动提取分数最高人脸进行更新
`void`	`upsertFace(FaceRegisterInfo faceRegisterInfo, byte[] imageData)` 更新或注册人脸自动提取分数最高人脸进行更新
`void`	`upsertFace(FaceRegisterInfo faceRegisterInfo, float[] feature)` 更新或注册人脸自动提取分数最高人脸进行更新
`void`	`upsertFace(FaceRegisterInfo faceRegisterInfo, ai.djl.modality.cv.Image image)` 更新或注册人脸自动提取分数最高人脸进行更新
`void`	`upsertFace(FaceRegisterInfo faceRegisterInfo, String imagePath)` 更新或注册人脸自动提取分数最高人脸进行更新

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - NORMALIZE_SIMILARITY
```
public static final boolean NORMALIZE_SIMILARITY
```
    是否归一化相似度
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - CommonFaceRecModel
```
public CommonFaceRecModel()
```
- 方法详细资料
  - loadModel
```
public void loadModel(FaceRecConfig config)
```
    加载人脸特征提取模型
    
    指定者:
    
    loadModel 在接口中 FaceRecModel
    
    参数:
    
    config -
  - featureExtraction
```
public float[] featureExtraction(ai.djl.modality.cv.Image image)
```
  - calculSimilar
```
public float calculSimilar(float[] feature1,
                           float[] feature2)
```
    计算相似度，返回归一化结果
    
    指定者:
    
    calculSimilar 在接口中 FaceRecModel
    
    参数:
    
    feature1 - 图1特征
    
    feature2 - 图2特征
    
    返回:
  - featureComparison
```
public R<Float> featureComparison(String imagePath1,
                                  String imagePath2)
```
    特征比较
    
    指定者:
    
    featureComparison 在接口中 FaceRecModel
    
    参数:
    
    imagePath1 - 图1路径
    
    imagePath2 - 图2路径
    
    返回:
  - featureComparison
```
public R<Float> featureComparison(BufferedImage sourceImage1,
                                  BufferedImage sourceImag2)
```
    从接口复制的说明: FaceRecModel
    
    特征比较
    
    指定者:
    
    featureComparison 在接口中 FaceRecModel
    
    参数:
    
    sourceImage1 - 图1BufferedImage
    
    sourceImag2 - 图2BufferedImage
    
    返回:
  - featureComparison
```
public R<Float> featureComparison(byte[] imageData1,
                                  byte[] imageData2)
```
    从接口复制的说明: FaceRecModel
    
    特征比较
    
    指定者:
    
    featureComparison 在接口中 FaceRecModel
    
    返回:
  - extractFeatures
```
public R<DetectionResponse> extractFeatures(BufferedImage image)
```
    从接口复制的说明: FaceRecModel
    
    特征提取（所有人脸）适用于多人脸场景
    
    指定者:
    
    extractFeatures 在接口中 FaceRecModel
    
    参数:
    
    image - BufferedImage
    
    返回:
  - extractFeatures
```
public R<DetectionResponse> extractFeatures(byte[] imageData)
```
    从接口复制的说明: FaceRecModel
    
    特征提取（所有人脸）适用于多人脸场景
    
    指定者:
    
    extractFeatures 在接口中 FaceRecModel
    
    参数:
    
    imageData - 图片字节流
    
    返回:
  - extractFeatures
```
public R<DetectionResponse> extractFeatures(String imagePath)
```
    从接口复制的说明: FaceRecModel
    
    特征提取（所有人脸）适用于多人脸场景
    
    指定者:
    
    extractFeatures 在接口中 FaceRecModel
    
    参数:
    
    imagePath - 图片路径
    
    返回:
  - extractTopFaceFeature
```
public R<float[]> extractTopFaceFeature(BufferedImage image)
```
    从接口复制的说明: FaceRecModel
    
    特征提取（提取分数最高人脸特征）适用于单人脸场景
    
    指定者:
    
    extractTopFaceFeature 在接口中 FaceRecModel
    
    参数:
    
    image - BufferedImage
    
    返回:
  - extractTopFaceFeature
```
public R<float[]> extractTopFaceFeature(String imagePath)
```
    从接口复制的说明: FaceRecModel
    
    特征提取（提取分数最高人脸特征）适用于单人脸场景
    
    指定者:
    
    extractTopFaceFeature 在接口中 FaceRecModel
    
    参数:
    
    imagePath - 图片路径
    
    返回:
  - extractTopFaceFeature
```
public R<float[]> extractTopFaceFeature(byte[] imageData)
```
    从接口复制的说明: FaceRecModel
    
    特征提取（提取分数最高人脸特征）适用于单人脸场景
    
    指定者:
    
    extractTopFaceFeature 在接口中 FaceRecModel
    
    参数:
    
    imageData - 图片字节流
    
    返回:
  - register
```
public R<String> register(FaceRegisterInfo faceRegisterInfo,
                          String imagePath)
```
    从接口复制的说明: FaceRecModel
    
    注册人脸提取分数最高人脸进行注册
    
    指定者:
    
    register 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
    
    imagePath - 图片路径
    
    返回:
  - register
```
public R<String> register(FaceRegisterInfo faceRegisterInfo,
                          BufferedImage sourceImage)
```
    从接口复制的说明: FaceRecModel
    
    注册人脸提取分数最高人脸进行注册
    
    指定者:
    
    register 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
    
    返回:
  - register
```
public R<String> register(FaceRegisterInfo faceRegisterInfo,
                          InputStream inputStream)
```
    从接口复制的说明: FaceRecModel
    
    注册人脸提取分数最高人脸进行注册
    
    指定者:
    
    register 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
    
    返回:
  - register
```
public R<String> register(FaceRegisterInfo faceRegisterInfo,
                          byte[] imageData)
```
    从接口复制的说明: FaceRecModel
    
    注册人脸提取分数最高人脸进行注册
    
    指定者:
    
    register 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
    
    返回:
  - register
```
public R<String> register(FaceRegisterInfo faceRegisterInfo,
                          float[] feature)
```
    从接口复制的说明: FaceRecModel
    
    注册人脸提取分数最高人脸进行注册
    
    指定者:
    
    register 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
    
    feature - 人脸特征
    
    返回:
  - removeRegister
```
public void removeRegister(String... keys)
```
    从接口复制的说明: FaceRecModel
    
    删除已注册人脸
    
    指定者:
    
    removeRegister 在接口中 FaceRecModel
  - clearFace
```
public void clearFace()
```
    从接口复制的说明: FaceRecModel
    
    清空人脸库数据
    
    指定者:
    
    clearFace 在接口中 FaceRecModel
  - upsertFace
```
public void upsertFace(FaceRegisterInfo faceRegisterInfo,
                       String imagePath)
```
    从接口复制的说明: FaceRecModel
    
    更新或注册人脸自动提取分数最高人脸进行更新
    
    指定者:
    
    upsertFace 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
  - upsertFace
```
public void upsertFace(FaceRegisterInfo faceRegisterInfo,
                       BufferedImage sourceImage)
```
    从接口复制的说明: FaceRecModel
    
    更新或注册人脸自动提取分数最高人脸进行更新
    
    指定者:
    
    upsertFace 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
  - upsertFace
```
public void upsertFace(FaceRegisterInfo faceRegisterInfo,
                       float[] feature)
```
    从接口复制的说明: FaceRecModel
    
    更新或注册人脸自动提取分数最高人脸进行更新
    
    指定者:
    
    upsertFace 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
    
    feature - 人脸特征
  - upsertFace
```
public void upsertFace(FaceRegisterInfo faceRegisterInfo,
                       byte[] imageData)
```
    从接口复制的说明: FaceRecModel
    
    更新或注册人脸自动提取分数最高人脸进行更新
    
    指定者:
    
    upsertFace 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
  - searchByTopFace
```
public R<List<FaceSearchResult>> searchByTopFace(String imagePath,
                                                 FaceSearchParams params)
```
    从接口复制的说明: FaceRecModel
    
    查询人脸从图像中提取分数最高的人脸特征，并在人脸库中进行 1:N 查询适用于单人脸场景
    
    指定者:
    
    searchByTopFace 在接口中 FaceRecModel
    
    params - 人脸查询参数
    
    返回:
  - searchByTopFace
```
public R<List<FaceSearchResult>> searchByTopFace(byte[] imageData,
                                                 FaceSearchParams params)
```
    从接口复制的说明: FaceRecModel
    
    查询人脸从图像中提取分数最高的人脸特征，并在人脸库中进行 1:N 查询适用于单人脸场景
    
    指定者:
    
    searchByTopFace 在接口中 FaceRecModel
    
    返回:
  - searchByTopFace
```
public R<List<FaceSearchResult>> searchByTopFace(BufferedImage sourceImage,
                                                 FaceSearchParams params)
```
    从接口复制的说明: FaceRecModel
    
    查询人脸从图像中提取分数最高的人脸特征，并在人脸库中进行 1:N 查询适用于单人脸场景
    
    指定者:
    
    searchByTopFace 在接口中 FaceRecModel
    
    返回:
  - search
```
public List<FaceSearchResult> search(float[] feature,
                                     FaceSearchParams params)
```
    从接口复制的说明: FaceRecModel
    
    查询人脸适用于多人脸场景
    
    指定者:
    
    search 在接口中 FaceRecModel
    
    参数:
    
    feature - 人脸特征
    
    返回:
  - search
```
public R<DetectionResponse> search(String imagePath,
                                   FaceSearchParams params)
```
    从接口复制的说明: FaceRecModel
    
    查询人脸（查询图片中所有人脸）
    
    指定者:
    
    search 在接口中 FaceRecModel
    
    params - 人脸查询参数
    
    返回:
  - search
```
public R<DetectionResponse> search(BufferedImage sourceImage,
                                   FaceSearchParams params)
```
    从接口复制的说明: FaceRecModel
    
    查询人脸（查询图片中所有人脸）适用于多人脸场景
    
    指定者:
    
    search 在接口中 FaceRecModel
    
    返回:
  - search
```
public R<DetectionResponse> search(byte[] imageData,
                                   FaceSearchParams params)
```
    从接口复制的说明: FaceRecModel
    
    查询人脸（查询图片中所有人脸）适用于多人脸场景
    
    指定者:
    
    search 在接口中 FaceRecModel
    
    返回:
  - getFaceInfoById
```
public R<FaceVector> getFaceInfoById(String id)
```
    从接口复制的说明: FaceRecModel
    
    使用人脸ID获取人脸信息
    
    指定者:
    
    getFaceInfoById 在接口中 FaceRecModel
    
    返回:
  - listFaces
```
public R<List<FaceVector>> listFaces(long pageNum,
                                     long pageSize)
```
    从接口复制的说明: FaceRecModel
    
    获取人脸列表
    
    指定者:
    
    listFaces 在接口中 FaceRecModel
    
    返回:
  - loadFaceFeatures
```
public void loadFaceFeatures()
```
    从接口复制的说明: FaceRecModel
    
    加载人脸特征
    
    指定者:
    
    loadFaceFeatures 在接口中 FaceRecModel
  - releaseFaceFeatures
```
public void releaseFaceFeatures()
```
    从接口复制的说明: FaceRecModel
    
    释放人脸特征缓存
    
    指定者:
    
    releaseFaceFeatures 在接口中 FaceRecModel
  - featureComparison
```
public R<Float> featureComparison(ai.djl.modality.cv.Image image1,
                                  ai.djl.modality.cv.Image image2)
```
    从接口复制的说明: FaceRecModel
    
    特征比较
    
    指定者:
    
    featureComparison 在接口中 FaceRecModel
    
    参数:
    
    image1 - 图1
    
    image2 - 图2
    
    返回:
  - register
```
public R<String> register(FaceRegisterInfo faceRegisterInfo,
                          ai.djl.modality.cv.Image image)
```
    从接口复制的说明: FaceRecModel
    
    注册人脸提取分数最高人脸进行注册
    
    指定者:
    
    register 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
    
    返回:
  - upsertFace
```
public void upsertFace(FaceRegisterInfo faceRegisterInfo,
                       ai.djl.modality.cv.Image image)
```
    从接口复制的说明: FaceRecModel
    
    更新或注册人脸自动提取分数最高人脸进行更新
    
    指定者:
    
    upsertFace 在接口中 FaceRecModel
    
    参数:
    
    faceRegisterInfo - 注册人脸信息
  - search
```
public R<DetectionResponse> search(ai.djl.modality.cv.Image image,
                                   FaceSearchParams params)
```
    从接口复制的说明: FaceRecModel
    
    查询人脸（查询图片中所有人脸）
    
    指定者:
    
    search 在接口中 FaceRecModel
    
    params - 人脸查询参数
    
    返回:
  - searchByTopFace
```
public R<List<FaceSearchResult>> searchByTopFace(ai.djl.modality.cv.Image image,
                                                 FaceSearchParams params)
```
    从接口复制的说明: FaceRecModel
    
    查询人脸从图像中提取分数最高的人脸特征，并在人脸库中进行 1:N 查询适用于单人脸场景
    
    指定者:
    
    searchByTopFace 在接口中 FaceRecModel
    
    params - 人脸查询参数
    
    返回:
  - extractFeatures
```
public R<DetectionResponse> extractFeatures(ai.djl.modality.cv.Image image)
```
    从接口复制的说明: FaceRecModel
    
    特征提取（所有人脸）适用于多人脸场景
    
    指定者:
    
    extractFeatures 在接口中 FaceRecModel
    
    返回:
  - extractFeatures
```
public R<float[]> extractFeatures(ai.djl.modality.cv.Image image,
                                  DetectionInfo detectionInfo)
```
    指定者:
    
    extractFeatures 在接口中 FaceRecModel
  - extractTopFaceFeature
```
public R<float[]> extractTopFaceFeature(ai.djl.modality.cv.Image image)
```
    从接口复制的说明: FaceRecModel
    
    特征提取（提取分数最高人脸特征）适用于单人脸场景
    
    指定者:
    
    extractTopFaceFeature 在接口中 FaceRecModel
    
    返回:
  - drawSearchResult
```
public ai.djl.modality.cv.Image drawSearchResult(ai.djl.modality.cv.Image image,
                                                 FaceSearchParams params,
                                                 String displayField)
```
    从接口复制的说明: FaceRecModel
    
    绘制人脸搜索结果
    
    指定者:
    
    drawSearchResult 在接口中 FaceRecModel
  - close
```
public void close()
```
    指定者:
    
    close 在接口中 AutoCloseable
  - isLoadFaceCompleted
```
public boolean isLoadFaceCompleted()
```
    从接口复制的说明: FaceRecModel
    
    是否加载人脸库完成
    
    指定者:
    
    isLoadFaceCompleted 在接口中 FaceRecModel
    
    返回:
  - getPool
```
public org.apache.commons.pool2.impl.GenericObjectPool<ai.djl.inference.Predictor<ai.djl.modality.cv.Image,float[]>> getPool()
```
    指定者:
    
    getPool 在接口中 FaceRecModel
  - setFromFactory
```
public void setFromFactory(boolean fromFactory)
```
    指定者:
    
    setFromFactory 在接口中 FaceRecModel
  - isFromFactory
```
public boolean isFromFactory()
```

类 CommonFaceRecModel

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

NORMALIZE_SIMILARITY

构造器详细资料

CommonFaceRecModel

方法详细资料

loadModel

featureExtraction

calculSimilar

featureComparison

featureComparison

featureComparison

extractFeatures

extractFeatures

extractFeatures

extractTopFaceFeature

extractTopFaceFeature

extractTopFaceFeature

register

register

register

register

register

removeRegister

clearFace

upsertFace

upsertFace

upsertFace

upsertFace

searchByTopFace

searchByTopFace

searchByTopFace

search

search

search

search

getFaceInfoById

listFaces

loadFaceFeatures

releaseFaceFeatures

featureComparison

register

upsertFace

search

searchByTopFace

extractFeatures

extractFeatures

extractTopFaceFeature

drawSearchResult

close

isLoadFaceCompleted

getPool

setFromFactory

isFromFactory