NIST Biometric Evaluation Framework
Software components for biometric technology evaluations
Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
BiometricEvaluation::Iris::ISO2011View Class Reference

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

#include <be_iris_iso2011view.h>

Inherits BiometricEvaluation::Iris::INCITSView.

Public Member Functions

 ISO2011View ()
 Construct an empty ISO 2011 iris view. More...
 
 ISO2011View (const std::string &filename, const uint32_t viewNumber)
 Construct an ISO 2011 iris view from the named file. More...
 
 ISO2011View (const Memory::uint8Array &buffer, const uint32_t viewNumber)
 Construct an ISO 2011 iris view from a record contained in a buffer. More...
 
- Public Member Functions inherited from BiometricEvaluation::Iris::INCITSView
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::ImagegetImage () 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...
 

Protected Member Functions

void readISOHeader (BiometricEvaluation::Memory::IndexedBuffer &buf)
 
- Protected Member Functions inherited from BiometricEvaluation::Iris::INCITSView
 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 BASE_SPEC_VERSION = 0x30323000
 
- Static Protected Attributes inherited from BiometricEvaluation::Iris::INCITSView
static const uint32_t ISO2011_STANDARD = 1
 
static const uint32_t BASE_FORMAT_ID = 0x49495200
 
static const uint8_t CAPTURE_DATE_LENGTH = 9
 

Additional Inherited Members

- Public Types inherited from BiometricEvaluation::Iris::INCITSView
typedef std::vector< QualitySubBlockQualitySet
 
- Static Public Attributes inherited from BiometricEvaluation::Iris::INCITSView
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
 

Detailed Description

A class to represent single iris view and derived information.

An Iris::ISO2011VIEW class represents an ISO 19794-6 iris image record view.

Definition at line 28 of file be_iris_iso2011view.h.

Constructor & Destructor Documentation

◆ ISO2011View() [1/3]

BiometricEvaluation::Iris::ISO2011View::ISO2011View ( )

Construct an empty ISO 2011 iris view.

◆ ISO2011View() [2/3]

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

Construct an ISO 2011 iris view from the named file.

Parameters
[in]filenameThe name of the file containing the complete iris image record.
[in]viewNumberThe eye number to use.
Exceptions
Error::DataErrorInvalid record format.
Error::FileErrorCould not open or read from file.

◆ ISO2011View() [3/3]

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

Construct an ISO 2011 iris view from a record contained in a buffer.

Parameters
[in]bufferThe buffer containing the complete iris image record.
[in]viewNumberThe eye number to use.
Exceptions
Error::DataErrorInvalid record format.

Member Function Documentation

◆ readISOHeader()

void BiometricEvaluation::Iris::ISO2011View::readISOHeader ( BiometricEvaluation::Memory::IndexedBuffer buf)
protected

Member Data Documentation

◆ BASE_SPEC_VERSION

const uint32_t BiometricEvaluation::Iris::ISO2011View::BASE_SPEC_VERSION = 0x30323000
staticprotected

Definition at line 72 of file be_iris_iso2011view.h.


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