Iris SDK  1.0
Iris Recognition Software Development Kit
Public Member Functions | List of all members
iris_sdk::matcher Class Referenceabstract

The iris matcher. iris matcher compares Irises to each other. More...

#include <matcher.h>

Public Member Functions

virtual uint32_t InsertRecord (const std::string &id, std::vector< uint8_t > leftiristemp, std::vector< uint8_t > rightiristemp)=0
 Insert iris to gallery. More...
 
virtual uint32_t DeleteRecord (const std::string &id)=0
 Delete iris from gallery. More...
 
virtual uint32_t CheckEncounter (const std::string &id)=0
 Check iris in gallery. More...
 
virtual uint32_t Initialize (bool psingleIrisGallery, int pgalleryCount)=0
 Insert iris to gallery. More...
 
virtual void clear ()=0
 Clear iris gallery. More...
 
virtual uint32_t Verify (const std::vector< uint8_t > &pleftiristemp, const std::vector< uint8_t > &prightiristemp, const std::vector< uint8_t > &gleftiristemp, const std::vector< uint8_t > &grightiristemp, float &finalscore)=0
 Performs 1:1 matching operations for specified iris. More...
 
virtual uint32_t identify_record (const std::vector< uint8_t > &leftiristemp, const std::vector< uint8_t > &rightiristemp, const uint32_t numberOfThreads, const bool fastmatchmode, const uint32_t mode, const uint32_t candidate_list_length, std::vector< candidates_string > &candidate_list)=0
 Performs 1:N matching operations for specified iris. More...
 
virtual std::string GetVersion ()=0
 

Detailed Description

The iris matcher. iris matcher compares Irises to each other.

It allows to perform 1:1 and 1:N matching. Use iris_sdk::make_matcher functions for instantiating of iris_sdk::matcher object.

Member Function Documentation

◆ CheckEncounter()

virtual uint32_t iris_sdk::matcher::CheckEncounter ( const std::string &  id)
pure virtual

Check iris in gallery.

Parameters
[in]idgallery entry id
Returns
operation return code See codes.h
Exceptions
iris_sdk::exceptionSee Exceptions handling.

◆ clear()

virtual void iris_sdk::matcher::clear ( )
pure virtual

Clear iris gallery.

Exceptions
iris_sdk::exceptionSee Exceptions handling.

◆ DeleteRecord()

virtual uint32_t iris_sdk::matcher::DeleteRecord ( const std::string &  id)
pure virtual

Delete iris from gallery.

Parameters
[in]idgallery entry id
Returns
operation return code See codes.h
Exceptions
iris_sdk::exceptionSee Exceptions handling.

◆ identify_record()

virtual uint32_t iris_sdk::matcher::identify_record ( const std::vector< uint8_t > &  leftiristemp,
const std::vector< uint8_t > &  rightiristemp,
const uint32_t  numberOfThreads,
const bool  fastmatchmode,
const uint32_t  mode,
const uint32_t  candidate_list_length,
std::vector< candidates_string > &  candidate_list 
)
pure virtual

Performs 1:N matching operations for specified iris.

Parameters
[in]leftiristemplhs left iris eye
[in]rightiristemplhs right iris eye
[in]numberOfThreads
[in]fastmatchmode
[in]modeoperation mode
[in]candidate_list_lengthnumber of best matches
[out]candidate_listlist of best matches
Returns
operation return code See codes.h
Exceptions
iris_sdk::exceptionSee Exceptions handling.

◆ Initialize()

virtual uint32_t iris_sdk::matcher::Initialize ( bool  psingleIrisGallery,
int  pgalleryCount 
)
pure virtual

Insert iris to gallery.

Parameters
[in]psingleIrisGallery
[in]pgalleryCountgallery size
Returns
operation return code See codes.h
Exceptions
iris_sdk::exceptionSee Exceptions handling.

◆ InsertRecord()

virtual uint32_t iris_sdk::matcher::InsertRecord ( const std::string &  id,
std::vector< uint8_t >  leftiristemp,
std::vector< uint8_t >  rightiristemp 
)
pure virtual

Insert iris to gallery.

Parameters
[in]idgallery entry id
[in]leftiristempleft iris eye
[in]rightiristempright iris eye
Returns
operation return code See codes.h
Exceptions
iris_sdk::exceptionSee Exceptions handling.

◆ Verify()

virtual uint32_t iris_sdk::matcher::Verify ( const std::vector< uint8_t > &  pleftiristemp,
const std::vector< uint8_t > &  prightiristemp,
const std::vector< uint8_t > &  gleftiristemp,
const std::vector< uint8_t > &  grightiristemp,
float &  finalscore 
)
pure virtual

Performs 1:1 matching operations for specified iris.

Parameters
[in]pleftiristemplhs left iris eye
[in]prightiristemplhs right iris eye
[in]gleftiristemprhs left iris eye
[in]grightiristemprhs right iris eye
[out]finalscore-log(FAR). See How to interpet matching results
Returns
operation return code See codes.h
Exceptions
iris_sdk::exceptionSee Exceptions handling.

The documentation for this class was generated from the following file: