A base class for detection results. More...
#import <kfxKEDDocumentBaseDetectionResult.h>
Instance Methods | |
| (void) | - resetCachedGuidance |
| Resets cached guidance. More... | |
Properties | |
| kfxKEDBoundingTetragon * | bounds |
| The bounding coordinates of the detected check. More... | |
| UIImage * | originalImage |
| The original image that was supplied to the CheckDetectionManager object. More... | |
| KEDDocumentZoomGuidance | zoomGuidance |
| Reports guidance for obtaining the optimal size of a check within the frame. More... | |
| KEDDocumentTurnGuidance | turnGuidance |
| Reports guidance for correcting off-angle rotation for a check. More... | |
| KEDDocumentHorizontalGuidance | horizontalMovementGuidance |
| Reports guidance for correcting horizontal position of a check within a frame. More... | |
| KEDDocumentVerticalGuidance | verticalMovementGuidance |
| Reports guidance for correcting vertical position of a check within a frame. More... | |
| KEDDocumentOrientationGuidance | orientationGuidance |
| Reports guidance for same document orientation with a frame. More... | |
| CGRect | targetRect |
| Returns the target rectangle. More... | |
Detailed Description
A base class for detection results.
Method Documentation
◆ resetCachedGuidance()
| - (void) resetCachedGuidance |
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.
Member Data Documentation
◆ _horizontalMovementGuidance
|
protected |
◆ _orientationGuidance
|
protected |
◆ _turnGuidance
|
protected |
◆ _verticalMovementGuidance
|
protected |
◆ _zoomGuidance
|
protected |
Property Documentation
◆ bounds
|
readnonatomicstrong |
The bounding coordinates of the detected check.
◆ horizontalMovementGuidance
|
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.
◆ orientationGuidance
|
readnonatomicassign |
Reports guidance for same document orientation with a frame.
An enum value indicating whether the user should rotate to match frame orientation or if the orientatoin is okay.
◆ originalImage
|
readnonatomicstrong |
The original image that was supplied to the CheckDetectionManager object.
◆ targetRect
|
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 document.
◆ turnGuidance
|
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.
◆ verticalMovementGuidance
|
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.
◆ zoomGuidance
|
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.
The documentation for this class was generated from the following file: