TECH5 Gallery Matcher ServerE 2.7.0
Data Structures | Macros | Enumerations | Enumerator | Functions | Variables
Gallery Matcher ServerE SDK

Data Structures

class  Tech5Finger::candidates_string
 candidates_string More...
 
class  Tech5Finger::TemplateCreator
 TemplateCreator. More...
 
class  Tech5Finger::FpTemplateChecker
 FpTemplateChecker. More...
 
class  Tech5Finger::MatchingParameters
 MatchingParameters. More...
 
class  Tech5Finger::Matcher
 Matcher. More...
 
class  Tech5Finger::LT_Matcher
 LT_Matcher. More...
 
class  Tech5Finger::Latent_Matcher
 Latent_Matcher. More...
 
class  Tech5Finger::Palm_Matcher
 Palm_Matcher. More...
 
class  Tech5Finger::Latent_Palm_Matcher
 Latent_Palm_Matcher. More...
 

Macros

#define MATCHING_SPEED_DEF   NORMAL_MATCH_SPEED
 default matching speed
 

Enumerations

enum  Tech5Finger::IDENTIFY_MODE { Tech5Finger::FAST_IDENTIFY = 0 , Tech5Finger::SLOW_IDENTIFY = 1 }
 IDENTIFY_MODE. More...
 

Functions

TECH5_FINGER_EXPORT const char * Tech5Finger::getVersion ()
 getVersion / More...
 
static TemplateCreatorTech5Finger::TemplateCreator::create ()
 create create object of TemplateCreator More...
 
static void Tech5Finger::TemplateCreator::cancel (TemplateCreator *&templateCreator)
 cancel delete object of TemplateCreator
 
static uint32_t Tech5Finger::TemplateCreator::get_max_template_size (char imageType)
 get_max_template_size More...
 
virtual bool Tech5Finger::TemplateCreator::init_license (const char *licensePath, void *env=nullptr)=0
 init_license Function set license More...
 
virtual uint32_t Tech5Finger::TemplateCreator::createTemplate (ImageData &image, uint8_t *fpTemplate, uint32_t &templateSize, uint8_t *skeleton, uint32_t &skeletonSize, uint8_t &quality, char imageType, bool doSegmentation)=0
 createTemplate Function build template from image from one of supported formats More...
 
static FpTemplateCheckerTech5Finger::FpTemplateChecker::create ()
 create create object of FpTemplateChecker More...
 
static void Tech5Finger::FpTemplateChecker::cancel (FpTemplateChecker *&checker)
 cancel delete object of FpTemplateChecker
 
virtual bool Tech5Finger::FpTemplateChecker::check (uint8_t *fpTemplate)=0
 check Function check fingerprint template - if it has a right format and in good health More...
 
static MatcherTech5Finger::Matcher::create (IDENTIFY_MODE identify_mode, bool check_doubles)
 create create object of Matcher More...
 
static void Tech5Finger::Matcher::cancel (Matcher *&matcher)
 cancel delete object of Matcher
 
static uint32_t Tech5Finger::Matcher::get_max_template_size ()
 get_max_template_size More...
 
virtual bool Tech5Finger::Matcher::init_license (const char *licensePath)=0
 init_license Function set license More...
 
virtual uint32_t Tech5Finger::Matcher::verify_record (MatchingParameters &matchingParameters, TpTemplate &tpTemplate1, TpTemplate &tpTemplate2, double &score, double &logFAR)=0
 verify_record Function verify two records, each of them can have from 1 till 10 fingerprints More...
 
virtual uint32_t Tech5Finger::Matcher::insert_record (const std::string &id, TpTemplate &tpTemplate, PersonalData *personalData)=0
 insert_record Function insert record in memory database that is used in indentification More...
 
virtual uint32_t Tech5Finger::Matcher::delete_record (const std::string &id)=0
 delete_record Function delete record from memory database that is used in indentification More...
 
virtual uint64_t Tech5Finger::Matcher::get_final_gallery_size () const =0
 get_final_gallery_size More...
 
virtual bool Tech5Finger::Matcher::isRecordExist (const std::string &id)=0
 isRecordExist More...
 
virtual uint32_t Tech5Finger::Matcher::identify_record (MatchingParameters &matchingParameters, TpTemplate &probe, PersonalData *probePersonalData, const uint32_t numberOfThreads, const uint32_t candidate_list_length, std::vector< candidates_string > &candidate_list)=0
 identify_record Function performs tenprint-tenprints identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode More...
 
virtual uint32_t Tech5Finger::Matcher::identify_record_1st (MatchingParameters &matchingParameters, TpTemplate &probe, PersonalData *probePersonalData, const uint32_t numberOfThreads, const uint32_t candidate_list_length, std::vector< string > &candidate_list_id)=0
 identify_record_1st Function performs 1st stage of tenprint-tenprints identification. NOTE: function can be called only in SLOW_IDENTIFY mode More...
 
