Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.ken.engines.data.DetectionResult Class Referenceabstract
Inheritance diagram for com.kofax.kmc.ken.engines.data.DetectionResult:
com.kofax.kmc.ken.engines.data.CheckDetectionResult com.kofax.kmc.ken.engines.data.DocumentDetectionResult

Public Member Functions

final BoundingTetragon getBounds ()
 
Bitmap getOriginalImage ()
 
abstract ZoomGuidance getZoomGuidance ()
 
abstract TurnGuidance getTurnGuidance ()
 
abstract HorizontalGuidance getHorizontalMovementGuidance ()
 
abstract VerticalGuidance getVerticalMovementGuidance ()
 
abstract OrientationGuidance getOrientationGuidance ()
 
String toString ()
 

Detailed Description

Base class for result of guided detection driven by target frame.

This class returns the original image the detection algorithm was run against, the bounding coordinates of the detected document, and the guidance information, e.g. zoom out/in move left/right, etc...

Member Function Documentation

final BoundingTetragon com.kofax.kmc.ken.engines.data.DetectionResult.getBounds ( )
inline

Returns the bounding coordinates of the detected document.

Returns
BoundingTetragon containing the points of the polygon containing the detected document.
abstract HorizontalGuidance com.kofax.kmc.ken.engines.data.DetectionResult.getHorizontalMovementGuidance ( )
abstract

Returns the horizontal guidance, e.g. the device should be moved along an x-axis depending on the detection settings values.

Returns
Returns a HorizontalGuidance object.
abstract OrientationGuidance com.kofax.kmc.ken.engines.data.DetectionResult.getOrientationGuidance ( )
abstract

Returns orientation guidance, e.g. the device or the document should be rotated, so the orientation of the document matches the orientation of the target frame.

Returns
orientation guidance
Bitmap com.kofax.kmc.ken.engines.data.DetectionResult.getOriginalImage ( )
inline

Returns the original image that the detector was run against.

Returns
Bitmap representation of the original image.
abstract TurnGuidance com.kofax.kmc.ken.engines.data.DetectionResult.getTurnGuidance ( )
abstract

Returns the TurnGuidance object, e.g. the document in the image is rotated more than 10 degrees off alignment.

Returns
Returns a TurnGuidance object.
abstract VerticalGuidance com.kofax.kmc.ken.engines.data.DetectionResult.getVerticalMovementGuidance ( )
abstract

Returns the vertical guidance, e.g. the device should be moved along a y-axis depending on the detection settings values.

Returns
abstract ZoomGuidance com.kofax.kmc.ken.engines.data.DetectionResult.getZoomGuidance ( )
abstract

Returns the zoom guidance, e.g too close/too far away form the document.

Returns
Returns a ZoomGuidance object.
String com.kofax.kmc.ken.engines.data.DetectionResult.toString ( )
inline

Returns all of the guidance values as a string.

Returns
Returns a String object of the guidance values.

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.