Atalasoft MobileImage API Reference
Instance Methods | List of all members
KFXPassportDetector Class Reference

Passport Detector class. More...

#import <KFXPassportDetector.h>

Inheritance diagram for KFXPassportDetector:
kfxKCDDocumentBaseDetector

Instance Methods

(KFXPassportDetectionResult *) - detectImage:withSettings:andError:
 Determines if a given image contains a passport. More...
 
(KFXPassportDetectionResult *) - detectSample:withSettings:andError:
 Determines if a given sample buffer contains a passport. More...
 

Detailed Description

Passport Detector class.

Passport Detector is a standalone processing class for determining if a given image or sample buffer contains a passport. When a passport is found, a result object will be returned containing its coordinates. Since this class is limited in scope to detecting passports, the results will not include any data from the passport itself.

Method Documentation

◆ detectImage:withSettings:andError:()

- (KFXPassportDetectionResult*) detectImage: (UIImage *)  image
withSettings: (KFXPassportDetectionSettings *)  settings
andError: (NSError **)  error 

Determines if a given image contains a passport.

Given an image, this method will determine if a passport is present or not. If a passport is found, a result object containing the passport's bounding coordinates will be returned.

Parameters
imageThe image to search for passport within.
settingsPassport detection settings. If nil than default settings will be used.
errorOn return, if detection could not be performed, a pointer to an error object that encapsulates the reason for failure. The detect method will also return nil in this instance. Pass nil for this argument if you are not interested in specific error information.
Returns
A result containing passport detection data and guidance, or nil if no information could be produced.
See also
KFXPassportDetectionSettings
KFXPassportDetectionResult

◆ detectSample:withSettings:andError:()

- (KFXPassportDetectionResult*) detectSample: (CMSampleBufferRef)  sample
withSettings: (KFXPassportDetectionSettings *)  settings
andError: (NSError **)  error 

Determines if a given sample buffer contains a passport.

Given a sample buffer in kCVPixelFormatType_32BGRA format, this method will determine if a passport is present or not. If a passport is found, a result object containing the passport's bounding coordinates will be returned.

Parameters
sampleThe sample buffer in kCVPixelFormatType_32BGRA format to search for passport within.
settingsPassport detection settings. If nil than default settings will be used.
errorOn return, if detection could not be performed, a pointer to an error object that encapsulates the reason for failure. The detect method will also return nil in this instance. Pass nil for this argument if you are not interested in specific error information.
Returns
A result containing passport detection data and guidance, or nil if no information could be produced.
See also
KFXPassportDetectionSettings
KFXPassportDetectionResult

The documentation for this class was generated from the following file:
Untitled Document © 2017 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.