IrisTemplate is Innovatrics proprietary template created by IrisExtractor. More...

#include <Iris.h>

Collaboration diagram for IrisTemplate:

Public Member Functions
bool	IsIrisTemplateBiometricPositionKnown () const
	It checks if template contains known biometric position.
IrisPosition	GetIrisTemplateBiometricPosition () const
	It returns biometric position to which template belongs.
IrisSimilarityScore	SimilarWith (const IrisTemplate &gallery) const
	Calculates IrisSimilarityScore for given IrisTemplate.
unsigned int	CalculateQuality ()
	Calculates quality of IrisTemplate.
std::string	GetVersion () const
	Provides version information of Innovatrics proprietary algorithm used to create the iris template.
void	WriteTo (Writer &writer) const override
	Function serializes IrisTemplate via provided Writer.
	IrisTemplate (std::vector< uint8_t > &&templ, std::shared_ptr< IrisExecutor > executor)
	Construct a new IrisTemplate object Biometric position is unknown.
	IrisTemplate (std::vector< uint8_t > &&templ)
	Construct a new IrisTemplate object Biometric position is unknown.
	IrisTemplate (const std::vector< uint8_t > &templ, std::shared_ptr< IrisExecutor > executor)
	Construct a new IrisTemplate object, copy template data Biometric position is unknown.
	IrisTemplate (const std::vector< uint8_t > &templ)
	Construct a new IrisTemplate object, copy template data Biometric position is unknown.
	IrisTemplate (std::vector< uint8_t > &&templ, IrisPosition position, std::shared_ptr< IrisExecutor > executor)
	Construct a new IrisTemplate object.
	IrisTemplate (std::vector< uint8_t > &&templ, IrisPosition position)
	Construct a new IrisTemplate object GlobalIrisExecutor is used.
	IrisTemplate (const std::vector< uint8_t > &templ, IrisPosition position, std::shared_ptr< IrisExecutor > executor)
	Construct a new IrisTemplate object, copy template data.
	IrisTemplate (const std::vector< uint8_t > &templ, IrisPosition position)
	Construct a new IrisTemplate object, copy template data GlobalIrisExecutor is used.

Public Attributes
const std::vector< uint8_t >	data
	Template data.

Detailed Description

IrisTemplate is Innovatrics proprietary template created by IrisExtractor.

The template can be used later for verification.

Constructor & Destructor Documentation

◆ IrisTemplate() [1/8]

IrisTemplate	(	std::vector< uint8_t > &&	templ,
		std::shared_ptr< IrisExecutor >	executor )

inline

Construct a new IrisTemplate object Biometric position is unknown.

Parameters

templ	template data
executor	is IrisExecutor

Exceptions

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

References data.

Referenced by SimilarWith().

Here is the caller graph for this function:

◆ IrisTemplate() [2/8]

IrisTemplate ( std::vector< uint8_t > && templ )

inlineexplicit

Construct a new IrisTemplate object Biometric position is unknown.

GlobalIrisExecutor is used.

Parameters

templ template data

Exceptions

InvalidTemplateException when Iris template has no data

References data.

◆ IrisTemplate() [3/8]

IrisTemplate	(	const std::vector< uint8_t > &	templ,
		std::shared_ptr< IrisExecutor >	executor )

inline

Construct a new IrisTemplate object, copy template data Biometric position is unknown.

Parameters

templ	template data
executor	is IrisExecutor

Exceptions

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

References data.

◆ IrisTemplate() [4/8]

IrisTemplate ( const std::vector< uint8_t > & templ )

inlineexplicit

Construct a new IrisTemplate object, copy template data Biometric position is unknown.

GlobalIrisExecutor is used.

Parameters

templ template data

Exceptions

InvalidTemplateException when Iris template has no data

References data.

◆ IrisTemplate() [5/8]

IrisTemplate	(	std::vector< uint8_t > &&	templ,
		IrisPosition	position,
		std::shared_ptr< IrisExecutor >	executor )

inline

Construct a new IrisTemplate object.

Parameters

templ	template data
executor	is IrisExecutor
position	biometric position to which template belongs

Exceptions

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

References data.

◆ IrisTemplate() [6/8]

IrisTemplate	(	std::vector< uint8_t > &&	templ,
		IrisPosition	position )

inlineexplicit

Construct a new IrisTemplate object GlobalIrisExecutor is used.

Parameters

templ	template data
position	biometric position to which template belongs

Exceptions

InvalidTemplateException when Iris template has no data

References data.

◆ IrisTemplate() [7/8]

IrisTemplate	(	const std::vector< uint8_t > &	templ,
		IrisPosition	position,
		std::shared_ptr< IrisExecutor >	executor )

inline

Construct a new IrisTemplate object, copy template data.

Parameters

templ	template data
position	biometric position to which template belongs
executor	is IrisExecutor

Exceptions

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

References data.

◆ IrisTemplate() [8/8]

IrisTemplate	(	const std::vector< uint8_t > &	templ,
		IrisPosition	position )

inlineexplicit

Construct a new IrisTemplate object, copy template data GlobalIrisExecutor is used.

Parameters

templ	template data
position	biometric position to which template belongs

Exceptions

InvalidTemplateException when Iris template has no data

References data.

Member Function Documentation

◆ CalculateQuality()

unsigned int CalculateQuality ( )

inline

Calculates quality of IrisTemplate.

Returns: quality of the template. It is based just on sharpness in visible area. It is normalized in range <0, 100> where 0 - min quality, 100 - max quality.

Exceptions

EnrollmentException when it is not possible to get template quality

References data.

◆ GetIrisTemplateBiometricPosition()

IrisPosition GetIrisTemplateBiometricPosition ( ) const

inline

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 iris template.

Returns: version string

References data.

◆ IsIrisTemplateBiometricPositionKnown()

bool IsIrisTemplateBiometricPositionKnown ( ) const

inline

It checks if template contains known biometric position.

Returns: true when biometric position is known; false when biometric position is unknown

◆ SimilarWith()

IrisSimilarityScore SimilarWith ( const IrisTemplate & gallery ) const

inline

Calculates IrisSimilarityScore for given IrisTemplate.

Parameters

gallery IrisTemplate for score calculation

Returns: IrisSimilarityScore

Exceptions

EnrollmentException when it is not possible to match templates

References data, and IrisTemplate().

Here is the call graph for this function:

◆ WriteTo()

void WriteTo ( Writer & writer ) const

inlineoverridevirtual

Function serializes IrisTemplate via provided Writer.

Parameters

writer used to serialize Iris.

Implements Serializable.

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

Referenced by ExtractedIris::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:

Iris/Iris.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IrisTemplate() [1/8]

◆ IrisTemplate() [2/8]

◆ IrisTemplate() [3/8]

◆ IrisTemplate() [4/8]

◆ IrisTemplate() [5/8]

◆ IrisTemplate() [6/8]

◆ IrisTemplate() [7/8]

◆ IrisTemplate() [8/8]

Member Function Documentation

◆ CalculateQuality()

◆ GetIrisTemplateBiometricPosition()

◆ GetVersion()

◆ IsIrisTemplateBiometricPositionKnown()

◆ SimilarWith()

◆ WriteTo()