AsposeOCR

Inheritance: java.lang.Object

public class AsposeOCR

Main class for recognize text from images.

Constructors

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

Methods

Method	Description
CalcSkewImage(String fullPath)	Calculates the skew angle of an image.
CalcSkewImage(BufferedImage image)	Calculates the skew angle of an image.
CalcSkewImageFromUri(String uri)	Calculates the skew angle of an image provided by URI link.
PreprocessImage(String fullPath, PreprocessingFilter filters)	Use image preprocessing to improve the accuracy of OCR.
PreprocessImage(BufferedImage image, PreprocessingFilter filters)	Use image preprocessing to improve the accuracy of OCR.
RecognizeTiff(String fullPath, DocumentRecognitionSettings settings)	Recognize text on TIFF encoded images with image skew correction and text areas detection enable in setting by default.
RecognizePdf(String fullPath, DocumentRecognitionSettings settings)	Recognize text from scanned PDF (extract images).
RecognizePageFast(String fullPath)	Recognizes text on good quality image.
RecognizePage(String fullPath)	Recognizes text on image.
RecognizePage(String fullPath, boolean autoSkew)	Recognizing image with automatic detection of text areas and ability to disable image skew correction.
RecognizePage(String fullPath, ArrayList boxes_)	Recognizes text on image.
RecognizePage(String fullPath, RecognitionSettings settings)	Recognizes image with the ability to specify
RecognizeReceipt(String fullPath, ReceiptRecognitionSettings settings)	Recognizes receipt with the ability to specify
RecognizeInvoice(String fullPath, InvoiceRecognitionSettings settings)	Recognizes text on invoice image with the ability to specify
RecognizeIDCard(String fullPath, IDCardRecognitionSettings settings)	Recognizes ID Card with the ability to specify
RecognizeCarPlate(String fullPath, CarPlateRecognitionSettings settings)	Recognizes car plate with the ability to specify
RecognizePassport(String fullPath, PassportRecognitionSettings settings)	Recognizes passport with the ability to specify
RecognizeLine(String fullPath)	Recognizes image that contains single line of text.
RecognizePage(BufferedImage image)	Recognizes text on image.
RecognizePage(BufferedImage image, boolean autoSkew)	Recognizing image with automatic detection of text areas and ability to disable image skew correction.
RecognizePage(BufferedImage image_, ArrayList boxes_)	Recognizes text on image.
RecognizePage(BufferedImage image_, RecognitionSettings settings)	Recognizes image with the ability to specify
RecognizeCarPlate(BufferedImage image_, CarPlateRecognitionSettings settings)	Recognizes car plate with the ability to specify
RecognizeIDCard(BufferedImage image_, IDCardRecognitionSettings settings)	Recognizes ID Card with the ability to specify
RecognizeInvoice(BufferedImage image_, InvoiceRecognitionSettings settings)	Recognizes invoice with the ability to specify
RecognizePassport(BufferedImage image_, PassportRecognitionSettings settings)	Recognizes Passport with the ability to specify
RecognizeReceipt(BufferedImage image_, ReceiptRecognitionSettings settings)	Recognizes receipt with the ability to specify
RecognizeTiff(InputStream stream, DocumentRecognitionSettings settings)	Recognize text on TIFF encoded images with image skew correction and text areas detection enable in setting by default.
RecognizePdf(InputStream stream, DocumentRecognitionSettings settings)	Recognize text from scanned PDF (extract images).
RecognizeLine(BufferedImage image_)	Recognizes image that contains single line of text.
RecognizeMultiplePages(String path, RecognitionSettings settings)	Recognizes multiple images packed in ZIP archive or from folder.
RecognizeMultiplePages(ArrayList files, RecognitionSettings settings)	Recognizes multiple images from ArrayList.
RecognizePageFromUri(String uri)	Recognizes text on image provided by URI link.
RecognizePageFromUri(String uri, RecognitionSettings settings)	Recognizes text on image provided by URI link.
RecognizePage(int[] pixels, int width, int height, int bitsPerPixel, RecognitionSettings settings)	Recognizes image with the ability to specify
ImageHasText(String fullPath, String text, RecognitionSettings settings, boolean ignoreCase)	Check if the image contains the provided text fragment.
ImageHasText(String fullPath, String text, RecognitionSettings settings)	Check if the image contains the provided text fragment with a case-insensitive search.
ImageHasText(String fullPath, String text)	Check if the image contains the provided text fragment with a case-insensitive search.
ImageHasText(String fullPath, Pattern regex, RecognitionSettings settings)	Check if the image text matches the provided regular expression.
ImageHasText(String fullPath, Pattern regex)	Check if the image text matches the provided regular expression.
CompareImageTexts(String fullPath1, String fullPath2, RecognitionSettings settings, boolean ignoreCase)	Check if two images contain the same text.
CompareImageTexts(String fullPath1, String fullPath2, RecognitionSettings settings)	Check if two images contain the same text.
CompareImageTexts(String fullPath1, String fullPath2)	Check if two images contain the same text.
ImageTextDiff(String fullPath1, String fullPath2, RecognitionSettings settings, boolean ignoreCase)	Compare the texts on the two images and return a number representing how similar they are (0 to 1).
ImageTextDiff(String fullPath1, String fullPath2, RecognitionSettings settings)	Compare the texts on the two images and return a number representing how similar they are (0 to 1).
ImageTextDiff(String fullPath1, String fullPath2)	Compare the texts on the two images and return a number representing how similar they are (0 to 1).
getTextAreas(String fullPath, AreasType areasType, boolean isDetectAreas)	Detects text areas on image.
getTextAreas(BufferedImage image_, AreasType areasType, boolean isDetectAreas)	Detects text areas on image.
SaveMultipageDocument(String fullFileName, Format saveFormat, ArrayList results)	Allows to get multipage document from list of RecognitionResult objects.
SaveMultipageDocument(String fullFileName, Format saveFormat, ArrayList results, SpellCheck.SpellCheckLanguage language)	Allows to get multipage document from list of RecognitionResult objects with spell-check correction.
CorrectSpelling(String text, SpellCheck.SpellCheckLanguage language)	Corrects text (replaces misspelled words).
CorrectSpelling(String text, SpellCheck.SpellCheckLanguage language, String dictionaryPath)	Corrects text (replaces misspelled words).
Recognize(OcrInput input, RecognitionSettings settings)	Recognizes image with the ability to specify Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.
RecognizeFast(OcrInput input)	Recognizes text on good quality image.
RecognizeReceipt(OcrInput input, ReceiptRecognitionSettings settings)	Recognizes receipts with the ability to specify Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.
RecognizeInvoice(OcrInput input, InvoiceRecognitionSettings settings)	Recognizes invoice with the ability to specify Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.
RecognizeIDCard(OcrInput input, IDCardRecognitionSettings settings)	Recognizes ID card with the ability to specify Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.
RecognizeCarPlate(OcrInput input, CarPlateRecognitionSettings settings)	Recognizes car plate with the ability to specify Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.
RecognizePassport(OcrInput input, PassportRecognitionSettings settings)	Recognizes passport with the ability to specify.
CalculateSkew(OcrInput input)	Calculates the skew angles of an images.
DetectRectangles(OcrInput input, AreasType areasType, boolean isDetectAreas)	Detects text areas on images.
RecognizeCharacters(OcrInput input, DetectAreasMode detectAreasMode, Language language)	Detects symbols on images.
RecognizeCharacters(OcrInput input)	Detects symbols on images.

