Enrollment 28.2.0
Loading...
Searching...
No Matches
ModalitiesEmbeddingVerifyMatcher Class Reference

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

#include <ModalitiesEmbeddingVerifyMatcher.h>

Collaboration diagram for ModalitiesEmbeddingVerifyMatcher:

Public Member Functions

PrintSimilarityScore MatchPrints (const std::vector< std::shared_ptr< PrintTemplate > > &probe, const std::vector< std::shared_ptr< PrintTemplate > > &gallery) const final
 Calculates prints similarity score of probe and gallery that contains only embedding prints.
 ModalitiesEmbeddingVerifyMatcher ()
 Constructor with default logger and executor GlobalMultiModalityExecutor is used to execute matching.
 ModalitiesEmbeddingVerifyMatcher (std::shared_ptr< MultiModalityExecutor > executor)
 Constructor with custom executor.
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.

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

ModalitiesEmbeddingVerifyMatcher is template matcher that uses Innovatrics proprietary verification algorithm.

Note
Not supported in this variant of Enrollment SDK.

Constructor & Destructor Documentation

◆ ModalitiesEmbeddingVerifyMatcher() [1/2]

Constructor with default logger and executor GlobalMultiModalityExecutor is used to execute matching.

Note
Not supported in this variant of Enrollment SDK.

◆ ModalitiesEmbeddingVerifyMatcher() [2/2]

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

Constructor with custom executor.

Note
Not supported in this variant of Enrollment SDK.
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
inlinenodiscardfinalvirtualinherited

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
inlinenodiscardfinalvirtualinherited

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 )
inlinestaticnodiscardinherited

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 )
inlinestaticnodiscardinherited

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()

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

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

Note
Not supported in this variant of Enrollment SDK.
The embedding extraction feature MUST be allowed in license to match print embeddings.
Parameters
probeprobe prints
gallerygallery prints
Returns
similarity PrintSimilarityScore
Exceptions
EnrollmentExceptionwhen it is not possible to match templates

Reimplemented from ModalitiesVerifyMatcher.

References PrintTemplate::ToEmbeddingTemplates().

Here is the call graph for this function:

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