net.gdface.sdk.fse

Class BaseFeatureSearchEngine

java.lang.Object

net.gdface.sdk.fse.BaseFeatureSearchEngine

public abstract class BaseFeatureSearchEngine
extends java.lang.Object

特征码内存搜索引擎(FSE,feature search engine)java接口类(JNI)
与FseJniBridge拆分开主要是为了便于生成c header文件

Author:

guyadong

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseFeatureSearchEngine.FeatureSeImpl 实现FeatureSe

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INITIAL_CAPACITY
static float	DEFAULT_LOAD_FACTOR
static int	DEFAULT_MODE
static int	DEFAULT_OVERBLOCK_CAPACITY
protected static java.lang.String	ENV_FSE
protected static java.lang.String	FSE_LIBNAME
protected static boolean	libraryLoaded 动态库是否加载标志 子类在成功加载动态库后，须将此标志置为true
protected static java.lang.String	PROP_FSE
protected static java.lang.String	PROP_LIBNAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseFeatureSearchEngine()

Method Summary

Modifier and Type	Method and Description
static boolean	addFeature(byte[] id, byte[] code, java.lang.String imgMD5) 添加一条特征码到内存表 输入参数id, code为null时抛出IllegalArgumentException
static void	clearAll() 删除内存表中所有特征数据
static CodeBean	getFeature(byte[] id) 根据特征码ID在表中查找指定的记录
protected static java.lang.String	getFseHome() 查找 fse_home变量 优先在系统变量定义中查找'fse_home',如果找不到,再在环境变量中查找'FSE_HOME' 如果都找不到则返回null
protected static java.lang.String	getFseLibname()
protected static void	init() 用缺省值初始化
static void	init(int mode, int initCapacity, float loadFactor, int overBlockCapacity) JNI接口初始化
static boolean	isLibraryLoaded()
protected static void	loadLibrary(java.lang.String libdir, java.lang.String libname) 加载名为libname的动态库, 如果libdir为null则调用System.loadLibrary(String)在系统搜索路径下查找动态库, 否则调用System.load(String)加载libdir指定路径下的动态库
static void	release() 释放所有资源
static boolean	removeFeature(byte[] id) 根据特征码ID中表中删除指定的记录
static CodeBean[]	searchCode(byte[] code, double sim, int rows, java.util.Collection<java.lang.String> imgMD5Set, net.gdface.utils.TimeCostProbe timeCost) 参见 searchCode(byte[], double, int, Set, TimeCostProbe)
static CodeBean[]	searchCode(byte[] code, double sim, int rows, java.util.Set<java.lang.String> imgMD5Set, net.gdface.utils.TimeCostProbe timeCost) 特征码code与数据库中的特征码比对,以相似度降序返回比对结果
static CodeBean[]	searchCode(byte[] code, double sim, int rows, java.lang.String[] imgMD5Set) 在内存表中根据比对相似度进行特征码搜索
static int	size()
static java.lang.String	statInfo()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENV_FSE

protected static final java.lang.String ENV_FSE

See Also:

Constant Field Values

PROP_FSE

protected static final java.lang.String PROP_FSE

PROP_LIBNAME

protected static final java.lang.String PROP_LIBNAME

See Also:

Constant Field Values

FSE_LIBNAME

protected static final java.lang.String FSE_LIBNAME

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

See Also:

Constant Field Values

DEFAULT_LOAD_FACTOR

public static final float DEFAULT_LOAD_FACTOR

See Also:

Constant Field Values

DEFAULT_OVERBLOCK_CAPACITY

public static final int DEFAULT_OVERBLOCK_CAPACITY

See Also:

Constant Field Values

DEFAULT_MODE

public static final int DEFAULT_MODE

See Also:

Constant Field Values

libraryLoaded

protected static boolean libraryLoaded

动态库是否加载标志
子类在成功加载动态库后，须将此标志置为true

Constructor Detail

BaseFeatureSearchEngine

protected BaseFeatureSearchEngine()

Method Detail

loadLibrary

protected static void loadLibrary(java.lang.String libdir,
                                  java.lang.String libname)

加载名为libname的动态库, 如果libdir为null则调用System.loadLibrary(String)在系统搜索路径下查找动态库, 否则调用System.load(String)加载libdir指定路径下的动态库

Parameters:

libdir -

libname -

getFseHome

protected static final java.lang.String getFseHome()

查找 fse_home变量
优先在系统变量定义中查找'fse_home',如果找不到,再在环境变量中查找'FSE_HOME'
如果都找不到则返回null

Returns:

getFseLibname

protected static final java.lang.String getFseLibname()

init

protected static void init()

用缺省值初始化

searchCode

public static final CodeBean[] searchCode(byte[] code,
                                          double sim,
                                          int rows,
                                          java.util.Set<java.lang.String> imgMD5Set,
                                          net.gdface.utils.TimeCostProbe timeCost)

特征码code与数据库中的特征码比对,以相似度降序返回比对结果

Parameters:

code -

sim -

rows -

imgMD5Set -

timeCost -

Returns:

CodeBean数组

See Also:

searchCode(byte[], double, int, String[])

searchCode

public static final CodeBean[] searchCode(byte[] code,
                                          double sim,
                                          int rows,
                                          java.util.Collection<java.lang.String> imgMD5Set,
                                          net.gdface.utils.TimeCostProbe timeCost)

参见 searchCode(byte[], double, int, Set, TimeCostProbe)

Parameters:

code -

sim -

rows -

imgMD5Set -

timeCost -

Returns:

See Also:

searchCode(byte[], double, int, Set, TimeCostProbe)

isLibraryLoaded

public static boolean isLibraryLoaded()

Returns:

动态库已经正确加载则返回false,否则返回false

init

public static void init(int mode,
                        int initCapacity,
                        float loadFactor,
                        int overBlockCapacity)

JNI接口初始化

Parameters:

mode - 指定运行模式(opencl,sse),默认为0(自动识别)

initCapacity - 内存表初始化容量

loadFactor - 内存表扩容因子

overBlockCapacity - 过载表容量

release

public static void release()

释放所有资源

searchCode

public static CodeBean[] searchCode(byte[] code,
                                    double sim,
                                    int rows,
                                    java.lang.String[] imgMD5Set)

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

Parameters:

code - 要比对的特征码

sim - 相似度阀值

rows - 最大返回的记录数

imgMD5Set - 比对的图片范围

Returns:

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

getFeature

public static CodeBean getFeature(byte[] id)

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

Parameters:

id - 特征码ID,为null时抛出IllegalArgumentException

Returns:

没有找到则返回空数组

addFeature

public static boolean addFeature(byte[] id,
                                 byte[] code,
                                 java.lang.String imgMD5)

添加一条特征码到内存表
输入参数id, code为null时抛出IllegalArgumentException

Parameters:

id - 特征码ID(MD5校验码)

code - 特征码字节数组

imgMD5 - 特征码所在图像的MD5校验码,可为null

Returns:

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

removeFeature

public static boolean removeFeature(byte[] id)

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

Parameters:

id - 特征码MD5校验码

Returns:

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

clearAll

public static void clearAll()

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

size

public static int size()

Returns:

内存表中元素个数

statInfo

public static java.lang.String statInfo()

Returns:

哈希表统计信息(用于debug测试)