net.gdface.sdk.fse

Interface FeatureSe

All Known Implementing Classes:

BaseFeatureSearchEngine.FeatureSeImpl, BaseFeatureSeImpl, FeatureSeDecorator, FeatureSeDefaultImpl, FeatureSeGenericDecorator, FeatureSeThriftClient

public interface FeatureSe

特征码内存搜索引擎(feature search engine)接口
提供高速的人脸特征相似度比对搜索/排序,支持多线程并行搜索，适用于百万级以上人脸库的快速搜索。
1.使用 addFeature(byte[], byte[], String)方法将特征添加到搜索引擎
2.使用 searchCode(byte[], double, int)在内存中搜索与指定特征相似的的特征返回搜索结果

Author:

guyadong

Method Summary

Modifier and Type	Method and Description
boolean	addFeature(byte[] featureId, byte[] feature, long appid) 添加一条特征码到内存表
boolean	addFeature(byte[] featureId, byte[] feature, java.lang.String imgMD5) 添加一条特征码到内存表
void	clearAll() 删除内存表中所有特征数据
CodeBean	getFeature(byte[] featureId) 根据特征码ID在表中查找指定的记录
CodeBean	getFeatureByHex(java.lang.String featureId) 根据特征码ID在表中查找指定的记录
boolean	removeFeature(byte[] featureId) 根据特征码ID中表中删除指定的记录
boolean	removeFeatureByHex(java.lang.String featureId) 根据特征码ID中表中删除指定的记录
CodeBean[]	searchCode(byte[] code, double sim, int rows) 在内存表中根据比对相似度进行特征码搜索
int	size()

Method Detail

searchCode

CodeBean[] searchCode(byte[] code,
                      double sim,
                      int rows)

在内存表中根据比对相似度进行特征码搜索

Parameters:

code - 要比对的特征码

sim - 相似度阀值

rows - 最大返回的记录数

Returns:

返回包含相似度(降序)的结果数组,如果没有查到匹配的记录则返回空数组

getFeature

CodeBean getFeature(byte[] featureId)

根据特征码ID在表中查找指定的记录

Parameters:

featureId - 特征码ID,MD5校验码(16 bytes)

Returns:

返回指定的特征记录,没有找到则返回null,featureId为null或空返回null

getFeatureByHex

CodeBean getFeatureByHex(java.lang.String featureId)

根据特征码ID在表中查找指定的记录

Parameters:

featureId - 特征码ID,MD5校验码(32字节HEX字符串)

Returns:

返回指定的特征记录,没有找到则返回null,featureId为null或空返回null

addFeature

boolean addFeature(byte[] featureId,
                   byte[] feature,
                   java.lang.String imgMD5)

添加一条特征码到内存表

Parameters:

featureId - 特征码ID(MD5校验码),为null时,native library会自动计算MD5作为特征码ID

feature - 特征码字节数组,为null时返回false

imgMD5 - 特征所属图的MD5(32字节HEX字符串),可为null

Returns:

添加成功返回true, 否则返回false

addFeature

boolean addFeature(byte[] featureId,
                   byte[] feature,
                   long appid)

添加一条特征码到内存表

Parameters:

featureId - 特征码ID(MD5校验码),为null时,native library会自动计算MD5作为特征码ID

feature - 特征码字节数组,为null时返回false

appid - 应用id,由调用者定义,可为null

Returns:

添加成功返回true, 否则返回false

removeFeature

boolean removeFeature(byte[] featureId)

根据特征码ID中表中删除指定的记录

Parameters:

featureId - 特征码ID,MD5校验码(16 bytes)

Returns:

成功删除则返回true,否则返回false

removeFeatureByHex

boolean removeFeatureByHex(java.lang.String featureId)

根据特征码ID中表中删除指定的记录

Parameters:

featureId - 特征码ID,MD5校验码(32字节HEX字符串)

Returns:

成功删除则返回true,否则返回false

clearAll

void clearAll()

删除内存表中所有特征数据

size

int size()

Returns:

内存表中元素个数