AsposeOCR()

public AsposeOCR()

Public constructor.

AsposeOCR(String alphabet)

public AsposeOCR(String alphabet)

Public constructor.

Parameters:

Parameter	Type	Description
alphabet	java.lang.String	Narrow alphabet for recognition.

CalcSkewImage(String fullPath)

public double CalcSkewImage(String fullPath)

Calculates the skew angle of an image.

//* @param fullPath Path to image.

Parameters:

Parameter	Type	Description
fullPath	java.lang.String

Returns: double - Skew angle in degrees.

CalcSkewImage(BufferedImage image)

public double CalcSkewImage(BufferedImage image)

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

Parameters:

Parameter	Type	Description
image	java.awt.image.BufferedImage	BufferedImage instance.

Returns: double - Skew angle in degrees.

CalcSkewImageFromUri(String uri)

public double CalcSkewImageFromUri(String uri)

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

Parameters:

Parameter	Type	Description
uri	java.lang.String	URI link to the image.

Returns: double - Skew angle in degrees.

PreprocessImage(String fullPath, PreprocessingFilter filters)

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:

Parameter	Type	Description
fullPath	java.lang.String	Full path to the image.
filters	PreprocessingFilter	Image optimization filters @see PreprocessingFilter

Returns: java.awt.image.BufferedImage - BufferedImage with modified image so you can save or recognize it.

