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

#include <ExtractedPrint.h>

Collaboration diagram for ExtractedPrint:

Public Member Functions
void	EnhanceWithEmbedding (std::shared_ptr< ExtractedPrintEmbedding > embedding)
	Enhances the object with an embedding representation.
void	EnhanceWithEmbedding (const EmbeddingExtractor &extractor)
	Enhances the object with an embedding representation using an embedding extractor.
std::shared_ptr< ExtractedPrintEmbedding >	GetEmbeddingRepresentation () const
	Retrieves the embedding representation associated with the object.
bool	HasEmbeddingRepresentation () const
	Checks if the object has an embedding representation.
	ExtractedPrint (std::vector< uint8_t > &&d, std::shared_ptr< Print > fp)
	Create ExtractedPrint object.
	ExtractedPrint (std::vector< uint8_t > &&d, std::shared_ptr< Print > fp, std::shared_ptr< PrintExecutor > executor)
	Create ExtractedPrint object.
std::shared_ptr< ISOTemplate >	ToISO () const
	Convert this ExtractedPrint to into ISO/IEC 19794-2 compliant template.
std::shared_ptr< ANSITemplate >	ToANSI () const
	Convert this ExtractedPrint to into ANSI/INCITS 378 compliant template.
void	WriteTo (Writer &w) const final
	Write itself into writer.
bool	IsICSTemplateBiometricPositionKnown () const
	It checks if template contains known biometric position.
PrintPosition	GetICSTemplateBiometricPosition () const
	It returns biometric position to which template belongs.
std::string	GetVersion () const
	Provides version information of Innovatrics proprietary algorithm used to create the ICS template.
std::shared_ptr< ICSTemplate >	Anonymize () const
	Creates ICSTemplate without position.
PrintSimilarityScore	SimilarWith (const ICSTemplate &tmpl, const ICSMatcher &matcher) const
	It calculates similarity score between this and given ICSTemplate.
uint8_t	CalculateQuality ()
	Function calculates a fingerprint template quality.
std::shared_ptr< ISOTemplate >	ToISO (const std::shared_ptr< const Print > &print) const
	Convert this ICSTemplate to into ISO/IEC 19794-2 compliant template.
std::shared_ptr< ANSITemplate >	ToANSI (const std::shared_ptr< const Print > &print) const
	Convert this ICSTemplate to into ANSI/INCITS 378 compliant template.
std::vector< std::shared_ptr< Minutia > >	GetMinutiae () const
	Get minutiae from template.
std::vector< std::shared_ptr< CriticalPoint > >	GetCriticalPoints () const
	Get critical points (core/delta) from template.

Static Public Member Functions
static std::vector< std::shared_ptr< ICSTemplate > >	ToICSTemplates (const std::vector< std::shared_ptr< ExtractedPrint > > &prints)
	Converts a vector of ExtractedPrint objects into a vector of ICSTemplate objects.
static std::vector< std::shared_ptr< PrintTemplate > >	ToTemplates (const std::vector< std::shared_ptr< ExtractedPrint > > &prints)
	Converts a vector of ExtractedPrint objects into a vector of PrintTemplate objects.

Public Attributes
const std::shared_ptr< Print >	print
	Print that was extracted.
const std::vector< uint8_t >	icsTemplateData
	template data

Detailed Description

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

Constructor & Destructor Documentation

◆ ExtractedPrint() [1/2]

ExtractedPrint	(	std::vector< uint8_t > &&	d,
		std::shared_ptr< Print >	fp )

inline

Create ExtractedPrint object.

Parameters

d	template data
fp	fingerprint that belongs to template

Exceptions

NullArgumentException when Print is null

References ICSTemplate::ICSTemplate(), and print.

Here is the call graph for this function:

◆ ExtractedPrint() [2/2]

ExtractedPrint	(	std::vector< uint8_t > &&	d,
		std::shared_ptr< Print >	fp,
		std::shared_ptr< PrintExecutor >	executor )

inline

Create ExtractedPrint object.

Parameters

d	template data
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 ICSTemplate::ICSTemplate(), and print.

Here is the call graph for this function:

Member Function Documentation

