Inheritance diagram for CheckDetector:
Public Member Functions | |
| CheckDetector () | |
| final CheckDetectionResult | detect (CheckDetectionSettings settings, Bitmap image) |
| CheckDetectionResult | detect (CheckDetectionSettings checkDetectionSettings, byte[] data, int width, int height) |
| void | destroy () |
 Public Member Functions inherited from IDocumentDetector< CheckDetectionSettings, CheckDetectionResult > | |
| U | detect (T settings, Bitmap image) |
| Runs the document detection algorithm. More... | |
| U | detect (T settings, byte[] data, int width, int height) |
| Runs 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 CheckDetection algorithms against a bitmap image.
Constructor & Destructor Documentation
| CheckDetector | ( | ) |
Default constructor for the CheckDetector class.
Member Function Documentation
| void destroy | ( | ) |
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 detect | ( | CheckDetectionSettings | settings, |
| Bitmap | image | ||
| ) |
Call this method to run the check detection algorithms. Note: None of the parameter values should be null.
- Parameters
-
settings An 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. image The 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 ICheckDetector.
| CheckDetectionResult detect | ( | CheckDetectionSettings | checkDetectionSettings, |
| byte[] | data, | ||
| int | width, | ||
| int | height | ||
| ) |
Call this method to run the check detection algorithms.
- Parameters
-
checkDetectionSettings An 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. data The 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) width The width of the image height The 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 ICheckDetector.
The documentation for this class was generated from the following file: