Kofax Mobile SDK API Reference
Public Member Functions | List of all members
QuickAnalysisFeedback Class Reference

The QuickAnalysisFeedback object contains the results of image quality checking using the doQuickAnalysis method of the ImageProcessor object. This object is serializable. More...

Inheritance diagram for QuickAnalysisFeedback:

Public Member Functions

 QuickAnalysisFeedback ()
 
QuickAnalysisFeedback clone ()
 Performs a field-for-field copy of instances of this class. More...
 
Bitmap getViewBoundariesImage ()
 Returns bitmap with tetragon boundaries drawn on the image. More...
 
boolean isBlurry ()
 Image may be blurry. More...
 
boolean isGlareDetected ()
 Image may have glare. More...
 
boolean isOversaturated ()
 Image may be overly lit image. More...
 
boolean isUndersaturated ()
 Image may be poorly lit image. More...
 
boolean isOverlySkewed ()
 Image may be overly skewed. More...
 
boolean isShadowed ()
 Image may have shadows. More...
 
boolean isMissingBorders ()
 Image may be missing borders. More...
 
boolean isLowContrastBackground ()
 Image may have uneven or low contrast background. More...
 
BoundingTetragon getTetragonCorners ()
 Coordinates of the corners of the tetragon returned after quick analysis. More...
 

Detailed Description

The QuickAnalysisFeedback object contains the results of image quality checking using the doQuickAnalysis method of the ImageProcessor object. This object is serializable.

The QuickAnalysisFeedback object contains the results of image quality checking using the doQuickAnalysis method of the ImageProcessor object.

QuickAnalysisFeedback objects support serialization in a similar way to Image objects. The Image object documentation provides code examples for serialization and deserialization.

Constructor & Destructor Documentation

Member Function Documentation

Performs a field-for-field copy of instances of this class.

BoundingTetragon getTetragonCorners ( )

Coordinates of the corners of the tetragon returned after quick analysis.

Bitmap getViewBoundariesImage ( )

Returns bitmap with tetragon boundaries drawn on the image.

If second parameter of doQuickAnalysis() was set to true, up on callinggetViewBoundariesImage() will return a valid bitmap with green tetragon drawn over it.

Caller of this function is responsible to recycle the resultant bitmap to avoid OutOfMemoryError.

Example of how to recycle bitmap:

QuickAnalysisFeedback qafb = newImage.getImageQuickAnalysisFeedBack();
Bitmap bm = qafb.getViewBoundariesImage();
...
if (null != bm) {
bm.recycle();
}
boolean isBlurry ( )

Image may be blurry.

boolean isGlareDetected ( )

Image may have glare.

boolean isLowContrastBackground ( )

Image may have uneven or low contrast background.

Returns
true if the input image may have uneven or low contrast background (default false).
boolean isMissingBorders ( )

Image may be missing borders.

Returns
true if the input image may be missing borders (default false).
boolean isOverlySkewed ( )

Image may be overly skewed.

Returns
true if the input image may be overly skewed (default false).
boolean isOversaturated ( )

Image may be overly lit image.

The likely cause is that the flash is on, or an extremely bright light sits directly above the location where the image was taken. A dirty lens can also cause some of the same "washout"

Returns
true if the input image may be overly lit (default false).
boolean isShadowed ( )

Image may have shadows.

Returns
true if the input image may have shadows (default false).
boolean isUndersaturated ( )

Image may be poorly lit image.

The likely cause is that the image was taken in a dark room.

Returns
true if the input image may be poorly lit (default false).

The documentation for this class was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.