ExtractedIris Class Reference

ExtractedIris is template created by IrisExtractor with Iris that belongs to template. More...

#include <Iris.h>

Collaboration diagram for ExtractedIris:

Public Member Functions
void	WriteTo (Writer &writer) const final
	Function serializes ExtractedIris via provided Writer.
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.

Static Public Member Functions
static std::vector< std::shared_ptr< IrisTemplate > >	ToTemplates (const std::vector< std::shared_ptr< ExtractedIris > > &irises)
	Converts a vector of ExtractedIris objects into a vector of IrisTemplate objects.

Public Attributes
const std::shared_ptr< Iris >	iris
	Iris that is used to template extraction.
const std::vector< uint8_t >	data
	Template data.

Friends
class	Iris

Detailed Description

ExtractedIris is template created by IrisExtractor with Iris that belongs to template.

The template can be used later for verification.

Member Function Documentation

CalculateQuality()

unsigned int CalculateQuality ( )

inlineinherited

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

inlineinherited

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

Returns

version string

References data.

IsIrisTemplateBiometricPositionKnown()

bool IsIrisTemplateBiometricPositionKnown ( ) const

inlineinherited

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

inlineinherited

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:

ToTemplates()

std::vector< std::shared_ptr< IrisTemplate > > ToTemplates ( const std::vector< std::shared_ptr< ExtractedIris > > & irises )

inlinestatic

Converts a vector of ExtractedIris objects into a vector of IrisTemplate objects.

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

Parameters

irises

A vector of ExtractedIris objects to be converted.

Returns

A vector of IrisTemplate objects converted from the ExtractedIris objects.

Referenced by Applicant::ToICSTemplate(), and Applicant::ToTemplate().

Here is the caller graph for this function:

WriteTo()

void WriteTo ( Writer & writer ) const

inlinefinalvirtual

Function serializes ExtractedIris via provided Writer.

Parameters

writer

used to serialize Iris.

Implements Serializable.

References iris, Writer::Write(), and IrisTemplate::WriteTo().

Here is the call graph for this function:

---

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

• Iris/Iris.h