Iris Class Reference

It holds all functions and data related to iris manipulation. More...

#include <Iris.h>

Collaboration diagram for Iris:

Public Member Functions
Polygon	CalculateEyelid () const
	Provides polygon of lower and upper eyelid.
std::shared_ptr< Image >	GetISO19794IrisImage () const
	Provides a cropped and masked iris image compliant with ISO/IEC 19794-6:2011 standards.
std::vector< uint8_t >	ToIsoImage (ImageEncoder &encoder) const
	Function creates ISO image based on ISO/IEC 19794-6 (Iris image data).
std::vector< uint8_t >	ToIsoRawImage () const
	Function creates ISO image based on ISO/IEC 19794-6 (Iris image data) use RawImage.
std::shared_ptr< ExtractedIris >	Extract ()
	Function creates template for given image with default IrisExtractorConfig.
std::shared_ptr< ExtractedIris >	Extract (const IrisExtractorConfig &cfg)
	Function creates template for given image.
void	WriteTo (Writer &writer) const final
	Function serializes Iris via provided Writer.

Public Attributes
const std::shared_ptr< Image >	image
	Provides Iris Image.
const float	confidence
	Provides confidence score of the iris related to iris detection.
const IrisPosition	position
	Provides IrisPosition.
const IrisAttributes	irisAttributes
	Provides IrisAttributes.

Friends
class	IrisDetector

Detailed Description

It holds all functions and data related to iris manipulation.

Member Function Documentation

CalculateEyelid()

Polygon CalculateEyelid ( ) const

inline

Provides polygon of lower and upper eyelid.

Returns

Polygon eyelids polygon.

References image.

Referenced by GetISO19794IrisImage().

Here is the caller graph for this function:

Extract() [1/2]

std::shared_ptr< ExtractedIris > Extract ( )

inline

Function creates template for given image with default IrisExtractorConfig.

Returns

template calculated template

Exceptions

EnrollmentException

when it is not possible to extract templates

Required Solvers

See IrisExtractorConfig::Type

References IrisExtractorConfig::Default(), and Extract().

Referenced by Extract().

Here is the call graph for this function:

Here is the caller graph for this function:

Extract() [2/2]

std::shared_ptr< ExtractedIris > Extract ( const IrisExtractorConfig & cfg )

inline

Function creates template for given image.

Parameters

cfg	IrisExtractorConfig

Returns

template calculated template

Exceptions

EnrollmentException

when it is not possible to extract templates

Required Solvers

See IrisExtractorConfig::Type

References IrisExtractorConfig::GetExtractor(), image, and position.

Here is the call graph for this function:

GetISO19794IrisImage()

std::shared_ptr< Image > GetISO19794IrisImage ( ) const

inline

Provides a cropped and masked iris image compliant with ISO/IEC 19794-6:2011 standards.

This function generates a cropped rectilinear iris image with applied masks to the upper and lower eyelids, and the sclera, enhancing image compressibility. The masking operation assigns a single grey value to these regions: 128 for eyelids and 200 for sclera, facilitating compression. Additionally, it incorporates mask transition blurring to minimize boundary impacts on compression, employing a low-pass filter to smooth transitions. This process aligns with the ISO standard's guidance for creating highly compressible iris images while maintaining the normative requirements for image compression specified in the standard.

Reference: ISO/IEC 19794-6:2011(E), Sections 6.5.1 - 6.5.4, Cropped and Masked Iris Image specifications [7].

Returns

A masked iris image, prepared according to ISO/IEC standards.

Exceptions

EnrollmentInvalidArgumentException

when iris is not fully contained within the image

References CalculateEyelid(), Circle::CreateInscribedCircle(), image, and Image::INSIDE.

Here is the call graph for this function:

ToIsoImage()

std::vector< uint8_t > ToIsoImage ( ImageEncoder & encoder ) const

inline

Function creates ISO image based on ISO/IEC 19794-6 (Iris image data).

ISO standard defines a standard for exchange of iris image information. It contains a specific definition of attributes, a data record format for storing and transmitting the iris image and certain attributes, and conformance criteria

Parameters

encoder

specific encoder for encoding Print image. Supported JPG (lossy), JPEG 2000 (lossy & lossless), PNG

Returns

ISO image from ISO/IEC 19794-6 (Iris image data)

Exceptions

ImageException	when it is not possible to encode image
EnrollmentInvalidArgumentException	when encoder is not supported
EnrollmentRuntimeException	for invalid conversion size

ToIsoRawImage()

std::vector< uint8_t > ToIsoRawImage ( ) const

inlinenodiscard

Function creates ISO image based on ISO/IEC 19794-6 (Iris image data) use RawImage.

Returns

ISO raw image from ISO/IEC 19794-6 (Iris image data)

Exceptions

EnrollmentRuntimeException

for invalid conversion size

References image.

WriteTo()

void WriteTo ( Writer & writer ) const

inlinefinalvirtual

Function serializes Iris via provided Writer.

Parameters

writer

used to serialize Iris.

Implements Serializable.

References confidence, image, irisAttributes, and position.

Member Data Documentation

confidence

const float confidence

Provides confidence score of the iris related to iris detection.

Confidence values are from range <0,1>. The higher the value of the attribute the better quality of the iris. The decision threshold is around 0.6.

Referenced by WriteTo().

---

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

• Iris/Iris.h