PreprocessImage(BufferedImage image, PreprocessingFilter filters)

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:

Parameter	Type	Description
image	java.awt.image.BufferedImage	Source BufferedImage.
filters	PreprocessingFilter	Image optimization filters @see PreprocessingFilter

Returns: java.awt.image.BufferedImage - BufferedImage with modified image so you can save or recognize it.

RecognizeTiff(String fullPath, DocumentRecognitionSettings settings)

public ArrayList<RecognitionResult> RecognizeTiff(String fullPath, DocumentRecognitionSettings settings)

Recognize text on TIFF encoded images with image skew correction and text areas detection enable in setting by default.

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	fullPath Path to TIFF image.
settings	DocumentRecognitionSettings	Recognition settings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - Recognized text.

RecognizePdf(String fullPath, DocumentRecognitionSettings settings)

public ArrayList<RecognitionResult> RecognizePdf(String fullPath, DocumentRecognitionSettings settings)

Recognize text from scanned PDF (extract images).

Recognizes pdf file with the ability to specify @see DocumentRecognitionSettings. Supports Scanned PDF only. Doesn’t supports Searchable PDF.

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Full path to the image.
settings	DocumentRecognitionSettings	Recognition settings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - The ArrayList of @see #RecognitionResult objects with image recognition results.

RecognizePageFast(String fullPath)

public String RecognizePageFast(String fullPath)

Recognizes text on good quality image. Doesn’t use automatic image skew correction and text areas detection. Support for GIF, PNG, JPEG, BMP, JFIF and WBMP.

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to image.

Returns: java.lang.String - Recognized text.

RecognizePage(String fullPath)

public String RecognizePage(String fullPath)

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

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to image.

Returns: java.lang.String - Recognized text.

RecognizePage(String fullPath, boolean autoSkew)

public String RecognizePage(String fullPath, boolean autoSkew)

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

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the image.
autoSkew	boolean	Enable automatic image skew correction.

Returns: java.lang.String - Recognized text.

RecognizePage(String fullPath, ArrayList boxes_)

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

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

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to image.
boxes_	java.util.ArrayList<java.awt.Rectangle>	List of areas to recognize.

Returns: java.lang.String - Recognized text.

RecognizePage(String fullPath, RecognitionSettings settings)

public RecognitionResult RecognizePage(String fullPath, RecognitionSettings settings)

Recognizes image with the ability to specify

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to image.
settings	RecognitionSettings	Recognition settings.

Returns: RecognitionResult - RecognitionResult object with image recognition results.

RecognizeReceipt(String fullPath, ReceiptRecognitionSettings settings)

public RecognitionResult RecognizeReceipt(String fullPath, ReceiptRecognitionSettings settings)

Recognizes receipt with the ability to specify

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the receipt.
settings	ReceiptRecognitionSettings	Receipt recognition settings.

Returns: RecognitionResult - RecognitionResult object with image recognition results.

RecognizeInvoice(String fullPath, InvoiceRecognitionSettings settings)

public RecognitionResult RecognizeInvoice(String fullPath, InvoiceRecognitionSettings settings)

Recognizes text on invoice image with the ability to specify

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the invoice.
settings	InvoiceRecognitionSettings	Invoice recognition settings.

Returns: RecognitionResult - RecognitionResult object with invoice recognition results.

RecognizeIDCard(String fullPath, IDCardRecognitionSettings settings)

public RecognitionResult RecognizeIDCard(String fullPath, IDCardRecognitionSettings settings)

Recognizes ID Card with the ability to specify

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the ID Card.
settings	IDCardRecognitionSettings	ID Card recognition settings.

Returns: RecognitionResult - RecognitionResult object with ID Card recognition results.

