Enrollment 28.2.0
Loading...
Searching...
No Matches

Iris capture contains one iris. More...

#include <IrisCapture.h>

Collaboration diagram for IrisCapture:

Public Member Functions

std::shared_ptr< IrisSegment > DetectWith (IrisDetector &detector) const
 It detects iris.

Static Public Member Functions

static std::shared_ptr< IrisCapture > Create (std::shared_ptr< Image > img, const IrisPosition &pos, const IrisAttributes &ia=IrisAttributes())
 Constructor of IrisCapture.
static std::shared_ptr< IrisCapture > FromIsoImage (const std::vector< uint8_t > &isoImage)
 Function creates shared pointer of the Iris object from ISO image based on ISO/IEC 19794-6 (Iris image data).

Public Attributes

const std::shared_ptr< Image > image
 Provides IrisCapture Image.
const IrisPosition position
 Provides IrisPosition.
const IrisAttributes irisAttributes
 Provides IrisAttributes.

Detailed Description

Iris capture contains one iris.

Member Function Documentation

◆ Create()

std::shared_ptr< IrisCapture > Create ( std::shared_ptr< Image > img,
const IrisPosition & pos,
const IrisAttributes & ia = IrisAttributes() )
inlinestatic

Constructor of IrisCapture.

Parameters
imgiris capture image, will be moved into this class
posiris position
iaIrisAttributes
Returns
created IrisCapture object
Exceptions
NullArgumentExceptionwhen image is null

Referenced by FromIsoImage().

Here is the caller graph for this function:

◆ DetectWith()

std::shared_ptr< IrisSegment > DetectWith ( IrisDetector & detector) const
inlinenodiscard

It detects iris.

Parameters
detectoris IrisDetector
Returns
detected IrisSegment
Exceptions
EnrollmentExceptionwhen Detector throws

References IrisDetector::Detect(), image, irisAttributes, and position.

Here is the call graph for this function:

◆ FromIsoImage()

std::shared_ptr< IrisCapture > FromIsoImage ( const std::vector< uint8_t > & isoImage)
inlinestaticnodiscard

Function creates shared pointer of the Iris object from ISO image based on ISO/IEC 19794-6 (Iris image data).

[7]

Parameters
isoImageISO image from ISO/IEC 19794-6 (Iris image data)
Returns
shared pointer of the Iris object
Exceptions
ImageExceptionwhen type is not supported or image data are corrupted
EnrollmentInvalidArgumentExceptionwhen not possible to decode ISO image

References Create(), Image::Decode(), Image::DecodeRawImage(), DefaultDpi, RawImage::GRAYSCALE, IsoToIrisCaptureDeviceTechnology(), IsoToIrisImageType(), IsoToIrisPosition(), position, IrisAttributes::SetCaptureDeviceTechnology(), IrisAttributes::SetCaptureDeviceTypeID(), IrisAttributes::SetCaptureDeviceVendorID(), and IrisAttributes::SetImageType().

Here is the call graph for this function:

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