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

Quick Analysis Results Feedback Class. More...

#import <kfxKEDQuickAnalysisFeedback.h>

Inheritance diagram for kfxKEDQuickAnalysisFeedback:

Instance Methods

(id) - init
 Initialize the class instance. More...

Class Methods

(kfxKEDQuickAnalysisFeedback *) + createQuickFromMetadata:
 Parse image metadata, create, and instantiate Quick Analysis Feedback Object. More...


UIImage * quickReviewUIImage
 Quick review image. More...
bool isBlurry
 Image blurry indicator. More...
bool isOverSaturated
 Over-saturated image indicator. More...
bool isUnderSaturated
 Under-saturated image indicator. More...
bool isGlareDetected
 Image glare detection indicator. More...
 Tetragon corner data for the sheet edges found automatically. More...

Detailed Description

Quick Analysis Results Feedback Class.

Framework: libKfxEngines
Import suggestion: #import <kfxLibEngines/kfxEngines.h>
An instance of this class contains the result of an image quick analysis so that you can confirm if the app user took a good picture. If the image is blurry, over or under saturated, you should prompt your app user to retake the image of the target sheet. If it is not blurry and does not have any saturation issues, then the tetragon corners indicate the sheet boundary found in the input image.


This class adopts the NSCoding protocol so that this object may be archived and unarchived using the iOS standard [NSKeyedArchiver archiveRootObject:<object> toFile: archiveFileName]; approach. Using keyed archive files, you can save this object for later use. The library supports backward compatibility, such that as a new version of an app that uses the API in this SDK, includes a newer versions of the SDK libraries that have data model changes, the older archive can still be read by the newer version. However, it is not a design goal to archive and dearchive with forward compatibility, such as decoding an archive on a newer version of the class, using an older library.

Refer to the kfxKEDImage class description, by expanding the class description, that describes how to archive and unarchive objects in this framework that adopt the NSCoding protocol.
You can create keyed archives using NSKeyedArchiver objects and decoded by NSKeyedUnarchiver objects. The framework design uses keyed archives, which differ from sequential archives, in that every value encoded in a keyed archive is given a Kofax unique key name. When you decode an archive, the underlying implementation can use values by name, allowing the unarchive delegate to request values in any order or not at all.
Please refer to the Apple documentation for more information:

Keyed Archiving*

Keyed Unarchiving*

Method Documentation

+ (kfxKEDQuickAnalysisFeedback *) createQuickFromMetadata: (NSString *)  metadata

Parse image metadata, create, and instantiate Quick Analysis Feedback Object.

Given an NSString containing the Quick Analysis metadata, this class method parses the data. It then creates the Quick Analysis Feeback object and initializes the object properties with the parsed image information from the metadata.

kfxKEDQuickAnalysisFeedback* quickAnalysisResult = [kfxKEDQuickAnalysisFeedback createQuickFromMetadata: metaData];
- (id) init

Initialize the class instance.

Use this method in your typical [[class alloc] init]; code lines to initialize an instance of this class with the standard defaults.

Property Documentation

- (bool) isBlurry

Image blurry indicator.

The image processor sets this to true if the input image is blurry. Default: false;

- (bool) isGlareDetected

Image glare detection indicator.

The image processor sets this to true if the input image has been detected with glare. Default: false;

- (bool) isOverSaturated

Over-saturated image indicator.

The image processor sets this to true if it detects that the input image is over saturated. Default: false;

- (bool) isUnderSaturated

Under-saturated image indicator.

The image processor sets this to true if it detects that the input image is undersaturated. Default: false;

- (UIImage*) quickReviewUIImage

Quick review image.

The image processor generates this native image object if the quick analysis completed without error. This image includes a green border surrounding what the libary thinks constitutes the boundary of the target sheet of interest in the larger image.
Your app could obtain this image, and display it for review in order to confirm that the image is correct for further use. Default: nil

- (kfxKEDBoundingTetragon*) tetragonCorners

Tetragon corner data for the sheet edges found automatically.

The image processor indicates the corners of the sheet found in the input image, if a valid sheet was detected. You can then edit and crop the same image with these coordinates using a basic settings profile initialized with these same coordinates. Default: an initialized object.

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.