virtual void Tech5Finger::Matcher::clean_gallery_2nd ()=0
 clean_gallery_2nd Function clean the memory database that is used by 'identify_record_2nd' function for 2nd stage of indentification It should be called before the first call of 'insert_record_2nd'
 
virtual uint32_t Tech5Finger::Matcher::insert_record_2nd (const std::string &id, TpTemplate &tpTemplate)=0
 insert_record_2nd Function insert record in memory database that is used by 'identify_record_2nd' function for 2nd stage of indentification More...
 
virtual uint32_t Tech5Finger::Matcher::identify_record_2nd (MatchingParameters &matchingParameters, TpTemplate &probe, const uint32_t numberOfThreads, const uint32_t candidate_list_length, std::vector< candidates_string > &candidate_list)=0
 identify_record_2nd Function performs 2nd (final) stage of tenprint-tenprints identification. NOTE: function can be called only in SLOW_IDENTIFY mode More...
 
static LT_MatcherTech5Finger::LT_Matcher::create (IDENTIFY_MODE identify_mode, bool check_doubles)
 create create object of LT_Matcher More...
 
static void Tech5Finger::LT_Matcher::cancel (LT_Matcher *&matcher)
 cancel delete object of LT_Matcher
 
static uint32_t Tech5Finger::LT_Matcher::get_max_template_size ()
 get_max_template_size More...
 
virtual bool Tech5Finger::LT_Matcher::init_license (const char *licensePath)=0
 init_license Function set license More...
 
virtual uint32_t Tech5Finger::LT_Matcher::verify_latent (MatchingParameters &matchingParameters, uint8_t *latent_template, uint8_t *finger_template, double &score, double &logFAR)=0
 verify_latent Function verify latent template with fingerprint template More...
 
virtual uint32_t Tech5Finger::LT_Matcher::insert_record (std::string &id, TpTemplate &tpTemplate)=0
 insert_record Function insert record in memory database that is used in indentification More...
 
virtual uint32_t Tech5Finger::LT_Matcher::delete_record (std::string &id)=0
 delete_record Function delete record from memory database that is used in indentification More...
 
virtual uint64_t Tech5Finger::LT_Matcher::get_final_gallery_size () const =0
 get_final_gallery_size More...
 
virtual bool Tech5Finger::LT_Matcher::isRecordExist (std::string &id)=0
 isRecordExist More...
 
virtual uint32_t Tech5Finger::LT_Matcher::identify_LT (MatchingParameters &matchingParameters, uint8_t *latent_template, uint8_t fingerMask[10], const uint32_t number_threads, const uint32_t candidate_list_length, std::vector< candidates_string > &candidate_list)=0
 identify_latent Function performs latent-tenprints identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode More...
 
static Latent_MatcherTech5Finger::Latent_Matcher::create (IDENTIFY_MODE identify_mode, bool check_doubles)
 create create object of Latent_Matcher More...
 
static void Tech5Finger::Latent_Matcher::cancel (Latent_Matcher *&matcher)
 cancel delete object of LT_Matcher
 
static uint32_t Tech5Finger::Latent_Matcher::get_max_template_size ()
 get_max_template_size More...
 
virtual bool Tech5Finger::Latent_Matcher::init_license (const char *licensePath)=0
 init_license Function set license More...
 
virtual uint32_t Tech5Finger::Latent_Matcher::verify_latent (MatchingParameters &matchingParameters, uint8_t *latent_template, uint8_t *finger_template, double &score, double &logFAR)=0
 verify_latent Function verify latent template with latent or fingerprint template More...
 
virtual uint32_t Tech5Finger::Latent_Matcher::insert_latent (std::string &id, uint8_t *latent)=0
 insert_latent Function insert record in memory database that is used in indentification More...
 
virtual uint32_t Tech5Finger::Latent_Matcher::delete_record (std::string &id)=0
 delete_record Function delete record from memory database that is used in indentification More...
 
virtual uint64_t Tech5Finger::Latent_Matcher::get_final_gallery_size () const =0
 get_final_gallery_size More...
 
virtual bool Tech5Finger::Latent_Matcher::isRecordExist (std::string &id)=0
 isRecordExist More...
 
virtual uint32_t Tech5Finger::Latent_Matcher::identify_TL (MatchingParameters &matchingParameters, TpTemplate &probeTpTemplate, const uint32_t number_threads, const uint32_t candidate_list_length, std::vector< candidates_string > &candidate_list)=0
 identify_TL Function performs tenprint-latents identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode More...
 
virtual uint32_t Tech5Finger::Latent_Matcher::identify_LL (MatchingParameters &matchingParameters, uint8_t *latent_template, const uint32_t number_threads, const uint32_t candidate_list_length, std::vector< candidates_string > &candidate_list)=0
 identify_LL Function performs latent-latents identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode More...
 
static Palm_MatcherTech5Finger::Palm_Matcher::create (IDENTIFY_MODE identify_mode, bool check_doubles)
 create create object of Palm_Matcher More...
 
static void Tech5Finger::Palm_Matcher::cancel (Palm_Matcher *&matcher)
 cancel delete object of Palm_Matcher
 
static uint32_t Tech5Finger::Palm_Matcher::get_max_template_size ()
 get_max_template_size More...
 
virtual bool Tech5Finger::Palm_Matcher::init_license (const char *licensePath)=0
 init_license Function set license More...
 
virtual uint32_t Tech5Finger::Palm_Matcher::verify_palm (MatchingParameters &matchingParameters, uint8_t *probe_palm_template, uint8_t *gallery_palm_template, double &score, double &logFAR)=0
 verify_palm Function verify two palm templates More...
 
virtual uint32_t Tech5Finger::Palm_Matcher::insert_record (std::string &id, TpTemplate &palmTemplate)=0
 insert_record Function insert record in memory database that is used in indentification More...
 
virtual uint32_t Tech5Finger::Palm_Matcher::delete_record (std::string &id)=0
 delete_record Function delete record from memory database that is used in indentification More...
 
virtual uint64_t Tech5Finger::Palm_Matcher::get_final_gallery_size () const =0
 get_final_gallery_size More...
 
virtual bool Tech5Finger::Palm_Matcher::isRecordExist (std::string &id)=0
 isRecordExist More...
 
virtual uint32_t Tech5Finger::Palm_Matcher::identify_PP (MatchingParameters &matchingParameters, TpTemplate probe_palm_template, const uint32_t number_threads, const uint32_t candidate_list_length, std::vector< candidates_string > &candidate_list)=0
 identify_PP Function performs palmprint-palmprints identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode More...
 
virtual uint32_t Tech5Finger::Palm_Matcher::identify_LPP (MatchingParameters &matchingParameters, uint8_t *probe_palm_template, uint8_t palmPartMask[NUM_PALM_PARTS], const uint32_t number_threads, const uint32_t candidate_list_length, std::vector< candidates_string > &candidate_list)=0
 identify_LPP Function performs latent palm-palmprints identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode More...
 
static Latent_Palm_MatcherTech5Finger::Latent_Palm_Matcher::create (IDENTIFY_MODE identify_mode, bool check_doubles)
 create create object of Latent_Palm_Matcher More...
 
static void Tech5Finger::Latent_Palm_Matcher::cancel (Latent_Palm_Matcher *&matcher)
 cancel delete object of Latent_Palm_Matcher
 
static uint32_t Tech5Finger::Latent_Palm_Matcher::get_max_template_size ()
 get_max_template_size More...
 
virtual bool Tech5Finger::Latent_Palm_Matcher::init_license (const char *licensePath)=0
 init_license Function set license More...
 
virtual uint32_t Tech5Finger::Latent_Palm_Matcher::verify_palm (MatchingParameters &matchingParameters, uint8_t *probe_palm_template, uint8_t *gallery_palm_template, double &score, double &logFAR)=0
 verify_palm Function verify two palm templates More...
 
virtual uint32_t Tech5Finger::Latent_Palm_Matcher::insert_record (std::string &id, uint8_t *palmTemplate)=0
 insert_record Function insert record in memory database that is used in indentification More...
 
virtual uint32_t Tech5Finger::Latent_Palm_Matcher::delete_record (std::string &id)=0
 delete_record Function delete record from memory database that is used in indentification More...
 
virtual uint64_t Tech5Finger::Latent_Palm_Matcher::get_final_gallery_size () const =0
 get_final_gallery_size More...
 
virtual bool Tech5Finger::Latent_Palm_Matcher::isRecordExist (std::string &id)=0
 isRecordExist More...
 
virtual uint32_t Tech5Finger::Latent_Palm_Matcher::identify_PLP (MatchingParameters &matchingParameters, TpTemplate probe_palm_template, const uint32_t number_threads, const uint32_t candidate_list_length, std::vector< candidates_string > &candidate_list)=0
 identify_PL Function performs palmprint-palm latents identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode More...
 
virtual uint32_t Tech5Finger::Latent_Palm_Matcher::identify_LPLP (MatchingParameters &matchingParameters, uint8_t *probe_palm_template, const uint32_t number_threads, const uint32_t candidate_list_length, std::vector< candidates_string > &candidate_list)=0
 identify_LPLP Function performs palm latent - palm latents identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode More...
 

Variables

std::string Tech5Finger::candidates_string::uid
 unique record ID
 
FINGERS   Tech5Finger::candidates_string::finger
 
PalmPart   Tech5Finger::candidates_string::palmPart
 
union {
   FINGERS   finger
 
   PalmPart   palmPart
 
}; 
 finger or palm part number. NOTE: ignore in TP-TP, LP_LP, PP-PP, LPP-LPP matching
 
float Tech5Finger::candidates_string::score
 matching score (0...1)
 
float Tech5Finger::candidates_string::logFAR
 logFAR
 