◆ Anonymize()

std::shared_ptr< ICSTemplate > Anonymize ( ) const

inlinenodiscardinherited

Creates ICSTemplate without position.

Returns: ICSTemplate without position.

References icsTemplateData.

◆ CalculateQuality()

uint8_t CalculateQuality ( )

inlineinherited

Function calculates a fingerprint template quality.

This function returns quality of a fingerprint template. For enrollment, it is recommended to use only templates with quality > 30.

Returns: the output range is from 0(blank image) and 100(maximum quality)

Exceptions

EnrollmentException when fails to calculate template quality

References icsTemplateData.

◆ EnhanceWithEmbedding() [1/2]

void EnhanceWithEmbedding ( const EmbeddingExtractor & extractor )

inline

Enhances the object with an embedding representation using an embedding extractor.

Note: Not supported in this variant of Enrollment SDK.

This function enhances the object with an embedding representation obtained from the provided embedding extractor.

Parameters

extractor An instance of the EmbeddingExtractor used to extract the embedding.

Exceptions

EnrollmentException Thrown if an error occurs during the extraction process.

References EmbeddingExtractor::Extract(), and print.

Here is the call graph for this function:

◆ EnhanceWithEmbedding() [2/2]

void EnhanceWithEmbedding ( std::shared_ptr< ExtractedPrintEmbedding > embedding )

inline

Enhances the object with an embedding representation.

Note: Not supported in this variant of Enrollment SDK.

This function enhances the object with the provided embedding representation.

Parameters

embedding A ExtractedPrintEmbedding to be associated with the object.

Exceptions

NullArgumentException	thrown if the embedding is null
EnrollmentInvalidArgumentException	thrown if the print associated with the embedding does not match the print associated with the object

References print.

◆ GetCriticalPoints()

std::vector< std::shared_ptr< CriticalPoint > > GetCriticalPoints ( ) const

inlineinherited

Get critical points (core/delta) from template.

The extraction of critical points is optional. The Enrollment SDK always extracts critical points. Other Innovatrics SDKs can produce template without critical points.

Note: The adjudicator feature MUST be allowed in license to get critical points.

Returns: CriticalPoint

References GlobalLogger::Get(), and icsTemplateData.

Here is the call graph for this function:

◆ GetEmbeddingRepresentation()

std::shared_ptr< ExtractedPrintEmbedding > GetEmbeddingRepresentation ( ) const

inline

Retrieves the embedding representation associated with the object.

This function retrieves the embedding representation associated with the object.

Returns: A ExtractedPrintEmbedding associated with the object.; A nullptr if no embedding representation is associated.

◆ GetICSTemplateBiometricPosition()

PrintPosition GetICSTemplateBiometricPosition ( ) const

inlinenodiscardinherited

It returns biometric position to which template belongs.

Returns: biometric position

Exceptions

EnrollmentRuntimeException when biometric position is unknown

◆ GetMinutiae()

std::vector< std::shared_ptr< Minutia > > GetMinutiae ( ) const

inlineinherited

Get minutiae from template.

Note: The adjudicator feature MUST be allowed in license to get minutiae.

Returns: Minutiae

References GlobalLogger::Get(), and icsTemplateData.

Here is the call graph for this function:

◆ GetVersion()

std::string GetVersion ( ) const

inlinenodiscardinherited

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

Returns: version string

References icsTemplateData.

◆ HasEmbeddingRepresentation()

bool HasEmbeddingRepresentation ( ) const

inline

Checks if the object has an embedding representation.

This function checks whether the object has an embedding representation associated with it.

Returns: true if the object has an embedding representation, false otherwise.

◆ IsICSTemplateBiometricPositionKnown()

bool IsICSTemplateBiometricPositionKnown ( ) 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 ICSTemplate &	tmpl,
		const ICSMatcher &	matcher ) const

inlineinherited

It calculates similarity score between this and given ICSTemplate.

It uses given ICSMatcher to calculate score.

Parameters

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

Returns: similarity score

References ICSTemplate(), and ICSMatcher::Match().

Here is the call graph for this function:

◆ ToANSI() [1/2]

std::shared_ptr< ANSITemplate > ToANSI ( ) const

