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

Document Detector class. More...

#import <kfxKCDDocumentDetector.h>

Inheritance diagram for kfxKCDDocumentDetector:
kfxKCDDocumentBaseDetector

Instance Methods

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

Detailed Description

Document Detector class.

Document Detector is a standalone processing class for determining if a given image contains a document. When a document is found, a result object will be returned. Since detection is based on super-resolution technique, the high accuracy results will be returned after multiply runs. For better performance recommended to use CMSampleBufferRef input, instead of UIImage.

Method Documentation

- (kfxKEDDocumentDetectionResult*) detectImage: (UIImage *)  image
withSettings: (kfxKEDDocumentDetectionSettings *)  settings
andError: (NSError **)  error 

Determines if a given image contains a document.

Given an image, this method will determine if a document is present or not. If a document is found, a result object containing the document's bounding coordinates along with guidance will be returned. This is not recommended to use due performance overhead. Consider to use sample buffer input implementation.

Parameters
imageThe image for searching a document
settingsA collection of settings to control detector behavior. 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 document detection data and guidance, or nil if no information could be produced.
See also
kfxKEDDocumentDetectionSettings
kfxKEDDocumentDetectionResult
- (kfxKEDDocumentDetectionResult*) detectSample: (CMSampleBufferRef)  sample
withSettings: (kfxKEDDocumentDetectionSettings *)  settings
andError: (NSError **)  error 

Determines if a given sample buffer contains a document.

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

Parameters
sampleThe sample buffer in kCVPixelFormatType_32BGRA format for searching a document
settingsA collection of settings to control detector behavior. 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 document detection data and guidance, or nil if no information could be produced.
See also
kfxKEDDocumentDetectionSettings
kfxKEDDocumentDetectionResult

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