ExtractedPrintEmbedding Class Reference

Print template in proprietary embedding format used for biometric operations with Print that was extracted. More...

#include <ExtractedPrintEmbedding.h>

Collaboration diagram for ExtractedPrintEmbedding:

Public Member Functions
	ExtractedPrintEmbedding (const std::vector< uint8_t > &serializedTmpl, std::shared_ptr< Print > fp)
	Create ExtractedPrintEmbedding object .
	ExtractedPrintEmbedding (const std::vector< uint8_t > &tmpl, std::shared_ptr< Print > fp, std::shared_ptr< PrintExecutor > executor)
	Create ExtractedPrintEmbedding object .
	ExtractedPrintEmbedding (std::vector< uint8_t > &&tmpl, std::shared_ptr< Print > fp)
	Create ExtractedPrintEmbedding object .
	ExtractedPrintEmbedding (std::vector< uint8_t > &&tmpl, std::shared_ptr< Print > fp, std::shared_ptr< PrintExecutor > executor)
	Create ExtractedPrintEmbedding object .
void	WriteTo (Writer &w) const final
	Write itself into writer.
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.

Public Attributes
const std::shared_ptr< Print >	print
	Print that was extracted.

Detailed Description

Print template in proprietary embedding format used for biometric operations with Print that was extracted.

Note

Not supported in this variant of Enrollment SDK.

Constructor & Destructor Documentation

ExtractedPrintEmbedding() [1/4]

ExtractedPrintEmbedding ( const std::vector< uint8_t > & serializedTmpl, std::shared_ptr< Print > fp )

inline

Create ExtractedPrintEmbedding object .

Note

Not supported in this variant of Enrollment SDK.

GlobalPrintExecutor is used to execute template functionality.

Parameters

serializedTmpl	serialized template data
fp	fingerprint that belongs to template

Exceptions

EnrollmentRuntimeException

when Print is null

References EmbeddingTemplate::EmbeddingTemplate(), and print.

Here is the call graph for this function:

ExtractedPrintEmbedding() [2/4]

ExtractedPrintEmbedding ( const std::vector< uint8_t > & tmpl, std::shared_ptr< Print > fp, std::shared_ptr< PrintExecutor > executor )

inline

Create ExtractedPrintEmbedding object .

Note

Not supported in this variant of Enrollment SDK.

Parameters

tmpl	pointer to template
fp	fingerprint that belongs to template
executor	PrintExecutor used to execute template functionality.

Exceptions

NullArgumentException	when executor is null
EnrollmentRuntimeException	when Print is null

References EmbeddingTemplate::EmbeddingTemplate(), and print.

Here is the call graph for this function:

ExtractedPrintEmbedding() [3/4]

ExtractedPrintEmbedding ( std::vector< uint8_t > && tmpl, std::shared_ptr< Print > fp )

inline

Create ExtractedPrintEmbedding object .

Note

Not supported in this variant of Enrollment SDK.

GlobalPrintExecutor is used to execute template functionality.

Parameters

tmpl	pointer to template
fp	fingerprint that belongs to template

Exceptions

EnrollmentRuntimeException

when Print is null

References EmbeddingTemplate::EmbeddingTemplate(), and print.

Here is the call graph for this function:

ExtractedPrintEmbedding() [4/4]

ExtractedPrintEmbedding ( std::vector< uint8_t > && tmpl, std::shared_ptr< Print > fp, std::shared_ptr< PrintExecutor > executor )

inline

Create ExtractedPrintEmbedding object .

Note

Not supported in this variant of Enrollment SDK.

Parameters

tmpl	pointer to template
fp	fingerprint that belongs to template
executor	PrintExecutor used to execute template functionality.

Exceptions

NullArgumentException	when executor is null
EnrollmentRuntimeException	when Print is null

References EmbeddingTemplate::EmbeddingTemplate(), and print.

Here is the call graph for this function:

Member Function Documentation

GetEmbeddingTemplateBiometricPosition()

PrintPosition GetEmbeddingTemplateBiometricPosition ( ) const

inlinenodiscardinherited

It returns biometric position to which template belongs.

Returns

biometric position

Exceptions

EnrollmentRuntimeException

when biometric position is unknown

GetVersion()

std::string GetVersion ( ) const

inlinenodiscardinherited

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

inlinenodiscardinherited

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

inlinenodiscardinherited

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

inlinefinalvirtual

Write itself into writer.

Parameters

writer

Writer to use to serialize this Serializable

Reimplemented from EmbeddingTemplate.

References print, and EmbeddingTemplate::WriteTo().

Here is the call graph for this function:

---

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

• Print/ExtractedPrintEmbedding.h