MATCH_SPEED Tech5Finger::MatchingParameters::searchSpeed
 Matching speed. The current valid value from 0 to 6.
 
unsigned int Tech5Finger::MatchingParameters::maxAngle
 The maximum of the finger turn angle for all fingers expcept thumbs, (0...180 degree)
 
unsigned int Tech5Finger::MatchingParameters::maxAngleThumbs
 the maximum of the finger turn angle for thumbs, (0...180 degree)
 
MATCHING_MODE Tech5Finger::MatchingParameters::matchingMode
 Matching mode. More...
 

Detailed Description

This is the Gallery group

Enumeration Type Documentation

◆ IDENTIFY_MODE

IDENTIFY_MODE.

Enumerator
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 

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

Function Documentation

◆ check()

virtual bool Tech5Finger::FpTemplateChecker::check ( uint8_t *  fpTemplate)
pure virtual

check Function check fingerprint template - if it has a right format and in good health

Parameters
fpTemplate( input) - fingerprint template for checking
Returns
Function returns true if template is OK and false otherwise

◆ create() [1/7]

static TemplateCreator * Tech5Finger::TemplateCreator::create ( )
static

create create object of TemplateCreator

Returns
Function returns pointer to the object of TemplateCreator if success and NULL otherwise

◆ create() [2/7]

static FpTemplateChecker * Tech5Finger::FpTemplateChecker::create ( )
static

create create object of FpTemplateChecker

Returns
Function returns pointer to the object of FpTemplateChecker if success and NULL otherwise

◆ create() [3/7]

static Matcher * Tech5Finger::Matcher::create ( IDENTIFY_MODE  identify_mode,
bool  check_doubles 
)
static

create create object of Matcher

Parameters
identify_mode(input) - identification mode (see description of IDENTIFY_MODE)
check_doubles(input) - if true, check if record with such id already in exist will be performed while insert
Returns
Function returns pointer to the object of Matcher if success and NULL otherwise

◆ create() [4/7]

static LT_Matcher * Tech5Finger::LT_Matcher::create ( IDENTIFY_MODE  identify_mode,
bool  check_doubles 
)
static

create create object of LT_Matcher

Parameters
identify_mode(input) - identification mode (see description of IDENTIFY_MODE)
check_doubles(input) - if true, check if record with such id already in exist will be performed while insert
Returns
Function returns pointer to the object of Matcher if success and NULL otherwise

◆ create() [5/7]

static Latent_Matcher * Tech5Finger::Latent_Matcher::create ( IDENTIFY_MODE  identify_mode,
bool  check_doubles 
)
static

create create object of Latent_Matcher

Parameters
identify_mode(input) - identification mode (see description of IDENTIFY_MODE)
check_doubles(input) - if true, check if record with such id already in exist will be performed while insert
Returns
Function returns pointer to the object of Matcher if success and NULL otherwise

◆ create() [6/7]

static Palm_Matcher * Tech5Finger::Palm_Matcher::create ( IDENTIFY_MODE  identify_mode,
bool  check_doubles 
)
static

create create object of Palm_Matcher

Parameters
identify_mode(input) - identification mode (see description of IDENTIFY_MODE)
check_doubles(input) - if true, check if record with such id already in exist will be performed while insert
Returns
Function returns pointer to the object of Matcher if success and NULL otherwise

◆ create() [7/7]

static Latent_Palm_Matcher * Tech5Finger::Latent_Palm_Matcher::create ( IDENTIFY_MODE  identify_mode,
bool  check_doubles 
)
static

create create object of Latent_Palm_Matcher

Parameters
identify_mode(input) - identification mode (see description of IDENTIFY_MODE)
check_doubles(input) - if true, check if record with such id already in exist will be performed while insert
Returns
Function returns pointer to the object of Matcher if success and NULL otherwise

◆ createTemplate()

virtual uint32_t Tech5Finger::TemplateCreator::createTemplate ( ImageData image,
uint8_t *  fpTemplate,
uint32_t &  templateSize,
uint8_t *  skeleton,
uint32_t &  skeletonSize,
uint8_t &  quality,
char  imageType,
bool  doSegmentation 
)
pure virtual

createTemplate Function build template from image from one of supported formats

See also
IMAGE_TYPE
Parameters
image( input) - image data
See also
ImageData
Parameters
fpTemplate( input) - pointer to the buffer where fingerprint template will be copied. Memory for that buffer should be allocated in application based on maximum template size value, returned by 'get_max__template_size' function
templateSize(output) - size of builded template
skeleton( input) - pointer to the buffer where skeleton will be copied. Memory for that buffer should be allocated in application (size of skeleton cannot be more than size of uncompressed image, i.e. width * height)
skeletonSize(output) - size of skeleton data
quality(output) - quality of fingerptint image
imageType( input) - can be: 'F' - finger, 'L' - latent, 'P' - palm, 'S' - palm latent
doSegmentation( input) - if true, then before build template segmentation will be performed. It will decrease the time of image processing. NOTE: for criminal system and in any other cases, when you are going to show image with the feature, you should set this parameter to false. In other case template will not fit to the features because image will be cropped before build template and all features coordinates will not correspond to the coordinates on original image
Returns
Function returns SUCCESS if success and error code otherwise

◆ delete_record() [1/5]

virtual uint32_t Tech5Finger::Matcher::delete_record ( const std::string &  id)
pure virtual

delete_record Function delete record from memory database that is used in indentification

Parameters
id( input) - unique record ID. NOTE: id - slhould be numerical only!
Returns
Function returns SUCCESS if success and error code otherwise

◆ delete_record() [2/5]

virtual uint32_t Tech5Finger::LT_Matcher::delete_record ( std::string &  id)
pure virtual

delete_record Function delete record from memory database that is used in indentification

Parameters
id( input) - unique record ID. NOTE: id - slhould be numerical only!
Returns
Function returns SUCCESS if success and error code otherwise

◆ delete_record() [3/5]

virtual uint32_t Tech5Finger::Latent_Matcher::delete_record ( std::string &  id)
pure virtual

delete_record Function delete record from memory database that is used in indentification

Parameters
id( input) - unique record ID. NOTE: id - slhould be numerical only!
Returns
Function returns SUCCESS if success and error code otherwise

◆ delete_record() [4/5]

virtual uint32_t Tech5Finger::Palm_Matcher::delete_record ( std::string &  id)
pure virtual

delete_record Function delete record from memory database that is used in indentification

Parameters
id( input) - unique record ID. NOTE: id - slhould be numerical only!
Returns
Function returns SUCCESS if success and error code otherwise

◆ delete_record() [5/5]

virtual uint32_t Tech5Finger::Latent_Palm_Matcher::delete_record ( std::string &  id)
pure virtual

delete_record Function delete record from memory database that is used in indentification

Parameters
id( input) - unique record ID. NOTE: id - slhould be numerical only!
Returns
Function returns SUCCESS if success and error code otherwise

◆ get_final_gallery_size() [1/5]

virtual uint64_t Tech5Finger::Matcher::get_final_gallery_size ( ) const
pure virtual

get_final_gallery_size

Returns
Function returns the current gallery size

◆ get_final_gallery_size() [2/5]

virtual uint64_t Tech5Finger::LT_Matcher::get_final_gallery_size ( ) const
pure virtual

get_final_gallery_size

Returns
Function returns the current gallery size

◆ get_final_gallery_size() [3/5]

virtual uint64_t Tech5Finger::Latent_Matcher::get_final_gallery_size ( ) const
pure virtual

get_final_gallery_size

Returns
Function returns the current gallery size

◆ get_final_gallery_size() [4/5]

virtual uint64_t Tech5Finger::Palm_Matcher::get_final_gallery_size ( ) const
pure virtual

get_final_gallery_size

Returns
Function returns the current gallery size

◆ get_final_gallery_size() [5/5]

virtual uint64_t Tech5Finger::Latent_Palm_Matcher::get_final_gallery_size ( ) const
pure virtual

get_final_gallery_size

Returns
Function returns the current gallery size

◆ get_max_template_size() [1/6]

static uint32_t Tech5Finger::Matcher::get_max_template_size ( )
static

get_max_template_size

Returns
Function returns maximum size of template that can be created by one of 'create_Template' functions

◆ get_max_template_size() [2/6]

static uint32_t Tech5Finger::LT_Matcher::get_max_template_size ( )
static

get_max_template_size

Returns
Function returns maximum size of template that can be created by one of 'create_Template' functions

◆ get_max_template_size() [3/6]

static uint32_t Tech5Finger::Latent_Matcher::get_max_template_size ( )
static

get_max_template_size

Returns
Function returns maximum size of template that can be created by one of 'create_Template' functions

◆ get_max_template_size() [4/6]

static uint32_t Tech5Finger::Palm_Matcher::get_max_template_size ( )
static

get_max_template_size

Returns
Function returns maximum size of template that can be created by one of 'create_Template' functions

◆ get_max_template_size() [5/6]

static uint32_t Tech5Finger::Latent_Palm_Matcher::get_max_template_size ( )
static

get_max_template_size

Returns
Function returns maximum size of template that can be created by one of 'create_Template' functions

◆ get_max_template_size() [6/6]

static uint32_t Tech5Finger::TemplateCreator::get_max_template_size ( char  imageType)
static

get_max_template_size

Returns
Function returns maximum size of template that can be created by one of 'create_Template' functions
Parameters
imageType(input) - can be: 'F' - finger, 'L' - latent, 'P' - palm, 'S' - palm latent

◆ getVersion()

TECH5_FINGER_EXPORT const char * Tech5Finger::getVersion ( )

getVersion /

Returns
return SDK version as a string

◆ identify_LL()

