A class to represent single iris view and derived information. More...

#include <be_iris_incitsview.h>

Inherits BiometricEvaluation::View::View.

Inherited by BiometricEvaluation::Iris::ISO2011View.

Classes
struct	QualitySubBlock
	Representation of an iris quality block. More...

Public Types
typedef std::vector< QualitySubBlock >	QualitySet

Public Member Functions
uint8_t	getCertificationFlag () const
	Obtain the certification flag. More...

std::string	getCaptureDateString () const
	Obtain the capture date as a string. More...

Iris::CaptureDeviceTechnology	getCaptureDeviceTechnology () const
	Obtain the capture device technology. More...

uint16_t	getCaptureDeviceVendor () const
	Obtain the capture device vendor. More...

uint16_t	getCaptureDeviceType () const
	Obtain the capture device type. More...

void	getQualitySet (Iris::INCITSView::QualitySet &qualitySet) const
	Obtain the set of quality sub-blocks. More...

Iris::EyeLabel	getEyeLabel () const
	Obtain the eye label type. More...

Iris::ImageType	getImageType () const
	Obtain the iris image type. More...

void	getImageProperties (BiometricEvaluation::Iris::Orientation &horizontalOrientation, BiometricEvaluation::Iris::Orientation &verticalOrientation, BiometricEvaluation::Iris::ImageCompression &compressionHistory) const
	Obtain the iris image properties. More...

uint16_t	getCameraRange ()
	Obtain the camera range. More...

void	getRollAngleInfo (uint16_t &rollAngle, uint16_t &rollAngleUncertainty)
	Obtain the roll angle information. More...

void	getIrisCenterInfo (uint16_t &irisCenterSmallestX, uint16_t &irisCenterSmallestY, uint16_t &irisCenterLargestX, uint16_t &irisCenterLargestY, uint16_t &irisDiameterSmallest, uint16_t &irisDiameterLargest)
	Obtain the iris center information. More...

Public Member Functions inherited from BiometricEvaluation::View::View
std::shared_ptr< Image::Image >	getImage () const
	Obtain the image used for the biometric view in the format contained in the record (JPEG, etc.) More...

Image::Size	getImageSize () const
	Obtain the image size. More...

Image::Resolution	getImageResolution () const
	Obtain the image resolution. More...

uint32_t	getImageColorDepth () const
	Obtain the image color depth in bits-per-pixel. More...

Image::CompressionAlgorithm	getCompressionAlgorithm () const
	Obtain the compression algorithm used on the image. More...

Image::Resolution	getScanResolution () const
	Obtain the image scan resolution. More...

Static Public Attributes
static const uint16_t	RANGE_UNASSIGNED = 0

static const uint16_t	RANGE_FAILED = 1

static const uint16_t	RANGE_OVERFLOW = 65535

static const uint16_t	ROLL_ANGLE_UNDEF = 65535

static const uint16_t	ROLL_UNCERTAIN_UNDEF = 65535

static const uint16_t	COORDINATE_UNDEF = 0

Protected Member Functions
	INCITSView ()

	INCITSView (const std::string &filename, const uint32_t viewNumber)
	Construct the common components of an INCITS iris view from records contained in files. More...

	INCITSView (const Memory::uint8Array &buffer, const uint32_t viewNumber)
	Construct an INCITS iris view from a record contained in a buffer. More...

Memory::uint8Array const &	getIIRData () const
	Obtain a reference to the iris image record data buffer. More...

virtual void	readHeader (BiometricEvaluation::Memory::IndexedBuffer &buf, const uint32_t formatStandard)
	Read the common iris image record header from an INCITS record, excepting the format identifier and version number data items. More...

virtual void	readIrisView (Memory::IndexedBuffer &buf)
	Read the common iris representation information from an INCITS record. More...

Protected Member Functions inherited from BiometricEvaluation::View::View
	View ()

	~View ()

void	setImageSize (const BiometricEvaluation::Image::Size &imageSize)
	Mutator for the image size. More...

void	setImageColorDepth (uint32_t imageColorDepth)
	Mutator for the image color depth. More...

void	setImageResolution (const BiometricEvaluation::Image::Resolution &imageResolution)
	Mutator for the image resolution. More...

void	setScanResolution (const BiometricEvaluation::Image::Resolution &scanResolution)
	Mutator for the image scan resolution. More...

void	setImageData (const BiometricEvaluation::Memory::uint8Array &imageData)
	Mutator for the image data. More...

void	setCompressionAlgorithm (const Image::CompressionAlgorithm &ca)
	Mutator for the compression algorithm. More...

Static Protected Attributes
static const uint32_t	ISO2011_STANDARD = 1

static const uint32_t	BASE_FORMAT_ID = 0x49495200

static const uint8_t	CAPTURE_DATE_LENGTH = 9

Detailed Description

A class to represent single iris view and derived information.

A base Iris::INCITSView class represents an INCITS/ANSI or ISO iris view. This class defines the common interface for all ANSI/ISO views as well as common implementations. Subclasses specialize this class in order to represent other versions of the ANSI/ISO specs. Objects of this class cannot be created.