RecognizeCarPlate(String fullPath, CarPlateRecognitionSettings settings)

public RecognitionResult RecognizeCarPlate(String fullPath, CarPlateRecognitionSettings settings)

Recognizes car plate with the ability to specify

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the car number image.
settings	CarPlateRecognitionSettings	Car plate recognition settings.

Returns: RecognitionResult - RecognitionResult object with car number recognition results.

RecognizePassport(String fullPath, PassportRecognitionSettings settings)

public RecognitionResult RecognizePassport(String fullPath, PassportRecognitionSettings settings)

Recognizes passport with the ability to specify

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the passport image.
settings	PassportRecognitionSettings	Passport recognition settings.

Returns: RecognitionResult - RecognitionResult object with passport recognition results.

RecognizeLine(String fullPath)

public String RecognizeLine(String fullPath)

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

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the image.

Returns: java.lang.String - Recognized text.

RecognizePage(BufferedImage image)

public String RecognizePage(BufferedImage image)

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

Parameters:

Parameter	Type	Description
image	java.awt.image.BufferedImage	Source BufferedImage.

Returns: java.lang.String - Recognized text.

RecognizePage(BufferedImage image, boolean autoSkew)

public String RecognizePage(BufferedImage image, boolean autoSkew)

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

Parameters:

Parameter	Type	Description
image	java.awt.image.BufferedImage	BufferedImage instance.
autoSkew	boolean	Enable automatic image skew correction.

Returns: java.lang.String - Recognized text.

RecognizePage(BufferedImage image_, ArrayList boxes_)

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

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

Parameters:

Parameter	Type	Description
image_	java.awt.image.BufferedImage	BufferedImage instance.
boxes_	java.util.ArrayList<java.awt.Rectangle>	List of areas to recognize.

Returns: java.lang.String - Recognized text.

RecognizePage(BufferedImage image_, RecognitionSettings settings)

public RecognitionResult RecognizePage(BufferedImage image_, RecognitionSettings settings)

Recognizes image with the ability to specify

Parameters:

Parameter	Type	Description
image_	java.awt.image.BufferedImage	BufferedImage instance.
settings	RecognitionSettings	Recognition settings.

Returns: RecognitionResult - RecognitionResult object with image recognition results.

RecognizeCarPlate(BufferedImage image_, CarPlateRecognitionSettings settings)

public RecognitionResult RecognizeCarPlate(BufferedImage image_, CarPlateRecognitionSettings settings)

Recognizes car plate with the ability to specify

Parameters:

Parameter	Type	Description
image_	java.awt.image.BufferedImage	BufferedImage instance.
settings	CarPlateRecognitionSettings	Car plate recognition settings.

Returns: RecognitionResult - RecognitionResult object with car plate recognition results.

RecognizeIDCard(BufferedImage image_, IDCardRecognitionSettings settings)

public RecognitionResult RecognizeIDCard(BufferedImage image_, IDCardRecognitionSettings settings)

Recognizes ID Card with the ability to specify

Parameters:

Parameter	Type	Description
image_	java.awt.image.BufferedImage	BufferedImage instance.
settings	IDCardRecognitionSettings	ID Card recognition settings.

Returns: RecognitionResult - RecognitionResult object with ID Card recognition results.

RecognizeInvoice(BufferedImage image_, InvoiceRecognitionSettings settings)

public RecognitionResult RecognizeInvoice(BufferedImage image_, InvoiceRecognitionSettings settings)

Recognizes invoice with the ability to specify

Parameters:

Parameter	Type	Description
image_	java.awt.image.BufferedImage	BufferedImage instance.
settings	InvoiceRecognitionSettings	Invoice recognition settings.

Returns: RecognitionResult - RecognitionResult object with invoice recognition results.

RecognizePassport(BufferedImage image_, PassportRecognitionSettings settings)

public RecognitionResult RecognizePassport(BufferedImage image_, PassportRecognitionSettings settings)

Recognizes Passport with the ability to specify

Parameters:

Parameter	Type	Description
image_	java.awt.image.BufferedImage	BufferedImage instance.
settings	PassportRecognitionSettings	passport recognition settings.

Returns: RecognitionResult - RecognitionResult object with passport recognition results.