virtual uint32_t Tech5Finger::Latent_Matcher::identify_LL ( MatchingParameters matchingParameters,
uint8_t *  latent_template,
const uint32_t  number_threads,
const uint32_t  candidate_list_length,
std::vector< candidates_string > &  candidate_list 
)
pure virtual

identify_LL Function performs latent-latents identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode

Parameters
matchingParameters( input) - matching parameters
latent_template( input) - latent template
number_threads( 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
candidate_list(output) - output candidate list
Returns
Function returns SUCCESS if success and error code otherwise

◆ identify_LPLP()

virtual uint32_t Tech5Finger::Latent_Palm_Matcher::identify_LPLP ( MatchingParameters matchingParameters,
uint8_t *  probe_palm_template,
const uint32_t  number_threads,
const uint32_t  candidate_list_length,
std::vector< candidates_string > &  candidate_list 
)
pure virtual

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

Parameters
matchingParameters( input) - matching parameters
probe_palm_template( input) - probe latent palm template
number_threads( 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
candidate_list(output) - output candidate list
Returns
Function returns SUCCESS if success and error code otherwise

◆ identify_LPP()

virtual uint32_t Tech5Finger::Palm_Matcher::identify_LPP ( MatchingParameters matchingParameters,
uint8_t *  probe_palm_template,
uint8_t  palmPartMask[NUM_PALM_PARTS],
const uint32_t  number_threads,
const uint32_t  candidate_list_length,
std::vector< candidates_string > &  candidate_list 
)
pure virtual

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

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
number_threads( 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
candidate_list(output) - output candidate list
Returns
Function returns SUCCESS if success and error code otherwise

◆ identify_LT()

virtual uint32_t Tech5Finger::LT_Matcher::identify_LT ( MatchingParameters matchingParameters,
uint8_t *  latent_template,
uint8_t  fingerMask[10],
const uint32_t  number_threads,
const uint32_t  candidate_list_length,
std::vector< candidates_string > &  candidate_list 
)
pure virtual

identify_latent Function performs latent-tenprints identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode

Parameters
matchingParameters( input) - matching parameters
latent_template( input) - latent template
fingerMask( input) - define what fingers will be used in matching
number_threads( 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
candidate_list(output) - output candidate list
Returns
Function returns SUCCESS if success and error code otherwise

◆ identify_PLP()

virtual uint32_t Tech5Finger::Latent_Palm_Matcher::identify_PLP ( MatchingParameters matchingParameters,
TpTemplate  probe_palm_template,
const uint32_t  number_threads,
const uint32_t  candidate_list_length,
std::vector< candidates_string > &  candidate_list 
)
pure virtual

identify_PL Function performs palmprint-palm latents identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode

Parameters
matchingParameters( input) - matching parameters
probe_palm_template( input) - probe palm template
number_threads( 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
candidate_list(output) - output candidate list
Returns
Function returns SUCCESS if success and error code otherwise

◆ identify_PP()

virtual uint32_t Tech5Finger::Palm_Matcher::identify_PP ( MatchingParameters matchingParameters,
TpTemplate  probe_palm_template,
const uint32_t  number_threads,
const uint32_t  candidate_list_length,
std::vector< candidates_string > &  candidate_list 
)
pure virtual

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

Parameters
matchingParameters( input) - matching parameters
probe_palm_template( input) - probe palm template
number_threads( 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
candidate_list(output) - output candidate list
Returns
Function returns SUCCESS if success and error code otherwise

◆ identify_record()

virtual uint32_t Tech5Finger::Matcher::identify_record ( MatchingParameters matchingParameters,
TpTemplate probe,
PersonalData probePersonalData,
const uint32_t  numberOfThreads,
const uint32_t  candidate_list_length,
std::vector< candidates_string > &  candidate_list 
)
pure virtual

identify_record Function performs tenprint-tenprints identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode

Parameters
matchingParameters( input) - matching parameters
probe( input) - probe 10-finger record. It can have from 1 till 10 fingerprint templates.
probePersonalData( input) - some personal data. If it's NULL, then no binning will be used while matching
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
candidate_list(output) - output candidate list
Returns
Function returns SUCCESS if success and error code otherwise

◆ identify_record_1st()

virtual uint32_t Tech5Finger::Matcher::identify_record_1st ( MatchingParameters matchingParameters,
TpTemplate probe,
PersonalData probePersonalData,
const uint32_t  numberOfThreads,
const uint32_t  candidate_list_length,
std::vector< string > &  candidate_list_id 
)
pure virtual

identify_record_1st Function performs 1st stage of tenprint-tenprints identification. NOTE: function can be called only in SLOW_IDENTIFY mode

Parameters
matchingParameters( input) - matching parameters
probe( input) - probe 10-finger record. It can have from 1 till 10 fingerprint templates.
probePersonalData( input) - some personal data. If it's NULL, then no binning will be used while matching
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 (that should be get after perform both stages of identifications)
candidate_list_id(output) - candidate list for 1st stage of matching
Returns
Function returns SUCCESS if success and error code otherwise

◆ identify_record_2nd()

virtual uint32_t Tech5Finger::Matcher::identify_record_2nd ( MatchingParameters matchingParameters,
TpTemplate probe,
const uint32_t  numberOfThreads,
const uint32_t  candidate_list_length,
std::vector< candidates_string > &  candidate_list 
)
pure virtual

identify_record_2nd Function performs 2nd (final) stage of tenprint-tenprints identification. NOTE: function can be called only in SLOW_IDENTIFY mode

Parameters
matchingParameters( input) - matching parameters
probe( input) - probe 10-finger record. It can have from 1 till 10 fingerprint templates.
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
candidate_list(output) - output candidate list
Returns
Function returns SUCCESS if success and error code otherwise

◆ identify_TL()

virtual uint32_t Tech5Finger::Latent_Matcher::identify_TL ( MatchingParameters matchingParameters,
TpTemplate probeTpTemplate,
const uint32_t  number_threads,
const uint32_t  candidate_list_length,
std::vector< candidates_string > &  candidate_list 
)
pure virtual

identify_TL Function performs tenprint-latents identification in 1 step. NOTE: function can be called only in FAST_IDENTIFY mode

Parameters
matchingParameters( input) - matching parameters
probeTpTemplate( input) - probe 20f (10 roll and 10 flat) templates
number_threads( 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
candidate_list(output) - output candidate list
Returns
Function returns SUCCESS if success and error code otherwise

◆ init_license() [1/6]

virtual bool Tech5Finger::Matcher::init_license ( const char *  licensePath)
pure virtual

init_license Function set license

Parameters
licensePath(input) - path to the license file
Returns
Function returns true if success and false otherwise

◆ init_license() [2/6]

virtual bool Tech5Finger::LT_Matcher::init_license ( const char *  licensePath)
pure virtual

init_license Function set license

Parameters
licensePath(input) - path to the license file
Returns
Function returns true if success and false otherwise

◆ init_license() [3/6]

virtual bool Tech5Finger::Latent_Matcher::init_license ( const char *  licensePath)
pure virtual

init_license Function set license

Parameters
licensePath(input) - path to the license file
Returns
Function returns true if success and false otherwise

◆ init_license() [4/6]

virtual bool Tech5Finger::Palm_Matcher::init_license ( const char *  licensePath)
pure virtual

init_license Function set license

Parameters
licensePath(input) - path to the license file
Returns
Function returns true if success and false otherwise

◆ init_license() [5/6]

virtual bool Tech5Finger::Latent_Palm_Matcher::init_license ( const char *  licensePath)
pure virtual

init_license Function set license

Parameters
licensePath(input) - path to the license file
Returns
Function returns true if success and false otherwise

◆ init_license() [6/6]

virtual bool Tech5Finger::TemplateCreator::init_license ( const char *  licensePath,
void *  env = nullptr 
)
pure virtual

init_license Function set license

Parameters
licensePath(input) - path to the license file
Returns
Function returns true if success and false otherwise

◆ insert_latent()

virtual uint32_t Tech5Finger::Latent_Matcher::insert_latent ( std::string &  id,
uint8_t *  latent 
)
pure virtual

insert_latent Function insert record in memory database that is used in indentification

Parameters
id( input) - unique record ID. NOTE: id - should be numerical only!
latent( input) - lattent template record.
Returns
Function returns SUCCESS if success and error code otherwise

◆ insert_record() [1/4]

virtual uint32_t Tech5Finger::Matcher::insert_record ( const std::string &  id,
TpTemplate tpTemplate,
PersonalData personalData 
)
pure virtual

insert_record Function insert record in memory database that is used in indentification

Parameters
id( input) - unique record ID. NOTE: id - should be numerical only!
tpTemplate( input) - 10-finger template record. It can have from 1 till 10 fingerprint templates.
personalData( input) - some personal data. If it's NULL, then no binning will be used for this record while matching
Returns
Function returns SUCCESS if success and error code otherwise

◆ insert_record() [2/4]

virtual uint32_t Tech5Finger::Palm_Matcher::insert_record ( std::string &  id,
TpTemplate palmTemplate 
)
pure virtual

insert_record Function insert record in memory database that is used in indentification

Parameters
id( input) - unique record ID. NOTE: id - should be numerical only!
palmTemplate( input) - palm template record.
Returns
Function returns SUCCESS if success and error code otherwise

◆ insert_record() [3/4]

virtual uint32_t Tech5Finger::LT_Matcher::insert_record ( std::string &  id,
TpTemplate tpTemplate 
)
pure virtual

insert_record Function insert record in memory database that is used in indentification

Parameters
id( input) - unique record ID. NOTE: id - should be numerical only!
tpTemplate( input) - 20-finger (10 roll + 10 flat) fingerprint template record.
Returns
Function returns SUCCESS if success and error code otherwise

◆ insert_record() [4/4]

virtual uint32_t Tech5Finger::Latent_Palm_Matcher::insert_record ( std::string &  id,
uint8_t *  palmTemplate 
)
pure virtual

insert_record Function insert record in memory database that is used in indentification

Parameters
id( input) - unique record ID. NOTE: id - should be numerical only!
palmTemplate( input) - palm template
Returns
Function returns SUCCESS if success and error code otherwise

◆ insert_record_2nd()

virtual uint32_t Tech5Finger::Matcher::insert_record_2nd ( const std::string &  id,
TpTemplate tpTemplate 
)
pure virtual

insert_record_2nd Function insert record in memory database that is used by 'identify_record_2nd' function for 2nd stage of indentification

Parameters
id( input) - unique record ID. NOTE: id - should be numerical only!
tpTemplate( input) - 10-finger template record. It can have from 1 till 10 fingerprint templates.
Returns
Function returns SUCCESS if success and error code otherwise

◆ isRecordExist() [1/5]

virtual bool Tech5Finger::Matcher::isRecordExist ( const std::string &  id)
pure virtual

isRecordExist

Returns
Function returns true if record with such id already exist in gallery and false otherwise

◆ isRecordExist() [2/5]

virtual bool Tech5Finger::LT_Matcher::isRecordExist ( std::string &  id)
pure virtual

isRecordExist

Returns
Function returns true if record with such id already exist in gallery and false otherwise

◆ isRecordExist() [3/5]

virtual bool Tech5Finger::Latent_Matcher::isRecordExist ( std::string &  id)
pure virtual

isRecordExist

Returns
Function returns true if record with such id already exist in gallery and false otherwise

◆ isRecordExist() [4/5]

virtual bool Tech5Finger::Palm_Matcher::isRecordExist ( std::string &  id)
pure virtual

isRecordExist

Returns
Function returns true if record with such id already exist in gallery and false otherwise

◆ isRecordExist() [5/5]

virtual bool Tech5Finger::Latent_Palm_Matcher::isRecordExist ( std::string &  id)
pure virtual

isRecordExist

Returns
Function returns true if record with such id already exist in gallery and false otherwise

◆ verify_latent() [1/2]

virtual uint32_t Tech5Finger::LT_Matcher::verify_latent ( MatchingParameters matchingParameters,
uint8_t *  latent_template,
uint8_t *  finger_template,
double &  score,
double &  logFAR 
)
pure virtual

verify_latent Function verify latent template with fingerprint template

Parameters
matchingParameters( input) - matching parameters
latent_template( input) - latent template
finger_template( input) - fingerprint template
score(output) - similarity of two records in a range 0...1
logFAR(output) - -log10(FAR) corresponded to getting score
Returns
Function returns SUCCESS if success and error code otherwise

◆ verify_latent() [2/2]

virtual uint32_t Tech5Finger::Latent_Matcher::verify_latent ( MatchingParameters matchingParameters,
uint8_t *  latent_template,
uint8_t *  finger_template,
double &  score,
double &  logFAR 
)
pure virtual

verify_latent Function verify latent template with latent or fingerprint template

Parameters
matchingParameters( input) - matching parameters
latent_template( input) - latent template
finger_template( input) - fingerprint template
score(output) - similarity of two records in a range 0...1
logFAR(output) - -log10(FAR) corresponded to getting score
Returns
Function returns SUCCESS if success and error code otherwise

◆ verify_palm() [1/2]

virtual uint32_t Tech5Finger::Palm_Matcher::verify_palm ( MatchingParameters matchingParameters,
uint8_t *  probe_palm_template,
uint8_t *  gallery_palm_template,
double &  score,
double &  logFAR 
)
pure virtual

verify_palm 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
Function returns SUCCESS if success and error code otherwise

◆ verify_palm() [2/2]

virtual uint32_t Tech5Finger::Latent_Palm_Matcher::verify_palm ( MatchingParameters matchingParameters,
uint8_t *  probe_palm_template,
uint8_t *  gallery_palm_template,
double &  score,
double &  logFAR 
)
pure virtual

verify_palm 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
Function returns SUCCESS if success and error code otherwise

◆ verify_record()

virtual uint32_t Tech5Finger::Matcher::verify_record ( MatchingParameters matchingParameters,
TpTemplate tpTemplate1,
TpTemplate tpTemplate2,
double &  score,
double &  logFAR 
)
pure virtual

verify_record Function verify two records, each of them can have from 1 till 10 fingerprints

Parameters
matchingParameters( input) - matching parameters
tpTemplate1( input) - first 10-finger template record. It can have from 1 till 10 fingerprint templates.
tpTemplate2( input) - second 10-finger template record. It can have from 1 till 10 fingerprint templates.
score(output) - similarity of two records in a range 0...1
logFAR(output) - -log10(FAR) corresponded to getting score
Returns
Function returns SUCCESS if success and error code otherwise

Variable Documentation

◆ matchingMode

MATCHING_MODE Tech5Finger::MatchingParameters::matchingMode

Matching mode.

See also
MATCHING_MODE