com.aspose.ocr

Class AsposeOCR

java.lang.Object

com.aspose.ocr.AsposeOCR

public class AsposeOCR
extends Object

Main class for recognize text from images.

Version:

21.10

Author:

Aspose

Constructor Summary

Constructors

Constructor and Description
AsposeOCR() Public constructor.
AsposeOCR(String alphabet) Public constructor.

Method Summary

Modifier and Type	Method and Description
double	CalcSkewImage(BufferedImage image) Calculates the skew angle of an image.
double	CalcSkewImage(String fullPath) Calculates the skew angle of an image.
double	CalcSkewImageFromUri(String uri) Calculates the skew angle of an image provided by URI link.
String	CorrectSpelling(String text, SpellCheckLanguage language) Corrects text (replaces misspelled words).
ArrayList<Rectangle>	getTextAreas(BufferedImage image_, AreasType areasType, boolean isDetectAreas) Detects text areas on image.
ArrayList<Rectangle>	getTextAreas(String fullPath, AreasType areasType, boolean isDetectAreas) Detects text areas on image.
BufferedImage	PreprocessImage(BufferedImage image, PreprocessingFilter filters) Use image preprocessing to improve the accuracy of OCR.
BufferedImage	PreprocessImage(String fullPath, PreprocessingFilter filters) Use image preprocessing to improve the accuracy of OCR.
String	RecognizeLine(BufferedImage image_) Recognizes image that contains single line of text.
String	RecognizeLine(String fullPath) Recognizes image that contains single line of text.
ArrayList<RecognitionResult>	RecognizeMultiplePages(ArrayList<String> files, RecognitionSettings settings) Recognizes multiple images from ArrayList.
ArrayList<RecognitionResult>	RecognizeMultiplePages(String path, RecognitionSettings settings) Recognizes multiple images packed in ZIP archive or from folder.
String	RecognizePage(BufferedImage image) Recognizes text on image.
String	RecognizePage(BufferedImage image_, ArrayList<Rectangle> boxes_) Recognizes text on image.
String	RecognizePage(BufferedImage image, boolean autoSkew) Recognizing image with automatic detection of text areas and ability to disable image skew correction.
RecognitionResult	RecognizePage(BufferedImage image_, RecognitionSettings settings) Recognizes image with the ability to specify
String	RecognizePage(String fullPath) Recognizes text on image.
String	RecognizePage(String fullPath, ArrayList<Rectangle> boxes_) Recognizes text on image.
String	RecognizePage(String fullPath, boolean autoSkew) Recognizing image with automatic detection of text areas and ability to disable image skew correction.
RecognitionResult	RecognizePage(String fullPath, RecognitionSettings settings) Recognizes image with the ability to specify
String	RecognizePageFromUri(String uri) Recognizes text on image provided by URI link.
RecognitionResult	RecognizePageFromUri(String uri, RecognitionSettings settings) Recognizes text on image provided by URI link.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsposeOCR

public AsposeOCR()

Public constructor.

See Also:

AsposeOCR(String)

AsposeOCR

public AsposeOCR(String alphabet)

Public constructor.

Parameters:

alphabet - Narrow alphabet for recognition.

See Also:

AsposeOCR()

Method Detail

CalcSkewImage

public double CalcSkewImage(String fullPath)
                     throws IOException

Calculates the skew angle of an image.

Parameters:

fullPath - Path to image.

Returns:

Skew angle in degrees.

Throws:

IOException - if file not found.

CalcSkewImage

public double CalcSkewImage(BufferedImage image)
                     throws IOException

Calculates the skew angle of an image. Support for GIF, PNG, JPEG, BMP and WBMP.

Parameters:

image - BufferedImage instance.

Returns:

Skew angle in degrees.

Throws:

IOException - if file not found.

CalcSkewImageFromUri

public double CalcSkewImageFromUri(String uri)
                            throws IOException

Calculates the skew angle of an image provided by URI link.

Parameters:

uri - URI link to the image.

Returns:

Skew angle in degrees.

Throws:

IOException - if file not found.

PreprocessImage

public BufferedImage PreprocessImage(String fullPath,
                                     PreprocessingFilter filters)

