ICSTemplate Class Reference

Print template in ICS format used for biometric operations. More...

#include <ICSTemplate.h>

Collaboration diagram for ICSTemplate:

Public Member Functions
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.
	ICSTemplate (std::vector< uint8_t > d)
	Create ICSTemplate object GlobalPrintExecutor is used to execute template functionality.
	ICSTemplate (std::vector< uint8_t > d, std::shared_ptr< PrintExecutor > executor)
	Create ICSTemplate object Biometric position is loaded from template is possible.
	ICSTemplate (std::vector< uint8_t > d, PrintPosition position)
	Create ICSTemplate object GlobalPrintExecutor is used to execute template functionality.
	ICSTemplate (std::vector< uint8_t > d, PrintPosition position, std::shared_ptr< PrintExecutor > executor)
	Create ICSTemplate object The template format is validated.
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.
void	WriteTo (Writer &w) const override
	Write itself into writer.

Public Attributes
const std::vector< uint8_t >	icsTemplateData
	template data

Detailed Description

Print template in ICS format used for biometric operations.

The template contains one and only one print template.

Constructor & Destructor Documentation

ICSTemplate() [1/4]

ICSTemplate ( std::vector< uint8_t > d )

inlineexplicit

Create ICSTemplate object GlobalPrintExecutor is used to execute template functionality.

Biometric position is loaded from template is possible. The template format is validated.

Parameters

d	template data

Exceptions

InvalidTemplateException	when ICS template has no data
EnrollmentException	when ICS template has no print templates
EnrollmentException	when ICS template has more print templates
EnrollmentException	when ICS template has templates of other modalities
EnrollmentException	when it is not possible to parse template

References ICSTemplate().

Referenced by ExtractedPrint::ExtractedPrint(), ExtractedPrint::ExtractedPrint(), ICSTemplate(), ICSTemplate(), and SimilarWith().

Here is the call graph for this function:

Here is the caller graph for this function:

ICSTemplate() [2/4]

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

inline

Create ICSTemplate object Biometric position is loaded from template is possible.

The template format is validated.

Parameters

d	template data
executor	PrintExecutor used to execute template functionality.

Exceptions

NullArgumentException	when executor is null
InvalidTemplateException	when ICS template has no data
EnrollmentException	when ICS template has no print templates
EnrollmentException	when ICS template has more print templates
EnrollmentException	when ICS template has templates of other modalities
EnrollmentException	when it is not possible to parse template

References icsTemplateData, and IsoToPrintPosition().

Here is the call graph for this function:

ICSTemplate() [3/4]

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

inlineexplicit

Create ICSTemplate object GlobalPrintExecutor is used to execute template functionality.

The template format is validated. The given position is stored in template data is possible.

Parameters

d	template data
position	biometric position to which template belongs

Exceptions

InvalidTemplateException	when ICS template has no data
EnrollmentException	when ICS template has no print templates
EnrollmentException	when ICS template has more print templates
EnrollmentException	when ICS template has templates of other modalities
EnrollmentException	when it is not possible to parse template

References ICSTemplate().

Here is the call graph for this function:

ICSTemplate() [4/4]

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

inline

Create ICSTemplate object The template format is validated.

The given position is stored in template data is possible.

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 ICS template has no data
EnrollmentException	when ICS template has no print templates
EnrollmentException	when ICS template has more print templates
EnrollmentException	when ICS template has templates of other modalities
EnrollmentException	when it is not possible to parse template

References icsTemplateData, and PrintToIsoPosition().

Here is the call graph for this function:

Member Function Documentation

Anonymize()

std::shared_ptr< ICSTemplate > Anonymize ( ) const

inlinenodiscard

Creates ICSTemplate without position.

Returns

ICSTemplate without position.

References icsTemplateData.

CalculateQuality()

uint8_t CalculateQuality ( )

inline

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.

GetCriticalPoints()

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

inline

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:

GetICSTemplateBiometricPosition()

PrintPosition GetICSTemplateBiometricPosition ( ) const

inlinenodiscard

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

inline

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

inlinenodiscard

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

Returns

version string

References icsTemplateData.

IsICSTemplateBiometricPositionKnown()

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

inline

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

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

inline

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:

ToISO()

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

inline

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:

WriteTo()

void WriteTo ( Writer & writer ) const

inlineoverridevirtual

Write itself into writer.

Parameters

writer

Writer to use to serialize this Serializable

Implements Serializable.

References icsTemplateData, Writer::Write(), and Writer::WriteArray().

Referenced by ExtractedPrint::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/ICSTemplate.h