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

Check Detection Manager. More...

#import <kfxKCDCheckDetector.h>

Inheritance diagram for kfxKCDCheckDetector:
kfxKCDDocumentBaseDetector

Instance Methods

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

Detailed Description

Check Detection Manager.

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

Method Documentation

- (kfxKEDCheckDetectionResult*) detectImage: (UIImage *)  image
withSettings: (kfxKEDCheckDetectionSettings *)  settings
andError: (NSError **)  error 

Determines if a given image contains a check.

Given an image, this method will determine if a check is present or not. If a check is found, a result object containing the check's bounding coordinates will be returned. The result will also specify whether the front or back side was detected. If a check is not found, a result will be returned with empty coordinate data and a check side of 'none'.

Parameters
imageThe image to search for checks within.
settingsCheck 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 check detection data and guidance, or nil if no information could be produced.
See also
kfxKEDCheckDetectionSettings
kfxKEDCheckDetectionResult
- (kfxKEDCheckDetectionResult*) detectSample: (CMSampleBufferRef)  sample
withSettings: (kfxKEDCheckDetectionSettings *)  settings
andError: (NSError **)  error 

Determines if a given sample buffer contains a check.

Given a sample buffer in kCVPixelFormatType_32BGRA format, this method will determine if a check is present or not. If a check is found, a result object containing the check's bounding coordinates will be returned. The result will also specify whether the front or back side was detected. If a check is not found, a result will be returned with empty coordinate data and a check side of 'none'.

Parameters
sampleThe sample buffer in kCVPixelFormatType_32BGRA format to search for checks within.
settingsCheck 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 check detection data and guidance, or nil if no information could be produced.
See also
kfxKEDCheckDetectionSettings
kfxKEDCheckDetectionResult

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.