Enrollment 28.2.0
Loading...
Searching...
No Matches

ModalitiesVerifyMatcher is template matcher that uses Innovatrics proprietary verification algorithm. More...

#include <ModalitiesVerifyMatcher.h>

Collaboration diagram for ModalitiesVerifyMatcher:

Classes

class  Config
 ModalitiesVerifyMatcher configuration. More...

Public Member Functions

ModalityScore Match (const Applicant &probe, const Applicant &gallery) const final
 Calculates similarity score of probe and gallery applicant template for each modality.
ModalityScore Match (const ModalitiesTemplate &probe, const ModalitiesTemplate &gallery) const final
 Calculates similarity score of probe and gallery applicant for each applicant modality.
virtual PrintSimilarityScore MatchPrints (const std::vector< std::shared_ptr< PrintTemplate > > &probe, const std::vector< std::shared_ptr< PrintTemplate > > &gallery) const
 Calculates prints similarity score of probe and gallery that contains only prints.
 ModalitiesVerifyMatcher ()
 Constructor with default Config GlobalMultiModalityExecutor is used to execute matching.
 ModalitiesVerifyMatcher (Config config)
 Constructor uses Config to setup matching algorithm.
 ModalitiesVerifyMatcher (Config config, std::shared_ptr< MultiModalityExecutor > executor)
 Constructor uses Config to setup matching algorithm.
 ModalitiesVerifyMatcher (Config config, std::shared_ptr< MultiModalityExecutor > executor, std::shared_ptr< Logger > logger)
 Constructor uses Config to setup matching algorithm.
 ModalitiesVerifyMatcher (std::shared_ptr< MultiModalityExecutor > executor)
 Constructor with default Config.

Static Public Member Functions

static FaceSimilarityScore MatchFaces (const std::vector< std::shared_ptr< FaceTemplate > > &probe, const std::vector< std::shared_ptr< FaceTemplate > > &gallery)
 Calculates face similarity score of probe and gallery that contains only faces.
static IrisSimilarityScore MatchIrises (const std::vector< std::shared_ptr< IrisTemplate > > &probe, const std::vector< std::shared_ptr< IrisTemplate > > &gallery)
 Calculates face similarity score of probe and gallery that contains only irises.

Detailed Description

ModalitiesVerifyMatcher is template matcher that uses Innovatrics proprietary verification algorithm.

It is configurable via ModalitiesVerifyMatcher::Config verifies probe against gallery template.

Constructor & Destructor Documentation

◆ ModalitiesVerifyMatcher() [1/4]

ModalitiesVerifyMatcher ( Config config)
inlineexplicit

Constructor uses Config to setup matching algorithm.

GlobalMultiModalityExecutor is used to execute matching.

Parameters
configis matching algorithm configuration.

◆ ModalitiesVerifyMatcher() [2/4]

ModalitiesVerifyMatcher ( Config config,
std::shared_ptr< MultiModalityExecutor > executor )
inline

Constructor uses Config to setup matching algorithm.

Parameters
configis matching algorithm configuration.
executorMultiModalityExecutor used for matching
Exceptions
NullArgumentExceptionwhen executor is null

◆ ModalitiesVerifyMatcher() [3/4]

ModalitiesVerifyMatcher ( Config config,
std::shared_ptr< MultiModalityExecutor > executor,
std::shared_ptr< Logger > logger )
inline

Constructor uses Config to setup matching algorithm.

Parameters
configis matching algorithm configuration.
executorMultiModalityExecutor used for matching
loggerlogger used for logging
Exceptions
NullArgumentExceptionwhen executor is null

◆ ModalitiesVerifyMatcher() [4/4]

ModalitiesVerifyMatcher ( std::shared_ptr< MultiModalityExecutor > executor)
inlineexplicit

Constructor with default Config.

Parameters
executorMultiModalityExecutor used for matching
Exceptions
NullArgumentExceptionwhen executor is null

Member Function Documentation

◆ Match() [1/2]

ModalityScore Match ( const Applicant & probe,
const Applicant & gallery ) const
inlinenodiscardfinalvirtual

Calculates similarity score of probe and gallery applicant template for each modality.

This is convenient function to check similarity of applicants. It is not efficient because it always creates probe and gallery ModalitiesTemplate.

Parameters
probeprobe Applicant
gallerygallery Applicant
Returns
similarity ModalityScore
Exceptions
EnrollmentExceptionwhen it is not possible to create template or match created templates

Reimplemented from ModalitiesMatcher.

References Match().

Referenced by Match().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Match() [2/2]

ModalityScore Match ( const ModalitiesTemplate & probe,
const ModalitiesTemplate & gallery ) const
inlinenodiscardfinalvirtual

Calculates similarity score of probe and gallery applicant for each applicant modality.

Parameters
probeprobe ModalitiesTemplate
gallerygallery ModalitiesTemplate
Returns
similarity ModalityScore
Exceptions
EnrollmentExceptionwhen it is not possible to match templates

Implements ModalitiesMatcher.

References MatchFaces(), MatchIrises(), and MatchPrints().

Here is the call graph for this function:

◆ MatchFaces()

FaceSimilarityScore MatchFaces ( const std::vector< std::shared_ptr< FaceTemplate > > & probe,
const std::vector< std::shared_ptr< FaceTemplate > > & gallery )
inlinestaticnodiscard

Calculates face similarity score of probe and gallery that contains only faces.

It compares each probe face against each gallery face and return max score from all comparisons.

Parameters
probeprobe faces
gallerygallery faces
Returns
similarity FaceSimilarityScore
Exceptions
EnrollmentExceptionwhen it is not possible to match templates

Referenced by Match().

Here is the caller graph for this function:

◆ MatchIrises()

IrisSimilarityScore MatchIrises ( const std::vector< std::shared_ptr< IrisTemplate > > & probe,
const std::vector< std::shared_ptr< IrisTemplate > > & gallery )
inlinestaticnodiscard

Calculates face similarity score of probe and gallery that contains only irises.

Parameters
probeprobe irises
gallerygallery irises
Returns
similarity IrisSimilarityScore
Exceptions
EnrollmentExceptionwhen it is not possible to match templates

References LEFT_EYE, and RIGHT_EYE.

Referenced by Match().

Here is the caller graph for this function:

◆ MatchPrints()

virtual PrintSimilarityScore MatchPrints ( const std::vector< std::shared_ptr< PrintTemplate > > & probe,
const std::vector< std::shared_ptr< PrintTemplate > > & gallery ) const
inlinenodiscardvirtual

Calculates prints similarity score of probe and gallery that contains only prints.

Parameters
probeprobe prints
gallerygallery prints
Returns
similarity PrintSimilarityScore
Exceptions
EnrollmentExceptionwhen it is not possible to match templates

Reimplemented in ModalitiesEmbeddingVerifyMatcher.

References PrintTemplate::ToICSTemplates().

Referenced by Match().

Here is the call graph for this function:
Here is the caller graph for this function:

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