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

Applicant template in serialized form used for biometric operations. More...

#include <ModalitiesTemplate.h>

Collaboration diagram for ModalitiesTemplate:

Public Member Functions

std::vector< std::shared_ptr< FaceTemplate > > GetFaceTemplates () const
 Provides FaceTemplate objects.
std::vector< std::shared_ptr< IrisTemplate > > GetIrisTemplates () const
 Provides IrisTemplate objects.
std::vector< std::shared_ptr< PrintTemplate > > GetPrintTemplates () const
 Provides PrintTemplate objects.
std::vector< uint8_t > GetModalitiesTemplateData () const
 It provides Applicant template data.
std::shared_ptr< ModalitiesICSTemplate > ToModalitiesICSTemplate () const
 Converts template to Innovatrics template format useful for verification.
std::shared_ptr< ModalitiesICSTemplate > ToModalitiesICSTemplate (const ModalitiesICSTemplateFactory &factory) const
 Converts template to Innovatrics template format useful for verification.
ModalityScore SimilarWith (const ModalitiesTemplate &gallery, const ModalitiesMatcher &matcher) const
 It calculates similarity score between this and other applicant template.
void WriteTo (Writer &w) const override
 Write itself into writer.

Static Public Member Functions

static std::shared_ptr< ModalitiesTemplate > Create (const std::vector< uint8_t > &data)
 Create ModalitiesTemplate object from serialized data.
static std::shared_ptr< ModalitiesTemplate > Create (std::vector< std::shared_ptr< PrintTemplate > > prints, std::vector< std::shared_ptr< FaceTemplate > > faces, std::vector< std::shared_ptr< IrisTemplate > > irises)
 Create ModalitiesTemplate object from templates.

Detailed Description

Applicant template in serialized form used for biometric operations.

The serialized data contains templates for print, embedding print, face and iris modalities.

Member Function Documentation

◆ Create() [1/2]

std::shared_ptr< ModalitiesTemplate > Create ( const std::vector< uint8_t > & data)
inlinestatic

Create ModalitiesTemplate object from serialized data.

Parameters
datatemplate data
Returns
created modality template

Referenced by Applicant::ToTemplate().

Here is the caller graph for this function:

◆ Create() [2/2]

std::shared_ptr< ModalitiesTemplate > Create ( std::vector< std::shared_ptr< PrintTemplate > > prints,
std::vector< std::shared_ptr< FaceTemplate > > faces,
std::vector< std::shared_ptr< IrisTemplate > > irises )
inlinestatic

Create ModalitiesTemplate object from templates.

Parameters
printsprint templates
facesface templates
irisesiris templates
Returns
created modality template

◆ GetFaceTemplates()

std::vector< std::shared_ptr< FaceTemplate > > GetFaceTemplates ( ) const
inlinenodiscard

Provides FaceTemplate objects.

Returns
face templates

◆ GetIrisTemplates()

std::vector< std::shared_ptr< IrisTemplate > > GetIrisTemplates ( ) const
inlinenodiscard

Provides IrisTemplate objects.

Returns
iris templates

◆ GetModalitiesTemplateData()

std::vector< uint8_t > GetModalitiesTemplateData ( ) const
inlinenodiscard

It provides Applicant template data.

Returns
Applicant template data
Exceptions
EnrollmentExceptionwhen it is not possible to serialize template

◆ GetPrintTemplates()

std::vector< std::shared_ptr< PrintTemplate > > GetPrintTemplates ( ) const
inlinenodiscard

Provides PrintTemplate objects.

Returns
print templates

◆ SimilarWith()

ModalityScore SimilarWith ( const ModalitiesTemplate & gallery,
const ModalitiesMatcher & matcher ) const
inlinenodiscard

It calculates similarity score between this and other applicant template.

It uses given ModalitiesTemplateMatcher to calculate the score.

Parameters
galleryModalitiesTemplate.
matcheris ModalitiesTemplateMatcher used to calculate modality score between probe (this template) and given template gallery
Returns
modality score

References ModalitiesMatcher::Match().

Here is the call graph for this function:

◆ ToModalitiesICSTemplate() [1/2]

std::shared_ptr< ModalitiesICSTemplate > ToModalitiesICSTemplate ( ) const
inlinenodiscard

Converts template to Innovatrics template format useful for verification.

It uses ModalitiesICSTemplateDefaultFactory for conversion to ModalitiesICSTemplate.

Returns
converted template

References ToModalitiesICSTemplate().

Referenced by ToModalitiesICSTemplate().

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

◆ ToModalitiesICSTemplate() [2/2]

std::shared_ptr< ModalitiesICSTemplate > ToModalitiesICSTemplate ( const ModalitiesICSTemplateFactory & factory) const
inlinenodiscard

Converts template to Innovatrics template format useful for verification.

It uses given factory for conversion to ModalitiesICSTemplate.

Parameters
factoryModalitiesICSTemplateFactory for conversion
Returns
converted template

References ModalitiesICSTemplateFactory::CreateModalitiesICSTemplate(), and PrintTemplate::ToICSTemplates().

Here is the call graph for this function:

◆ WriteTo()

void WriteTo ( Writer & writer) const
inlineoverridevirtual

Write itself into writer.

Parameters
writerWriter to use to serialize this Serializable

Implements Serializable.

References Writer::WriteArray().

Here is the call graph for this function:

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