Use image preprocessing to improve the accuracy of OCR. Create a list of filters that will be applied to the input image in the order you specify. example to create filters: PreprocessingFilter filters = new PreprocessingFilter(); filters.add(PreprocessingFilter.ToGrayscale()); filters.add(PreprocessingFilter.Invert()); filters.add(PreprocessingFilter.Threshold(20));

Parameters:

fullPath - Full path to the image.

filters - Image optimization filters @see PreprocessingFilter

Returns:

BufferedImage with modified image so you can save or recognize it.

PreprocessImage

public BufferedImage PreprocessImage(BufferedImage image,
                                     PreprocessingFilter filters)

Use image preprocessing to improve the accuracy of OCR. Create a list of filters that will be applied to the input image in the order you specify. example to create filters: PreprocessingFilter filters = new PreprocessingFilter(); filters.add(PreprocessingFilter.ToGrayscale()); filters.add(PreprocessingFilter.Invert()); filters.add(PreprocessingFilter.Threshold(20));

Parameters:

image - Source BufferedImage.

filters - Image optimization filters @see PreprocessingFilter

Returns:

BufferedImage with modified image so you can save or recognize it.

RecognizePage

public String RecognizePage(String fullPath)
                     throws IOException

Recognizes text on image. Uses automatic image skew correction and text areas detection. Support for GIF, PNG, JPEG, BMP and WBMP.

Parameters:

fullPath - Path to image.

Returns:

Recognized text.

Throws:

IOException - if file not found.

RecognizePage

public String RecognizePage(String fullPath,
                            boolean autoSkew)
                     throws IOException

Recognizing image with automatic detection of text areas and ability to disable image skew correction. Support for GIF, PNG, JPEG, BMP and WBMP.

Parameters:

fullPath - Path to the image.

autoSkew - Enable automatic image skew correction.

Returns:

Recognized text.

Throws:

IOException - if file not found.

RecognizePage

public String RecognizePage(String fullPath,
                            ArrayList<Rectangle> boxes_)
                     throws IOException

Recognizes text on image. Recognizes image with ability to specify text areas. Support for GIF, PNG, JPEG, BMP and WBMP. Automatic image skew correction is not applied.

Parameters:

fullPath - Path to image.

boxes_ - List of areas to recognize.

Returns:

Recognized text.

Throws:

IOException - if file not found.

RecognizePage

public RecognitionResult RecognizePage(String fullPath,
                                       RecognitionSettings settings)
                                throws IOException

Recognizes image with the ability to specify

Parameters:

fullPath - Path to image.

settings - Recognition settings.

Returns:

RecognitionResult object with image recognition results.

Throws:

IOException - if file not found.

See Also:

Support for GIF, PNG, JPEG, BMP and WBMP., RecognitionResult.RecognitionResult()

RecognizeLine

public String RecognizeLine(String fullPath)
                     throws IOException

Recognizes image that contains single line of text. Automatic image skew correction is not applied. Support for GIF, PNG, JPEG, BMP and WBMP.

Parameters:

fullPath - Path to the image.

Returns:

Recognized text.

Throws:

IOException - if file not found.

RecognizePage

public String RecognizePage(BufferedImage image)
                     throws IOException

Recognizes text on image. Uses automatic image skew correction and text areas detection. Support for GIF, PNG, JPEG, BMP and WBMP.

Parameters:

image - Source BufferedImage.

Returns:

Recognized text.

Throws:

IOException - if file not found.

RecognizePage

public String RecognizePage(BufferedImage image,
                            boolean autoSkew)
                     throws IOException

Recognizing image with automatic detection of text areas and ability to disable image skew correction. Support for GIF, PNG, JPEG, BMP and WBMP.

Parameters:

image - BufferedImage instance.

autoSkew - Enable automatic image skew correction.

Returns:

Recognized text.

Throws:

IOException - if file not found.

RecognizePage

public String RecognizePage(BufferedImage image_,
                            ArrayList<Rectangle> boxes_)
                     throws IOException

Recognizes text on image. Recognizes image with ability to specify text areas. Support for GIF, PNG, JPEG, BMP and WBMP. Automatic image skew correction is not applied.

Parameters:

image_ - BufferedImage instance.

boxes_ - List of areas to recognize.

Returns:

Recognized text.