inline

Convert this ExtractedPrint to into ANSI/INCITS 378 compliant template.

Returns: ANSITemplate

Exceptions

EnrollmentException when it is not possible to convert template

References print, and ICSTemplate::ToANSI().

Here is the call graph for this function:

◆ ToANSI() [2/2]

std::shared_ptr< ANSITemplate > ToANSI ( const std::shared_ptr< const Print > & print ) const

inlineinherited

Convert this ICSTemplate to into ANSI/INCITS 378 compliant template.

Returns: ANSITemplate

Parameters

print it is Print from which ICSTemplate was extracted.

Exceptions

EnrollmentException when it is not possible to convert template

References icsTemplateData, PrintToIsoImpression(), and PrintToIsoPosition().

Referenced by ExtractedPrint::ToANSI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ToICSTemplates()

std::vector< std::shared_ptr< ICSTemplate > > ToICSTemplates ( const std::vector< std::shared_ptr< ExtractedPrint > > & prints )

inlinestatic

Converts a vector of ExtractedPrint objects into a vector of ICSTemplate objects.

This function takes a vector of ExtractedPrint objects and converts each element into an ICSTemplate object, then returns a vector of ICSTemplate objects.

Parameters

prints A vector of ExtractedPrint objects to be converted.

Returns: A vector of ICSTemplate objects converted from the ExtractedPrint objects.

Referenced by Applicant::ToICSTemplate().

Here is the caller graph for this function:

◆ ToISO() [1/2]

std::shared_ptr< ISOTemplate > ToISO ( ) const

inline

Convert this ExtractedPrint to into ISO/IEC 19794-2 compliant template.

Returns: ISOTemplate

Exceptions

EnrollmentException when it is not possible to convert template

References print, and ICSTemplate::ToISO().

Here is the call graph for this function:

◆ ToISO() [2/2]

std::shared_ptr< ISOTemplate > ToISO ( const std::shared_ptr< const Print > & print ) const

inlineinherited

Convert this ICSTemplate to into ISO/IEC 19794-2 compliant template.

Returns: ISOTemplate

Parameters

print it is Print from which ICSTemplate was extracted.

Exceptions

EnrollmentException when it is not possible to convert template

References icsTemplateData, PrintToIsoImpression(), and PrintToIsoPosition().

Referenced by ExtractedPrint::ToISO().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ToTemplates()

std::vector< std::shared_ptr< PrintTemplate > > ToTemplates ( const std::vector< std::shared_ptr< ExtractedPrint > > & prints )

inlinestatic

Converts a vector of ExtractedPrint objects into a vector of PrintTemplate objects.

This function takes a vector of ExtractedPrint objects and converts each element into an PrintTemplate object, then returns a vector of PrintTemplate objects.

Parameters

prints A vector of ExtractedPrint objects to be converted.

Returns: A vector of PrintTemplate objects converted from the ExtractedPrint objects.

Referenced by Applicant::ToTemplate().

Here is the caller graph for this function:

◆ WriteTo()

void WriteTo ( Writer & writer ) const

inlinefinalvirtual

Write itself into writer.

Parameters

writer Writer to use to serialize this Serializable

Implements Serializable.

References print, and ICSTemplate::WriteTo().

Here is the call graph for this function:

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

Print/ExtractedPrint.h

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExtractedPrint() [1/2]

◆ ExtractedPrint() [2/2]

Member Function Documentation

◆ Anonymize()

◆ CalculateQuality()

◆ EnhanceWithEmbedding() [1/2]

◆ EnhanceWithEmbedding() [2/2]

◆ GetCriticalPoints()

◆ GetEmbeddingRepresentation()

◆ GetICSTemplateBiometricPosition()

◆ GetMinutiae()

◆ GetVersion()

◆ HasEmbeddingRepresentation()

◆ IsICSTemplateBiometricPositionKnown()

◆ SimilarWith()

◆ ToANSI() [1/2]

◆ ToANSI() [2/2]

◆ ToICSTemplates()

◆ ToISO() [1/2]

◆ ToISO() [2/2]

◆ ToTemplates()

◆ WriteTo()