Package ai.tech5.sdk.abis.finger

Class T5FingerPalmMatcher

java.lang.Object

ai.tech5.sdk.abis.finger.T5FingerPalmMatcher

public class T5FingerPalmMatcher
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static int	FAST_IDENTIFY	Templates for both stages of matching (accelerator matching and precise matching) keeps in memory and identification performs in one step.
static int	NUM_PALM_PARTS
static int	SLOW_IDENTIFY	Only templates for 1st stage of matching (accelerator matching) keeps in memory templates for precise matching load in memory by request based on result of 1st stage of matching and identification performs in two steps.

Constructor Summary

Constructors

Constructor	Description
T5FingerPalmMatcher()	create object of Matcher.

Method Summary

Modifier and Type	Method	Description
void	cancel()	delete object of T5FingerLatentMatcher
boolean	create(int identify_mode, boolean check_doubles)	create object of T5FingerLatentMatcher
int	delete_record(java.lang.String id)	Function delete record from memory database Parameters:
int	get_max_template_size()
long	getFinalGallerySize()	Function return current gallery size
java.lang.String	getVersion()	The function returns version of Tech5_GalleryMatcher_ServerE Parameters:
int	identify_LPP(ai.tech5.sdk.abis.finger.MatchingParameters matchingParameters, byte[] probe_palm_template, byte[] palmPartMask, int numberOfThreads, int candidate_list_length, java.util.ArrayList<ai.tech5.sdk.abis.finger.CandidatesString> candidateList)	Function performs latent palm-palmprints identification in 1 step.
int	identify_PP(ai.tech5.sdk.abis.finger.MatchingParameters matchingParameters, ai.tech5.sdk.abis.finger.TpTemplate probe_palm_template, int numberOfThreads, int candidate_list_length, java.util.ArrayList<ai.tech5.sdk.abis.finger.CandidatesString> candidateList)	Function performs palmprint-palmprints identification in 1 step.
boolean	initLicense(java.lang.String licensePath)	Function sets license
int	insert_record(java.lang.String id, ai.tech5.sdk.abis.finger.TpTemplate palmTemplate)	Function insert record in memory database Parameters:
boolean	isRecordExist(java.lang.String id)	Function checks record state Parameters:
long	verify_palm(ai.tech5.sdk.abis.finger.MatchingParameters matchingParameters, byte[] probe_palm_template, byte[] gallery_palm_template, java.lang.Double score, java.lang.Double logFAR)	Function verify two palm templates

Methods inherited from class java.lang.Object

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

Field Detail

FAST_IDENTIFY

public static int FAST_IDENTIFY

Templates for both stages of matching (accelerator matching and precise matching) keeps in memory and identification performs in one step. It's more quick way, but required more RAM

SLOW_IDENTIFY

public static int SLOW_IDENTIFY

Only templates for 1st stage of matching (accelerator matching) keeps in memory templates for precise matching load in memory by request based on result of 1st stage of matching and identification performs in two steps. It's slower, but required less RAM

NUM_PALM_PARTS

public static int NUM_PALM_PARTS

Constructor Detail

T5FingerPalmMatcher

public T5FingerPalmMatcher()

create object of Matcher. Return NULL in case of error

Method Detail

getVersion

public java.lang.String getVersion()

The function returns version of Tech5_GalleryMatcher_ServerE Parameters:

Returns:

value of current version

create

public boolean create(int identify_mode,
                      boolean check_doubles)

create object of T5FingerLatentMatcher

Parameters:

identify_mode - (input) - identification mode ( @see IDENTIFY constants)

check_doubles - (input) - if true, check if record with such id already in exist will be performed while insert

Returns:

Return false in case of error

cancel

public void cancel()

delete object of T5FingerLatentMatcher

get_max_template_size

public int get_max_template_size()

Returns:

Function returns maximum size for template

initLicense

public boolean initLicense(java.lang.String licensePath)

Function sets license

Parameters:

licensePath - (input) - path to the license file

Returns:

true if success and false otherwise

verify_palm

public long verify_palm(ai.tech5.sdk.abis.finger.MatchingParameters matchingParameters,
                        byte[] probe_palm_template,
                        byte[] gallery_palm_template,
                        java.lang.Double score,
                        java.lang.Double logFAR)

Function verify two palm templates

Parameters:

matchingParameters - ( input) - matching parameters

probe_palm_template - ( input) - probe palm template

gallery_palm_template - ( input) - gallery palm template

score - (output) - similarity of two records in a range 0...1

logFAR - (output) - log10(FAR) corresponded to getting score

Returns:

SUCCESS if success and error code otherwise

insert_record

public int insert_record(java.lang.String id,
                         ai.tech5.sdk.abis.finger.TpTemplate palmTemplate)

Function insert record in memory database Parameters:

Parameters:

id - ( input) - unique record ID. NOTE: id - should be numerical only!

palmTemplate - ( input) - palm template record. @see PalmPart

Returns:

Returns SUCCESS if success and error code otherwise

delete_record

public int delete_record(java.lang.String id)

Function delete record from memory database Parameters:

Parameters:

id - ( input) - unique record ID. NOTE: id - should be numerical only!

Returns:

Returns number of removed records

getFinalGallerySize

public long getFinalGallerySize()

Function return current gallery size

Returns:

current gallery size

isRecordExist

public boolean isRecordExist(java.lang.String id)

Function checks record state Parameters:

Parameters:

id - ( input) - unique record ID. NOTE: id - should be numerical only!

Returns:

true if record with this id already exist in gallery and false otherwise

identify_PP

public int identify_PP(ai.tech5.sdk.abis.finger.MatchingParameters matchingParameters,
                       ai.tech5.sdk.abis.finger.TpTemplate probe_palm_template,
                       int numberOfThreads,
                       int candidate_list_length,
                       java.util.ArrayList<ai.tech5.sdk.abis.finger.CandidatesString> candidateList)

Function performs palmprint-palmprints identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode Parameters:

Parameters:

matchingParameters - ( input) - matching parameters

probe_palm_template - ( input) - probe palm template @see PalmPart

numberOfThreads - ( input) - number of threads that will be used in matching. 0 - means use all logical CPU (the value returned by omp_get_num_procs())

candidate_list_length - ( input) - size of final output candidate list

candidateList - (output) - output candidate list

Returns:

Returns SUCCESS if success and error code otherwise

identify_LPP

public int identify_LPP(ai.tech5.sdk.abis.finger.MatchingParameters matchingParameters,
                        byte[] probe_palm_template,
                        byte[] palmPartMask,
                        int numberOfThreads,
                        int candidate_list_length,
                        java.util.ArrayList<ai.tech5.sdk.abis.finger.CandidatesString> candidateList)

Function performs latent palm-palmprints identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode Parameters:

Parameters:

matchingParameters - ( input) - matching parameters

probe_palm_template - ( input) - probe latent palm template

palmPartMask - ( input) - define what parts of palm will be used in matching. Array must have NUM_PALM_PARTS elements.

numberOfThreads - ( input) - number of threads that will be used in matching. 0 - means use all logical CPU (the value returned by omp_get_num_procs())

candidate_list_length - ( input) - size of output candidate list

candidateList - (output) - candidate list of matching if success and zero otherwise

Returns:

Returns SUCCESS if success and error code otherwise