Throws:

IOException - if file not found.

RecognizePage

public RecognitionResult RecognizePage(BufferedImage image_,
                                       RecognitionSettings settings)
                                throws IOException

Recognizes image with the ability to specify

Parameters:

image_ - BufferedImage instance.

settings - Recognition settings.

Returns:

RecognitionResult object with image recognition results.

Throws:

IOException - if file not found.

See Also:

Support for GIF, PNG, JPEG, BMP and WBMP., RecognitionResult.RecognitionResult()

RecognizeLine

public String RecognizeLine(BufferedImage image_)

Recognizes image that contains single line of text. Automatic image skew correction is not applied. Support for GIF, PNG, JPEG, BMP and WBMP.

Parameters:

image_ - BufferedImage instance.

Returns:

Recognized text.

RecognizeMultiplePages

public ArrayList<RecognitionResult> RecognizeMultiplePages(String path,
                                                           RecognitionSettings settings)
                                                    throws IOException

Recognizes multiple images packed in ZIP archive or from folder. Nested archives and folders are not supported. Max amount of processed images is 20. Support for GIF, PNG, JPEG, BMP and WBMP.

Parameters:

path - Full path to the zip archive (including .zip extension) or to the folder with images.

settings - Recognition settings.

Returns:

Objects with recognition results for each processed image.

Throws:

IOException - if file not found.

See Also:

RecognitionSettings.RecognitionSettings(com.aspose.ocr.DocumentRecognitionSettings)

RecognizeMultiplePages

public ArrayList<RecognitionResult> RecognizeMultiplePages(ArrayList<String> files,
                                                           RecognitionSettings settings)
                                                    throws IOException

Recognizes multiple images from ArrayList. Archives and folders are not supported. Max amount of processed images is 20. Support for GIF, PNG, JPEG, BMP and WBMP.

Parameters:

files - Full paths to the images.

settings - Recognition settings.

Returns:

Objects with recognition results for each processed image.

Throws:

IOException - if file not found.

See Also:

RecognitionSettings.RecognitionSettings(com.aspose.ocr.DocumentRecognitionSettings)

RecognizePageFromUri

public String RecognizePageFromUri(String uri)
                            throws IOException

Recognizes text on image provided by URI link. Uses automatic image skew correction and text areas detection. Supports GIF, PNG, JPEG, BMP, TIFF.

Parameters:

uri - URI link to the image.

Returns:

Recognized text.

Throws:

IOException - uri is incorrect

RecognizePageFromUri

public RecognitionResult RecognizePageFromUri(String uri,
                                              RecognitionSettings settings)
                                       throws IOException

Recognizes text on image provided by URI link. Support for GIF, PNG, JPEG, BMP and WBMP.

Parameters:

uri - URI link to the image.

settings - RecognizeSettings

Returns:

RecognitionResult object.

Throws:

IOException - if file not found.

See Also:

RecognitionSettings.RecognitionSettings(com.aspose.ocr.DocumentRecognitionSettings)

getTextAreas

public ArrayList<Rectangle> getTextAreas(String fullPath,
                                         AreasType areasType,
                                         boolean isDetectAreas)
                                  throws IOException

Detects text areas on image. Automatic image skew correction is not applied.

Parameters:

fullPath - Path to the image.

areasType - Determinate which rectangles to return - line or paragraphs.

isDetectAreas - Enable automatic text areas detection.

Returns:

ArrayList of detected text areas.

Throws:

IOException - if file not found

getTextAreas

public ArrayList<Rectangle> getTextAreas(BufferedImage image_,
                                         AreasType areasType,
                                         boolean isDetectAreas)
                                  throws IOException

Detects text areas on image. Automatic image skew correction is not applied.

Parameters:

image_ - BufferedImage instance.

areasType - Determinate which rectangles to return - line or paragraphs.

isDetectAreas - Enable automatic text areas detection.

Returns:

ArrayList of detected text areas.

Throws:

IOException - if file not found

CorrectSpelling

public String CorrectSpelling(String text,
                              SpellCheckLanguage language)

Corrects text (replaces misspelled words).

Parameters:

text - Text for correction.

language - Dictionary to use SpellCheckLanguage.

Returns:

Text with replaced words.