Definition at line 38 of file be_iris_incitsview.h.

Member Typedef Documentation

◆ QualitySet

typedef std::vector<QualitySubBlock> BiometricEvaluation::Iris::INCITSView::QualitySet

Definition at line 49 of file be_iris_incitsview.h.

Constructor & Destructor Documentation

◆ INCITSView() [1/3]

BiometricEvaluation::Iris::INCITSView::INCITSView ( )

protected

◆ INCITSView() [2/3]

BiometricEvaluation::Iris::INCITSView::INCITSView	(	const std::string &	filename,
		const uint32_t	viewNumber
	)

protected

Construct the common components of an INCITS iris view from records contained in files.

See documentation in child classes of INCITS for information on constructing INCITS-derived iris views.

Parameters

[in]	filename	The name of the file containing the complete iris image record.
[in]	viewNumber	The eye number to use.

Exceptions

Error::DataError	Invalid record format.
Error::FileError	Could not open or read from file.

◆ INCITSView() [3/3]

BiometricEvaluation::Iris::INCITSView::INCITSView	(	const Memory::uint8Array &	buffer,
		const uint32_t	viewNumber
	)

protected

Construct an INCITS iris view from a record contained in a buffer.

See documentation in child classes of INCITS for information on constructing INCITS-derived iris views.

Parameters

[in]	buffer	The buffer containing the complete iris image record.
[in]	viewNumber	The eye number to use.

Exceptions

Error::DataError Invalid record format.

Member Function Documentation

◆ getCertificationFlag()

uint8_t BiometricEvaluation::Iris::INCITSView::getCertificationFlag ( ) const

Obtain the certification flag.

Returns: The certification flag.

◆ getCaptureDateString()

std::string BiometricEvaluation::Iris::INCITSView::getCaptureDateString ( ) const

Obtain the capture date as a string.

Returns: The capture data and time.

◆ getCaptureDeviceTechnology()

Iris::CaptureDeviceTechnology BiometricEvaluation::Iris::INCITSView::getCaptureDeviceTechnology ( ) const

Obtain the capture device technology.

Returns: The capture device technology identifer.

◆ getCaptureDeviceVendor()

uint16_t BiometricEvaluation::Iris::INCITSView::getCaptureDeviceVendor ( ) const

Obtain the capture device vendor.

Returns: The capture device vendor ID.

◆ getCaptureDeviceType()

uint16_t BiometricEvaluation::Iris::INCITSView::getCaptureDeviceType ( ) const

Obtain the capture device type.

Returns: The capture device type ID.

◆ getQualitySet()

void BiometricEvaluation::Iris::INCITSView::getQualitySet ( Iris::INCITSView::QualitySet & qualitySet ) const

Obtain the set of quality sub-blocks.

Parameters

[out] qualitySet The set of quality sub-blocks.

◆ getEyeLabel()

Iris::EyeLabel BiometricEvaluation::Iris::INCITSView::getEyeLabel ( ) const

Obtain the eye label type.

Returns: The eye label.

◆ getImageType()

Iris::ImageType BiometricEvaluation::Iris::INCITSView::getImageType ( ) const

Obtain the iris image type.

Returns: The image type.

◆ getImageProperties()

void BiometricEvaluation::Iris::INCITSView::getImageProperties	(	BiometricEvaluation::Iris::Orientation &	horizontalOrientation,
		BiometricEvaluation::Iris::Orientation &	verticalOrientation,
		BiometricEvaluation::Iris::ImageCompression &	compressionHistory
	)		const

Obtain the iris image properties.

Parameters

[out]	horizontalOrientation	The horizontal orientation.
[out]	verticalOrientation	The vertical orientation.
[out]	compressionHistory	The image compression history.

◆ getCameraRange()

uint16_t BiometricEvaluation::Iris::INCITSView::getCameraRange ( )

Obtain the camera range.

RANGE_UNASSIGNED, RANGE_FAILED, or RANGE_OVERFLOW may be returned.

Returns: The camera range.

◆ getRollAngleInfo()

void BiometricEvaluation::Iris::INCITSView::getRollAngleInfo	(	uint16_t &	rollAngle,
		uint16_t &	rollAngleUncertainty
	)

Obtain the roll angle information.

Parameters

[out]	rollAngle	The roll angle.
[out]	rollAngleUncertainty	The roll angle uncertainty.

◆ getIrisCenterInfo()

void BiometricEvaluation::Iris::INCITSView::getIrisCenterInfo	(	uint16_t &	irisCenterSmallestX,
		uint16_t &	irisCenterSmallestY,
		uint16_t &	irisCenterLargestX,
		uint16_t &	irisCenterLargestY,
		uint16_t &	irisDiameterSmallest,
		uint16_t &	irisDiameterLargest
	)

Obtain the iris center information.

COORDINATE_UNDEF may be returned for any of the out parameters.

Parameters