RecognizeReceipt(BufferedImage image_, ReceiptRecognitionSettings settings)

public RecognitionResult RecognizeReceipt(BufferedImage image_, ReceiptRecognitionSettings settings)

Recognizes receipt with the ability to specify

Parameters:

Parameter	Type	Description
image_	java.awt.image.BufferedImage	BufferedImage instance.
settings	ReceiptRecognitionSettings	Receipt recognition settings.

Returns: RecognitionResult - RecognitionResult object with image recognition results.

RecognizeTiff(InputStream stream, DocumentRecognitionSettings settings)

public ArrayList<RecognitionResult> RecognizeTiff(InputStream stream, DocumentRecognitionSettings settings)

Recognize text on TIFF encoded images with image skew correction and text areas detection enable in setting by default.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	InputStream with TIFF image.
settings	DocumentRecognitionSettings	Recognition settings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - Recognized text.

RecognizePdf(InputStream stream, DocumentRecognitionSettings settings)

public ArrayList<RecognitionResult> RecognizePdf(InputStream stream, DocumentRecognitionSettings settings)

Recognize text from scanned PDF (extract images).

Recognizes pdf file with the ability to specify @see DocumentRecognitionSettings. Supports Scanned PDF only. Doesn’t supports Searchable PDF.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	InputStream with the scanned PDF file.
settings	DocumentRecognitionSettings	Recognition settings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - The ArrayList of @see #RecognitionResult objects with image recognition results.

RecognizeLine(BufferedImage image_)

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:

Parameter	Type	Description
image_	java.awt.image.BufferedImage	BufferedImage instance.

Returns: java.lang.String - Recognized text.

RecognizeMultiplePages(String path, RecognitionSettings settings)

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

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:

Parameter	Type	Description
path	java.lang.String	Full path to the zip archive (including .zip extension) or to the folder with images.
settings	RecognitionSettings	Recognition settings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - Objects with recognition results for each processed image.

RecognizeMultiplePages(ArrayList files, RecognitionSettings settings)

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

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

Parameters:

Parameter	Type	Description
files	java.util.ArrayList<java.lang.String>	Full paths to the images.
settings	RecognitionSettings	Recognition settings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - Objects with recognition results for each processed image.

RecognizePageFromUri(String uri)

public String RecognizePageFromUri(String uri)

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

Parameters:

Parameter	Type	Description
uri	java.lang.String	URI link to the image.

Returns: java.lang.String - Recognized text.

RecognizePageFromUri(String uri, RecognitionSettings settings)

public RecognitionResult RecognizePageFromUri(String uri, RecognitionSettings settings)

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

Parameters:

Parameter	Type	Description
uri	java.lang.String	URI link to the image.
settings	RecognitionSettings	RecognizeSettings

Returns: RecognitionResult - RecognitionResult object.

RecognizePage(int[] pixels, int width, int height, int bitsPerPixel, RecognitionSettings settings)

public RecognitionResult RecognizePage(int[] pixels, int width, int height, int bitsPerPixel, RecognitionSettings settings)

Recognizes image with the ability to specify

Parameters:

Parameter	Type	Description
pixels	int[]	The pixels are represented as 32-bit integer values (rgb).
width	int	width of the original image.
height	int	height of the original image.
bitsPerPixel	int	Supports 1-32 bits.
settings	RecognitionSettings	Recognition settings.

Returns: RecognitionResult - RecognitionResult object with image recognition results.

ImageHasText(String fullPath, String text, RecognitionSettings settings, boolean ignoreCase)

public boolean ImageHasText(String fullPath, String text, RecognitionSettings settings, boolean ignoreCase)

Check if the image contains the provided text fragment.

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the image.
text	java.lang.String	Text fragment for searching on the image.
settings	RecognitionSettings	Recognition settings.
ignoreCase	boolean	True - means a case-insensitive search.

Returns: boolean - True if image contains text fragment. False - image doesn’t contains text fragment.

ImageHasText(String fullPath, String text, RecognitionSettings settings)

public boolean ImageHasText(String fullPath, String text, RecognitionSettings settings)

