Atalasoft MobileImage API Reference
Instance Methods | Properties | List of all members
<kfxKEDCheckDetectionResult> Protocol Reference

A result object returned by the Check Detector. More...

#import <kfxKEDCheckDetectionResult.h>

Inheritance diagram for <kfxKEDCheckDetectionResult>:

Instance Methods

(void) - DEPRECATED_ATTRIBUTE
 Resets cached guidance. More...
 

Properties

kfxKEDBoundingTetragon *bounds DEPRECATED_ATTRIBUTE
 The bounding coordinates of the detected check. More...
 
UIImage *originalImage DEPRECATED_ATTRIBUTE
 The original image that was supplied to the Check Detector object. More...
 
KEDDocumentZoomGuidance zoomGuidance DEPRECATED_ATTRIBUTE
 Reports guidance for obtaining the optimal size of a check within the frame. More...
 
KEDDocumentTurnGuidance turnGuidance DEPRECATED_ATTRIBUTE
 Reports guidance for correcting off-angle rotation for a check. More...
 
KEDDocumentHorizontalGuidance horizontalMovementGuidance DEPRECATED_ATTRIBUTE
 Reports guidance for correcting horizontal position of a check within a frame. More...
 
KEDDocumentVerticalGuidance verticalMovementGuidance DEPRECATED_ATTRIBUTE
 Reports guidance for correcting vertical position of a check within a frame. More...
 
CGRect targetRect DEPRECATED_ATTRIBUTE
 Returns the target rectangle. More...
 
KEDCheckSide checkSide DEPRECATED_ATTRIBUTE
 Reports side of the check that was detected. More...
 

Detailed Description

A result object returned by the Check Detector.

This is a deprecated protocol. Consider to use kfxKEDCheckDetectionResult interface instead of protocol.

Method Documentation

- (void) DEPRECATED_ATTRIBUTE

Resets cached guidance.

Call this to reset cached guidance. Once guidance is generated it will be cached, so there will be no calculation on next property access.

Property Documentation

- (kfxKEDBoundingTetragon* bounds) DEPRECATED_ATTRIBUTE
readnonatomicstrong

The bounding coordinates of the detected check.

- (UIImage* originalImage) DEPRECATED_ATTRIBUTE
readnonatomicstrong

The original image that was supplied to the Check Detector object.

- (KEDDocumentZoomGuidance zoomGuidance) DEPRECATED_ATTRIBUTE
readnonatomicassign

Reports guidance for obtaining the optimal size of a check within the frame.

An enum value indicating whether the user should zoom in, zoom out, or if zoom is okay. Guidance is based on how much of the detected check area covers the target area, and is controlled by a minimum and maximum tolerance specified in the CheckDetectionSettings object given to the detector.

Matching checks with aspect ratios different than the target rectangle will require more tolerance in the upper or lower bounds to report a good zoom level.

- (KEDDocumentTurnGuidance turnGuidance) DEPRECATED_ATTRIBUTE
readnonatomicassign

Reports guidance for correcting off-angle rotation for a check.

An enum value indicating whether the user should rotate or if the angle is okay. Guidance is based on the difference between the detected check angle and target frame angle. It is controlled by a maximum tolerance specified in the CheckDetectionSettings object given to the detector.

- (KEDDocumentHorizontalGuidance horizontalMovementGuidance) DEPRECATED_ATTRIBUTE
readnonatomicassign

Reports guidance for correcting horizontal position of a check within a frame.

An enum value indicating whether the user should move the check to the left or right, or if position is okay.

- (KEDDocumentVerticalGuidance verticalMovementGuidance) DEPRECATED_ATTRIBUTE
readnonatomicassign

Reports guidance for correcting vertical position of a check within a frame.

An enum value indicating whether the user should move the check up or down, or if position is okay.

- (CGRect targetRect) DEPRECATED_ATTRIBUTE
readwritenonatomicassign

Returns the target rectangle.

The target frame is a rectangular area confined within the bounds of the image, and represents the the ideal area that should be covered by a check.

- (KEDCheckSide checkSide) DEPRECATED_ATTRIBUTE
readnonatomicassign

Reports side of the check that was detected.

An enum value indicating which side of the check was detected.


The documentation for this protocol 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.