[out]	irisCenterSmallestX	Smallest expected iris center X coordinate in pixels.
[out]	irisCenterSmallestY	Smallest expected iris center Y coordinate in pixels.
[out]	irisCenterLargestX	Largest expected iris center X coordinate in pixels.
[out]	irisCenterLargestY	Largest expected iris center Y coordinate in pixels.
[out]	irisDiameterSmallest	Smallest expected iris diameter in pixels.
[out]	irisDiameterLargest	Largest expected iris diameter in pixels.

◆ getIIRData()

Memory::uint8Array const & BiometricEvaluation::Iris::INCITSView::getIIRData ( ) const

protected

Obtain a reference to the iris image record data buffer.

Returns: The entire iris image record data.

◆ readHeader()

virtual void BiometricEvaluation::Iris::INCITSView::readHeader	(	BiometricEvaluation::Memory::IndexedBuffer &	buf,
		const uint32_t	formatStandard
	)

protectedvirtual

Read the common iris image record header from an INCITS record, excepting the format identifier and version number data items.

Parameters

[in]	buf	The indexed buffer containing the record data, with the index starting at the first octet after the format identifier and version number data items. The index of the buffer will be changed to the location after the header.
[in]	formatStandard	Value indicating which header version to read; must be ISO2011_STANDARD

Exceptions

ParameterError	The specVersion parameter is incorrect.
DataError	The INCITS record has invalid or missing data.

◆ readIrisView()

virtual void BiometricEvaluation::Iris::INCITSView::readIrisView ( Memory::IndexedBuffer & buf )

protectedvirtual

Read the common iris representation information from an INCITS record.

An Iris Representation from an INCITS record includes image information, cropping information, etc.

Parameters

[in,out] buf The indexed buffer containing the record data. The index of the buffer will be changed to the location after the Iris Representation.

Exceptions

DataError The INCITS record has invalid or missing data.

Member Data Documentation

◆ RANGE_UNASSIGNED

const uint16_t BiometricEvaluation::Iris::INCITSView::RANGE_UNASSIGNED = 0

static

Definition at line 51 of file be_iris_incitsview.h.

◆ RANGE_FAILED

const uint16_t BiometricEvaluation::Iris::INCITSView::RANGE_FAILED = 1

static

Definition at line 52 of file be_iris_incitsview.h.

◆ RANGE_OVERFLOW

const uint16_t BiometricEvaluation::Iris::INCITSView::RANGE_OVERFLOW = 65535

static

Definition at line 53 of file be_iris_incitsview.h.

◆ ROLL_ANGLE_UNDEF

const uint16_t BiometricEvaluation::Iris::INCITSView::ROLL_ANGLE_UNDEF = 65535

static

Definition at line 55 of file be_iris_incitsview.h.

◆ ROLL_UNCERTAIN_UNDEF

const uint16_t BiometricEvaluation::Iris::INCITSView::ROLL_UNCERTAIN_UNDEF = 65535

static

Definition at line 56 of file be_iris_incitsview.h.

◆ COORDINATE_UNDEF

const uint16_t BiometricEvaluation::Iris::INCITSView::COORDINATE_UNDEF = 0

static

Definition at line 57 of file be_iris_incitsview.h.

◆ ISO2011_STANDARD

const uint32_t BiometricEvaluation::Iris::INCITSView::ISO2011_STANDARD = 1

staticprotected

Definition at line 196 of file be_iris_incitsview.h.

◆ BASE_FORMAT_ID

const uint32_t BiometricEvaluation::Iris::INCITSView::BASE_FORMAT_ID = 0x49495200

staticprotected

Definition at line 197 of file be_iris_incitsview.h.

◆ CAPTURE_DATE_LENGTH

const uint8_t BiometricEvaluation::Iris::INCITSView::CAPTURE_DATE_LENGTH = 9

staticprotected

Definition at line 199 of file be_iris_incitsview.h.

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

be_iris_incitsview.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ QualitySet

Constructor & Destructor Documentation

◆ INCITSView() [1/3]

◆ INCITSView() [2/3]

◆ INCITSView() [3/3]

Member Function Documentation

◆ getCertificationFlag()

◆ getCaptureDateString()

◆ getCaptureDeviceTechnology()

◆ getCaptureDeviceVendor()

◆ getCaptureDeviceType()

◆ getQualitySet()

◆ getEyeLabel()

◆ getImageType()

◆ getImageProperties()

◆ getCameraRange()

◆ getRollAngleInfo()

◆ getIrisCenterInfo()

◆ getIIRData()

◆ readHeader()

◆ readIrisView()

Member Data Documentation

◆ RANGE_UNASSIGNED

◆ RANGE_FAILED

◆ RANGE_OVERFLOW

◆ ROLL_ANGLE_UNDEF

◆ ROLL_UNCERTAIN_UNDEF

◆ COORDINATE_UNDEF

◆ ISO2011_STANDARD

◆ BASE_FORMAT_ID

◆ CAPTURE_DATE_LENGTH