Check if the image contains the provided text fragment with a case-insensitive search.

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the image.
text	java.lang.String	Text fragment for searching on the image.
settings	RecognitionSettings	Recognition settings.

Returns: boolean - True if image contains text fragment. False - image doesn’t contains text fragment.

ImageHasText(String fullPath, String text)

public boolean ImageHasText(String fullPath, String text)

Check if the image contains the provided text fragment with a case-insensitive search.

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the image.
text	java.lang.String	Text fragment for searching on the image.

Returns: boolean - True if image contains text fragment. False - image doesn’t contains text fragment.

ImageHasText(String fullPath, Pattern regex, RecognitionSettings settings)

public boolean ImageHasText(String fullPath, Pattern regex, RecognitionSettings settings)

Check if the image text matches the provided regular expression.

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the image.
regex	java.util.regex.Pattern	java.util.regex.Pattern object with the provided pattern and options.
settings	RecognitionSettings	Recognition settings.

Returns: boolean - True if image text matches the provided regular expression.

ImageHasText(String fullPath, Pattern regex)

public boolean ImageHasText(String fullPath, Pattern regex)

Check if the image text matches the provided regular expression.

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the image.
regex	java.util.regex.Pattern	java.util.regex.Pattern object with the provided pattern and options.

Returns: boolean - True if image text matches the provided regular expression.

CompareImageTexts(String fullPath1, String fullPath2, RecognitionSettings settings, boolean ignoreCase)

public boolean CompareImageTexts(String fullPath1, String fullPath2, RecognitionSettings settings, boolean ignoreCase)

Check if two images contain the same text.

Parameters:

Parameter	Type	Description
fullPath1	java.lang.String	Path to the first image.
fullPath2	java.lang.String	Path to the second image.
settings	RecognitionSettings	Recognition settings.
ignoreCase	boolean	True - means a case-insensitive search.

Returns: boolean - True if images have the same text (90% similarity).

CompareImageTexts(String fullPath1, String fullPath2, RecognitionSettings settings)

public boolean CompareImageTexts(String fullPath1, String fullPath2, RecognitionSettings settings)

Check if two images contain the same text.

Parameters:

Parameter	Type	Description
fullPath1	java.lang.String	Path to the first image.
fullPath2	java.lang.String	Path to the second image.
settings	RecognitionSettings	Recognition settings.

Returns: boolean - True if images have the same text (90% similarity).

CompareImageTexts(String fullPath1, String fullPath2)

public boolean CompareImageTexts(String fullPath1, String fullPath2)

Check if two images contain the same text.

Parameters:

Parameter	Type	Description
fullPath1	java.lang.String	Path to the first image.
fullPath2	java.lang.String	Path to the second image.

Returns: boolean - True if images have the same text (90% similarity).

ImageTextDiff(String fullPath1, String fullPath2, RecognitionSettings settings, boolean ignoreCase)

public float ImageTextDiff(String fullPath1, String fullPath2, RecognitionSettings settings, boolean ignoreCase)

Compare the texts on the two images and return a number representing how similar they are (0 to 1).

Parameters:

Parameter	Type	Description
fullPath1	java.lang.String	Path to the first image.
fullPath2	java.lang.String	Path to the second image.
settings	RecognitionSettings	Recognition settings.
ignoreCase	boolean	True - means a case-insensitive search.

Returns: float - 0 means that the texts are completely different; 1 means the texts are identical.

ImageTextDiff(String fullPath1, String fullPath2, RecognitionSettings settings)

public float ImageTextDiff(String fullPath1, String fullPath2, RecognitionSettings settings)

Compare the texts on the two images and return a number representing how similar they are (0 to 1).

Parameters:

Parameter	Type	Description
fullPath1	java.lang.String	Path to the first image.
fullPath2	java.lang.String	Path to the second image.
settings	RecognitionSettings	Recognition settings.

Returns: float - 0 means that the texts are completely different; 1 means the texts are identical.

ImageTextDiff(String fullPath1, String fullPath2)

public float ImageTextDiff(String fullPath1, String fullPath2)

Compare the texts on the two images and return a number representing how similar they are (0 to 1).

Parameters:

Parameter	Type	Description
fullPath1	java.lang.String	Path to the first image.
fullPath2	java.lang.String	Path to the second image.

