com.aspose.ocr

Class RecognitionSettings

java.lang.Object

com.aspose.ocr.RecognitionSettings

public class RecognitionSettings
extends Object

Settings for the image recognition. Contains elements that allow customizing the recognition process.

Constructor Summary

Constructors

Constructor and Description
RecognitionSettings() Default constructor: set recognitionAreas null, linesFiltration false, autoSkew false, recognizeSingleLine false.
RecognitionSettings(ArrayList<Rectangle> recognitionAreas, boolean recognizeSingleLine) Constructor allows to set all options.
RecognitionSettings(boolean recognizeSingleLine) Constructor allows to set recognizeSingleLine.
RecognitionSettings(CarPlateRecognitionSettings recSettings)
RecognitionSettings(IDCardRecognitionSettings recSettings)
RecognitionSettings(InvoiceRecognitionSettings recSettings)
RecognitionSettings(PassportRecognitionSettings recSettings)
RecognitionSettings(ReceiptRecognitionSettings recSettings)
RecognitionSettings(RecognitionSettings recSettings)

Method Summary

Modifier and Type	Method and Description
void	setAllowedCharacters(CharactersAllowedType allowedCharacters) Allowed characters set.
void	setAllowedCharacters(String allowedCharacters) Allowed characters set.
void	setAutomaticColorInversion(boolean automaticColorInversion) Detect images with white text on dark/black background and automatically choose a special OCR algorithm for them.
void	setDetectAreasMode(DetectAreasMode detectAreasMode) Determines the type of neural network used for areas detection.
void	setIgnoredCharacters(String characters) Sets blacklist for recognition symbols.
void	setLanguage(Language language)
void	setLanguageDetectionLevel(LanguageDetectionLevel languageDetectionLevel) Specifies the level of language detection for text recognition.
void	setLinesFiltration(boolean linesFiltration) Allows to recognize text in the tables (regions surrounded lines).
void	setRecognitionAreas(ArrayList<Rectangle> recognitionAreas) Sets the list of text areas for processing.
void	setRecognizeSingleLine(boolean recognizeSingleLine) Sets single-line image recognition.
void	setThreadsCount(int threadsCount) Gets or sets the number of threads for processing.
void	setUpscaleSmallFont(boolean upscaleSmallFont) Allows you to use additional algorithms specifically for small font recognition.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecognitionSettings

public RecognitionSettings()

Default constructor: set recognitionAreas null, linesFiltration false, autoSkew false, recognizeSingleLine false.

RecognitionSettings

public RecognitionSettings(ArrayList<Rectangle> recognitionAreas,
                           boolean recognizeSingleLine)

Constructor allows to set all options.

Parameters:

recognitionAreas - Rectangles for recognition.

recognizeSingleLine - True if the image contains only one line.

RecognitionSettings

public RecognitionSettings(boolean recognizeSingleLine)

Constructor allows to set recognizeSingleLine. Default values in this case: detectAreas - false, autoSkew = false, recognitionAreas - null.

Parameters:

recognizeSingleLine - True if the image contains only one line.

RecognitionSettings

public RecognitionSettings(ReceiptRecognitionSettings recSettings)

RecognitionSettings

public RecognitionSettings(InvoiceRecognitionSettings recSettings)

RecognitionSettings

public RecognitionSettings(IDCardRecognitionSettings recSettings)

RecognitionSettings

public RecognitionSettings(PassportRecognitionSettings recSettings)

RecognitionSettings

public RecognitionSettings(CarPlateRecognitionSettings recSettings)

RecognitionSettings

public RecognitionSettings(RecognitionSettings recSettings)

Method Detail

setRecognitionAreas

public void setRecognitionAreas(ArrayList<Rectangle> recognitionAreas)

Sets the list of text areas for processing. Allows to manually specify the areas with text for more accurate recognition. If custom areas are set setDetectAreasMode(DetectAreasMode) (DetectAreasMode)} not NONE or PreprocessingFilter.AutoSkew() (boolean)} properties will be ignored. Disables DetectAreas and AutoSkew.

Parameters:

recognitionAreas - Rectangles for recognition.

setLinesFiltration

public void setLinesFiltration(boolean linesFiltration)

Allows to recognize text in the tables (regions surrounded lines).

Parameters:

linesFiltration - false - allows increase performance and don't detect tables and remove lines; otherwise - true. Disabled (false) by default.

setRecognizeSingleLine

public void setRecognizeSingleLine(boolean recognizeSingleLine)

Sets single-line image recognition. Disabled (false) by default. Disable all the processing steps associated with splitting into lines. Set this parameter to true if your image contains only one line. Disables setRecognitionAreas(ArrayList) settings, so all areas settings will be ignored.

Parameters:

recognizeSingleLine - True for single-line image

setLanguage

public void setLanguage(Language language)

Parameters:

language - Sets the language used for OCR. Multi-language (none) by default.

setIgnoredCharacters

public void setIgnoredCharacters(String characters)

Sets blacklist for recognition symbols.

Parameters:

characters - Characters excluded from recognition.

setThreadsCount

public void setThreadsCount(int threadsCount)

Gets or sets the number of threads for processing. By default, 0 means that the image will be processed with the number of threads equal to your number of processors. ThreadsCount = 1 means that the image will be processed in the main thread.

Parameters:

threadsCount - the number of threads that will be created for parallel recognition of image fragments.

setAllowedCharacters

public void setAllowedCharacters(CharactersAllowedType allowedCharacters)

Allowed characters set. Determines the type of characters allowed for recognition result.

Parameters:

allowedCharacters - contains enum @see CharactersAllowedType value.

setAllowedCharacters

public void setAllowedCharacters(String allowedCharacters)

Allowed characters set. Determines the array of characters allowed for recognition result.

Parameters:

allowedCharacters - contains string of characters.

setDetectAreasMode

public void setDetectAreasMode(DetectAreasMode detectAreasMode)

Determines the type of neural network used for areas detection.

Parameters:

detectAreasMode - contains enum @see DetectAreasMode value.

setUpscaleSmallFont

public void setUpscaleSmallFont(boolean upscaleSmallFont)

Allows you to use additional algorithms specifically for small font recognition. Useful for images with small size characters.

Parameters:

upscaleSmallFont - contains boolean value - an upscaleSmallFont is set.

setAutomaticColorInversion

public void setAutomaticColorInversion(boolean automaticColorInversion)

Detect images with white text on dark/black background and automatically choose a special OCR algorithm for them.

Parameters:

automaticColorInversion - contains boolean value - a automaticColorInversion is set. True by default.

setLanguageDetectionLevel

public void setLanguageDetectionLevel(LanguageDetectionLevel languageDetectionLevel)

Specifies the level of language detection for text recognition. Works only if the selected language is Language.MULTILANGUAGE, Language.AUTO, or Language.UNIVERSAL. This process is time-consuming and significantly slows down the overall recognition.

Parameters:

languageDetectionLevel - enum value to set level (Paragraph, Word, Page).