Atalasoft MobileImage API Reference
Public Member Functions | List of all members
DocumentDetector Class Reference
Inheritance diagram for DocumentDetector:

Public Member Functions

 DocumentDetector (Context context)
 
DocumentDetectionResult detect (DocumentDetectionSettings settings, Bitmap image)
 Call this method to run the document detection algorithm. More...
 
DocumentDetectionResult detect (DocumentDetectionSettings settings, byte[] data, int width, int height)
 Call this method to run the document detection algorithm. More...
 
void destroy ()
 Destroys this detector instance and releases resources associated with it. More...
 

Detailed Description

This class provides the main entry point to run Kofax's document detection algorithms against a bitmap image or byte array. Since detection is based on a super-resolution technique, higher accuracy results will be returned after multiple executions.

Constructor & Destructor Documentation

DocumentDetector ( Context  context)

Member Function Documentation

void destroy ( )

Destroys this detector instance and releases resources associated with it.

Call this method when you are done with this detector completely. A destroyed instance should not be used.

DocumentDetectionResult detect ( DocumentDetectionSettings  settings,
Bitmap  image 
)

Call this method to run the document detection algorithm.

None of the parameter values should be null.

Parameters
settingsan instance of a DocumentDetectionSettings object
imagethe bitmap image with which the document detection algorithm will run against
Returns
a detection result that contains the bounds of the document, the original image and the guidance, or null if the algorithm could not detect any document in the image
DocumentDetectionResult detect ( DocumentDetectionSettings  settings,
byte[]  data,
int  width,
int  height 
)

Call this method to run the document detection algorithm.

None of the parameter values should be null.

Parameters
settingsan instance of a DocumentDetectionSettings object
datathe image data with which the document detection algorithm will run against
widththe width of the image
heightthe height of the image
Returns
a detection result that contains the bounds of the document, the original image and the guidance, or null if the algorithm could not detect any document in the image

The documentation for this class was generated from the following file:
Untitled Document © 2017 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.