Returns: float - 0 means that the texts are completely different; 1 means the texts are identical.

getTextAreas(String fullPath, AreasType areasType, boolean isDetectAreas)

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

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

Parameters:

Parameter	Type	Description
fullPath	java.lang.String	Path to the image.
areasType	AreasType	Determinate which rectangles to return - line or paragraphs.
isDetectAreas	boolean	Enable automatic text areas detection.

Returns: java.util.ArrayList<java.awt.Rectangle> - ArrayList of detected text areas.

getTextAreas(BufferedImage image_, AreasType areasType, boolean isDetectAreas)

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

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

Parameters:

Parameter	Type	Description
image_	java.awt.image.BufferedImage	BufferedImage instance.
areasType	AreasType	Determinate which rectangles to return - line or paragraphs.
isDetectAreas	boolean	Enable automatic text areas detection.

Returns: java.util.ArrayList<java.awt.Rectangle> - ArrayList of detected text areas.

SaveMultipageDocument(String fullFileName, Format saveFormat, ArrayList results)

public static void SaveMultipageDocument(String fullFileName, Format saveFormat, ArrayList<RecognitionResult> results)

Allows to get multipage document from list of RecognitionResult objects.

Parameters:

Parameter	Type	Description
fullFileName	java.lang.String	Filename with a path for saving recognition result in the selected format.
saveFormat	Format	Document format (Docx, Txt, Pdf, Xlsx, Xml, Json).
results	java.util.ArrayList<com.aspose.ocr.RecognitionResult>	List of RecognitionResult. objects.

SaveMultipageDocument(String fullFileName, Format saveFormat, ArrayList results, SpellCheck.SpellCheckLanguage language)

public static void SaveMultipageDocument(String fullFileName, Format saveFormat, ArrayList<RecognitionResult> results, SpellCheck.SpellCheckLanguage language)

Allows to get multipage document from list of RecognitionResult objects with spell-check correction.

Parameters:

Parameter	Type	Description
fullFileName	java.lang.String	Filename with a path for saving recognition result in the selected format.
saveFormat	Format	Document format (Docx, Txt, Pdf, Xlsx, Xml, Json).
results	java.util.ArrayList<com.aspose.ocr.RecognitionResult>	List of RecognitionResult. objects.
language	SpellCheckLanguage

CorrectSpelling(String text, SpellCheck.SpellCheckLanguage language)

public String CorrectSpelling(String text, SpellCheck.SpellCheckLanguage language)

Corrects text (replaces misspelled words).

Parameters:

Parameter	Type	Description
text	java.lang.String	Text for correction.
language	SpellCheckLanguage	Dictionary to use SpellCheckLanguage.

Returns: java.lang.String - Text with replaced words.

CorrectSpelling(String text, SpellCheck.SpellCheckLanguage language, String dictionaryPath)

public String CorrectSpelling(String text, SpellCheck.SpellCheckLanguage language, String dictionaryPath)

Corrects text (replaces misspelled words).

Parameters:

Parameter	Type	Description
text	java.lang.String	Text for correction.
language	SpellCheckLanguage	Dictionary to use SpellCheckLanguage.
dictionaryPath	java.lang.String	Full path to the user dictionary (frequency dictionary). Dictionary file format: Plain text file in UTF-8 encoding. Word and Word Frequency are separated by comma, the word is expected in the first column and the frequency in the second column. Every word-frequency-pair in a separate line.A line is defined as a sequence of characters followed by a line feed ("\n"), a carriage return ("\r"), or a carriage return immediately followed by a line feed("\r\n"). Every word is expected to be in lower case.

Returns: java.lang.String - Text with replaced words.

Recognize(OcrInput input, RecognitionSettings settings)

public ArrayList<RecognitionResult> Recognize(OcrInput input, RecognitionSettings settings)

Recognizes image with the ability to specify Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	OcrInput. instance.
settings	RecognitionSettings	RecognitionSettings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - RecognitionResult list with images recognition results RecognitionResult

RecognizeFast(OcrInput input)

public ArrayList<String> RecognizeFast(OcrInput input)

Recognizes text on good quality image. Doesn’t use automatic image skew correction and text areas detection. Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	OcrInput instance.

