EmbeddingTemplate Class Reference

Print template in proprietary embedding format used for biometric operations. More...

#include <EmbeddingTemplate.h>

Collaboration diagram for EmbeddingTemplate:

Public Member Functions
PrintSimilarityScore	SimilarWith (const EmbeddingTemplate &tmpl, const EmbeddingMatcher &matcher) const
	It calculates similarity score between this and given EmbeddingTemplate.
bool	IsEmbeddingTemplateBiometricPositionKnown () const
	It checks if template contains known biometric position.
PrintPosition	GetEmbeddingTemplateBiometricPosition () const
	It returns biometric position to which template belongs.
std::string	GetVersion () const
	Provides version information of Innovatrics proprietary algorithm used to create the embedding template.
	EmbeddingTemplate (std::vector< uint8_t > &&d)
	Create EmbeddingTemplate object.
	EmbeddingTemplate (const std::vector< uint8_t > &d)
	Create EmbeddingTemplate object that copies the data.
	EmbeddingTemplate (std::vector< uint8_t > &&d, std::shared_ptr< PrintExecutor > executor)
	Create EmbeddingTemplate object.
	EmbeddingTemplate (const std::vector< uint8_t > &d, std::shared_ptr< PrintExecutor > executor)
	Create EmbeddingTemplate object that copies data.
	EmbeddingTemplate (std::vector< uint8_t > &&d, PrintPosition position)
	Create EmbeddingTemplate object.
	EmbeddingTemplate (const std::vector< uint8_t > &d, PrintPosition position)
	Create EmbeddingTemplate object that copies the data.
	EmbeddingTemplate (std::vector< uint8_t > &&d, PrintPosition position, std::shared_ptr< PrintExecutor > executor)
	Create EmbeddingTemplate object.
	EmbeddingTemplate (const std::vector< uint8_t > &d, PrintPosition position, std::shared_ptr< PrintExecutor > executor)
	Create EmbeddingTemplate object copy data.
void	WriteTo (Writer &w) const override
	Write itself into writer.

Detailed Description

Print template in proprietary embedding format used for biometric operations.

Constructor & Destructor Documentation

EmbeddingTemplate() [1/8]

EmbeddingTemplate ( std::vector< uint8_t > && d )

inlineexplicit

Create EmbeddingTemplate object.

GlobalPrintExecutor is used to execute template functionality. Biometric position is unknown.

Parameters

d	template data

Exceptions

InvalidTemplateException

when Embedding template has no data

Referenced by ExtractedPrintEmbedding::ExtractedPrintEmbedding(), ExtractedPrintEmbedding::ExtractedPrintEmbedding(), ExtractedPrintEmbedding::ExtractedPrintEmbedding(), ExtractedPrintEmbedding::ExtractedPrintEmbedding(), and SimilarWith().

Here is the caller graph for this function:

EmbeddingTemplate() [2/8]

EmbeddingTemplate ( const std::vector< uint8_t > & d )

inlineexplicit

Create EmbeddingTemplate object that copies the data.

GlobalPrintExecutor is used to execute template functionality. Biometric position is unknown.

Parameters

d	template data

Exceptions

InvalidTemplateException

when Embedding template has no data

EmbeddingTemplate() [3/8]

EmbeddingTemplate ( std::vector< uint8_t > && d, std::shared_ptr< PrintExecutor > executor )

inline

Create EmbeddingTemplate object.

Biometric position is unknown.

Parameters

d	template data
executor	PrintExecutor used to execute template functionality.

Exceptions

NullArgumentException	when executor is null
InvalidTemplateException	when Embedding template has no data

EmbeddingTemplate() [4/8]

EmbeddingTemplate ( const std::vector< uint8_t > & d, std::shared_ptr< PrintExecutor > executor )

inline

Create EmbeddingTemplate object that copies data.

Biometric position is unknown.

Parameters

d	template data
executor	PrintExecutor used to execute template functionality.

Exceptions

NullArgumentException	when executor is null
InvalidTemplateException	when Embedding template has no data

EmbeddingTemplate() [5/8]

EmbeddingTemplate ( std::vector< uint8_t > && d, PrintPosition position )

inlineexplicit

Create EmbeddingTemplate object.

GlobalPrintExecutor is used to execute template functionality.

Parameters

d	template data
position	biometric position to which template belongs

Exceptions

InvalidTemplateException

when Embedding template has no data

EmbeddingTemplate() [6/8]

EmbeddingTemplate ( const std::vector< uint8_t > & d, PrintPosition position )

inlineexplicit

Create EmbeddingTemplate object that copies the data.

GlobalPrintExecutor is used to execute template functionality.

Parameters

d	template data
position	biometric position to which template belongs

Exceptions

InvalidTemplateException

when Embedding template has no data

EmbeddingTemplate() [7/8]

EmbeddingTemplate ( std::vector< uint8_t > && d, PrintPosition position, std::shared_ptr< PrintExecutor > executor )

inline

Create EmbeddingTemplate object.

Parameters

d	template data
position	biometric position to which template belongs
executor	PrintExecutor used to execute template functionality.

Exceptions

NullArgumentException	when executor is null
InvalidTemplateException	when Embedding template has no data

EmbeddingTemplate() [8/8]

EmbeddingTemplate ( const std::vector< uint8_t > & d, PrintPosition position, std::shared_ptr< PrintExecutor > executor )

inline

Create EmbeddingTemplate object copy data.

Parameters

d	template data
position	biometric position to which template belongs
executor	PrintExecutor used to execute template functionality.

Exceptions

NullArgumentException	when executor is null
InvalidTemplateException	when Embedding template has no data

Member Function Documentation

GetEmbeddingTemplateBiometricPosition()

PrintPosition GetEmbeddingTemplateBiometricPosition ( ) const

inlinenodiscard

It returns biometric position to which template belongs.

Returns

biometric position

Exceptions

EnrollmentRuntimeException

when biometric position is unknown

GetVersion()

std::string GetVersion ( ) const

inlinenodiscard

Provides version information of Innovatrics proprietary algorithm used to create the embedding template.

Returns

version string

Exceptions

InvalidTemplateException

when it is not possible to extract version from Embedding template data

IsEmbeddingTemplateBiometricPositionKnown()

bool IsEmbeddingTemplateBiometricPositionKnown ( ) const

inlinenodiscard

It checks if template contains known biometric position.

Returns

true when biometric position is known and valid

false when biometric position is unknown

SimilarWith()

PrintSimilarityScore SimilarWith ( const EmbeddingTemplate & tmpl, const EmbeddingMatcher & matcher ) const

inlinenodiscard

It calculates similarity score between this and given EmbeddingTemplate.

It uses given EmbeddingMatcher to calculate score.

Parameters

tmpl	gallery EmbeddingTemplate.
matcher	is EmbeddingMatcher used to calculate similarity score between probe (this template) and given template tmpl

Returns

similarity score

References EmbeddingTemplate(), and EmbeddingMatcher::Match().

Here is the call graph for this function:

WriteTo()

void WriteTo ( Writer & writer ) const

inlineoverridevirtual

Write itself into writer.

Parameters

writer

Writer to use to serialize this Serializable

Implements Serializable.

Reimplemented in ExtractedPrintEmbedding.

References Writer::WriteArray().

Referenced by ExtractedPrintEmbedding::WriteTo().

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:

• Print/EmbeddingTemplate.h