Inheritance diagram for GlareRemover:
Public Member Functions | |
| GlareRemover (Context context) | |
| float | getGlareFraction (Image image) |
| Call this method to get the glare fraction on the image. More... | |
| IGlareResult | removeGlare (ArrayList< Bitmap > imageList) |
| Call this method to get the glare free image. More... | |
| void | destroy () |
| Destroys this object instance and releases resources associated with it. More... | |
Detailed Description
This class provides the main entry point to run Kofax's glare detection and removal algorithm against the passed bitmap images.
Constructor & Destructor Documentation
| GlareRemover | ( | Context | context | ) |
Member Function Documentation
| void destroy | ( | ) |
Destroys this object instance and releases resources associated with it.
Call this method when you are done with this glare removal completely. A destroyed instance should not be used.
| float getGlareFraction | ( | Image | image | ) |
Call this method to get the glare fraction on the image.
None of the parameter values should be null. throws IllegalArgumentException if image is null.
- Parameters
-
image the image object for which the glare fraction is calculated
- Returns
- a float value for glare fraction
| IGlareResult removeGlare | ( | ArrayList< Bitmap > | imageList | ) |
Call this method to get the glare free image.
None of the parameter values should be null.
- Parameters
-
imageList list of images to remove glare in which the first image will be considered as primary image. At present only two images are supported. throws kmcException if images are null or if images list size not equal to 2
- Returns
- a glare result object that contains the glare free image or
nullif the algorithm could not remove glare on the image and an error message if the glare removal fails
The documentation for this class was generated from the following file: