Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.ken.engines.CheckDetector Class Reference
Inheritance diagram for com.kofax.kmc.ken.engines.CheckDetector:
com.kofax.kmc.ken.engines.ICheckDetector

Public Member Functions

 CheckDetector ()
 
final CheckDetectionResult detect (CheckDetectionSettings settings, Bitmap image)
 
CheckDetectionResult detect (CheckDetectionSettings checkDetectionSettings, byte[] data, int width, int height)
 
void destroy ()
 

Detailed Description

This class provides the main entry point to run Kofax's CheckDetection algorithms against a bitmap image.

Constructor & Destructor Documentation

com.kofax.kmc.ken.engines.CheckDetector.CheckDetector ( )
inline

Default constructor for the CheckDetector class.

Member Function Documentation

void com.kofax.kmc.ken.engines.CheckDetector.destroy ( )
inline

When using the detector directly, it is necessary to call this method to allow for clean-up. Only call this method when you are done with the detector completely, i.e. in your onDestroy method of your Activity

final CheckDetectionResult com.kofax.kmc.ken.engines.CheckDetector.detect ( CheckDetectionSettings  settings,
Bitmap  image 
)
inline

Call this method to run the check detection algorithms. Note: None of the parameter values should be null.

Parameters
settingsAn instance of a CheckDetectionSettings object. CheckSide.None have not been implemented yet and will always return a null CheckDetectionResult when they are passed using setting object.
imageThe bitmap image with which the check detection algorithm will run against. The bitmap must be in landscape orientation with the check in an up-right orientation (MICR in the bottom-left)
Returns
CheckDetectionResult Calling this method will return a CheckDetectResult object that contains the bounds of the check, the side of the check the detector infers the image to be of, the original image, zoom guidance, rotation guidance, horizontal guidance, and vertical guidance. A null result indicates the detector was unable to locate a check within the image.

Implements com.kofax.kmc.ken.engines.ICheckDetector.

CheckDetectionResult com.kofax.kmc.ken.engines.CheckDetector.detect ( CheckDetectionSettings  checkDetectionSettings,
byte[]  data,
int  width,
int  height 
)
inline

Call this method to run the check detection algorithms.

Parameters
checkDetectionSettingsAn instance of a CheckDetectionSettings object. CheckSide.None have not been implemented yet and will always return a null CheckDetectionResult when they are passed using setting object.
dataThe image data with which the check detection algorithm will run against. The image must be in landscape orientation with the check in an up-right orientation (MICR in the bottom-left)
widthThe width of the image
heightThe height of the image
Returns
CheckDetectionResult Calling this method will return a CheckDetectResult object that contains the bounds of the check, the side of the check the detector infers the image to be of, the original image, zoom guidance, rotation guidance, horizontal guidance, and vertical guidance. A null result indicates the detector was unable to locate a check within the image.

Implements com.kofax.kmc.ken.engines.ICheckDetector.


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.