Returns: java.util.ArrayList<java.lang.String> - ArrayList with recognized text.

RecognizeReceipt(OcrInput input, ReceiptRecognitionSettings settings)

public ArrayList<RecognitionResult> RecognizeReceipt(OcrInput input, ReceiptRecognitionSettings settings)

Recognizes receipts with the ability to specify Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	OcrInput. instance.
settings	ReceiptRecognitionSettings	ReceiptRecognitionSettings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - RecognitionResult list with images recognition results RecognitionResult

RecognizeInvoice(OcrInput input, InvoiceRecognitionSettings settings)

public ArrayList<RecognitionResult> RecognizeInvoice(OcrInput input, InvoiceRecognitionSettings settings)

Recognizes invoice with the ability to specify Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	OcrInput. instance.
settings	InvoiceRecognitionSettings	InvoiceRecognitionSettings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - RecognitionResult list with images recognition results RecognitionResult

RecognizeIDCard(OcrInput input, IDCardRecognitionSettings settings)

public ArrayList<RecognitionResult> RecognizeIDCard(OcrInput input, IDCardRecognitionSettings settings)

Recognizes ID card with the ability to specify Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	OcrInput. instance.
settings	IDCardRecognitionSettings	IDCardRecognitionSettings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - RecognitionResult list with images recognition results RecognitionResult

RecognizeCarPlate(OcrInput input, CarPlateRecognitionSettings settings)

public ArrayList<RecognitionResult> RecognizeCarPlate(OcrInput input, CarPlateRecognitionSettings settings)

Recognizes car plate with the ability to specify Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	OcrInput. instance.
settings	CarPlateRecognitionSettings	CarPlateRecognitionSettings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - RecognitionResult list with images recognition results RecognitionResult

RecognizePassport(OcrInput input, PassportRecognitionSettings settings)

public ArrayList<RecognitionResult> RecognizePassport(OcrInput input, PassportRecognitionSettings settings)

Recognizes passport with the ability to specify. Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	OcrInput. instance.
settings	PassportRecognitionSettings	PassportRecognitionSettings.

Returns: java.util.ArrayList<com.aspose.ocr.RecognitionResult> - RecognitionResult list with images recognition results RecognitionResult

CalculateSkew(OcrInput input)

public ArrayList<SkewOutput> CalculateSkew(OcrInput input)

Calculates the skew angles of an images. Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	The container with sources.OcrInput

Returns: java.util.ArrayList<com.aspose.ocr.SkewOutput> - ArrayList of skew angles in degrees SkewOutput

DetectRectangles(OcrInput input, AreasType areasType, boolean isDetectAreas)

public ArrayList<RectangleOutput> DetectRectangles(OcrInput input, AreasType areasType, boolean isDetectAreas)

Detects text areas on images. Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	The container with sources.OcrInput
areasType	AreasType	Determinates wich rectangles to return - line or paragraphs.
isDetectAreas	boolean	Enable automatic text areas detection.

Returns: java.util.ArrayList<com.aspose.ocr.RectangleOutput> - ArrayList of RectangleOutput with detected text areas or lines.

RecognizeCharacters(OcrInput input, DetectAreasMode detectAreasMode, Language language)

public ArrayList<CharacterRecognitionResult> RecognizeCharacters(OcrInput input, DetectAreasMode detectAreasMode, Language language)

Detects symbols on images. Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	The container with sources.OcrInput
detectAreasMode	DetectAreasMode	Determines the type of neural network used for areas detection.
language	Language	Language used for OCR.

Returns: java.util.ArrayList<com.aspose.ocr.CharacterRecognitionResult> - ArrayList of Character with detected symbols data.

RecognizeCharacters(OcrInput input)

public ArrayList<CharacterRecognitionResult> RecognizeCharacters(OcrInput input)

Detects symbols on images. Supports GIF, PNG, JPEG, WBMP, TIFF, JFIF, TIFF, PDF, InputStream, BufferedImage, folder, array, zip archive, URL, base64.

Parameters:

Parameter	Type	Description
input	OcrInput	The container with sources.OcrInput

Returns: java.util.ArrayList<com.aspose.ocr.CharacterRecognitionResult> - ArrayList of Character with detected symbols data for each image.