**Inheritance:** java.lang.Object ``` public class RecognitionSettings ``` Settings for the image recognition. Contains elements that allow customizing the recognition process. ## Constructors | Constructor | Description | | --- | --- | | [RecognitionSettings()](#RecognitionSettings) | Default constructor: set recognitionAreas null, linesFiltration false, autoSkew false, recognizeSingleLine false. | | [RecognitionSettings(ArrayList recognitionAreas, boolean recognizeSingleLine)](#RecognitionSettings-java.util.ArrayList-java.awt.Rectangle--boolean) | Constructor allows to set all options. | | [RecognitionSettings(boolean recognizeSingleLine)](#RecognitionSettings-boolean) | Constructor allows to set recognizeSingleLine. | | [RecognitionSettings(ReceiptRecognitionSettings recSettings)](#RecognitionSettings-com.aspose.ocr.ReceiptRecognitionSettings) | | | [RecognitionSettings(InvoiceRecognitionSettings recSettings)](#RecognitionSettings-com.aspose.ocr.InvoiceRecognitionSettings) | | | [RecognitionSettings(IDCardRecognitionSettings recSettings)](#RecognitionSettings-com.aspose.ocr.IDCardRecognitionSettings) | | | [RecognitionSettings(PassportRecognitionSettings recSettings)](#RecognitionSettings-com.aspose.ocr.PassportRecognitionSettings) | | | [RecognitionSettings(CarPlateRecognitionSettings recSettings)](#RecognitionSettings-com.aspose.ocr.CarPlateRecognitionSettings) | | | [RecognitionSettings(RecognitionSettings recSettings)](#RecognitionSettings-com.aspose.ocr.RecognitionSettings) | | ## Methods | Method | Description | | --- | --- | | [setAllowedCharacters(CharactersAllowedType allowedCharacters)](#setAllowedCharacters-com.aspose.ocr.models.CharactersAllowedType) | Allowed characters set. | | [setAllowedCharacters(String allowedCharacters)](#setAllowedCharacters-java.lang.String) | Allowed characters set. | | [setAutomaticColorInversion(boolean automaticColorInversion)](#setAutomaticColorInversion-boolean) | Detect images with white text on dark/black background and automatically choose a special OCR algorithm for them. | | [setDetectAreasMode(DetectAreasMode detectAreasMode)](#setDetectAreasMode-com.aspose.ocr.models.DetectAreasMode) | Selects the content-area detection strategy. | | [setDetectFonts(boolean detectFonts)](#setDetectFonts-boolean) | Enables font detection for each recognized text line. | | [setIgnoredCharacters(String characters)](#setIgnoredCharacters-java.lang.String) | Sets blacklist for recognition symbols. | | [setLanguage(Language language)](#setLanguage-com.aspose.ocr.models.Language) | | | [setLanguageDetectionLevel(LanguageDetectionLevel languageDetectionLevel)](#setLanguageDetectionLevel-com.aspose.ocr.models.LanguageDetectionLevel) | Specifies the level of language detection for text recognition. | | [setLinesFiltration(boolean linesFiltration)](#setLinesFiltration-boolean) | Allows to recognize text in the tables (regions surrounded lines). | | [setRecognitionAreas(ArrayList recognitionAreas)](#setRecognitionAreas-java.util.ArrayList-java.awt.Rectangle) | Sets the list of text areas for processing. | | [setRecognizeSingleLine(boolean recognizeSingleLine)](#setRecognizeSingleLine-boolean) | Sets single-line image recognition. | | [setRetainImageForExport(boolean retainImageForExport)](#setRetainImageForExport-boolean) | Sets whether the preprocessed source image is retained in the recognition result. | | [setThreadsCount(int threadsCount)](#setThreadsCount-int) | Sets the number of threads used to recognize fragments of a single image. | | [setUpscaleSmallFont(boolean upscaleSmallFont)](#setUpscaleSmallFont-boolean) | Allows you to use additional algorithms specifically for small font recognition. | ### RecognitionSettings() {#RecognitionSettings} ``` public RecognitionSettings() ``` Default constructor: set recognitionAreas null, linesFiltration false, autoSkew false, recognizeSingleLine false. ### RecognitionSettings(ArrayList recognitionAreas, boolean recognizeSingleLine) {#RecognitionSettings-java.util.ArrayList-java.awt.Rectangle--boolean} ``` public RecognitionSettings(ArrayList recognitionAreas, boolean recognizeSingleLine) ``` Constructor allows to set all options. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | recognitionAreas | java.util.ArrayList | Rectangles for recognition. | | recognizeSingleLine | boolean | True if the image contains only one line. | ### RecognitionSettings(boolean recognizeSingleLine) {#RecognitionSettings-boolean} ``` public RecognitionSettings(boolean recognizeSingleLine) ``` Constructor allows to set recognizeSingleLine. Default values in this case: detectAreas - false, autoSkew = false, recognitionAreas - null. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | recognizeSingleLine | boolean | True if the image contains only one line. | ### RecognitionSettings(ReceiptRecognitionSettings recSettings) {#RecognitionSettings-com.aspose.ocr.ReceiptRecognitionSettings} ``` public RecognitionSettings(ReceiptRecognitionSettings recSettings) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | recSettings | [ReceiptRecognitionSettings](../../com.aspose.ocr/receiptrecognitionsettings/) | | ### RecognitionSettings(InvoiceRecognitionSettings recSettings) {#RecognitionSettings-com.aspose.ocr.InvoiceRecognitionSettings} ``` public RecognitionSettings(InvoiceRecognitionSettings recSettings) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | recSettings | [InvoiceRecognitionSettings](../../com.aspose.ocr/invoicerecognitionsettings/) | | ### RecognitionSettings(IDCardRecognitionSettings recSettings) {#RecognitionSettings-com.aspose.ocr.IDCardRecognitionSettings} ``` public RecognitionSettings(IDCardRecognitionSettings recSettings) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | recSettings | [IDCardRecognitionSettings](../../com.aspose.ocr/idcardrecognitionsettings/) | | ### RecognitionSettings(PassportRecognitionSettings recSettings) {#RecognitionSettings-com.aspose.ocr.PassportRecognitionSettings} ``` public RecognitionSettings(PassportRecognitionSettings recSettings) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | recSettings | [PassportRecognitionSettings](../../com.aspose.ocr/passportrecognitionsettings/) | | ### RecognitionSettings(CarPlateRecognitionSettings recSettings) {#RecognitionSettings-com.aspose.ocr.CarPlateRecognitionSettings} ``` public RecognitionSettings(CarPlateRecognitionSettings recSettings) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | recSettings | [CarPlateRecognitionSettings](../../com.aspose.ocr/carplaterecognitionsettings/) | | ### setAllowedCharacters(CharactersAllowedType allowedCharacters) {#setAllowedCharacters-com.aspose.ocr.models.CharactersAllowedType} ``` public void setAllowedCharacters(CharactersAllowedType allowedCharacters) ``` Allowed characters set. Determines the type of characters allowed for recognition result. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | allowedCharacters | [CharactersAllowedType](../../com.aspose.ocr.models/charactersallowedtype/) | contains enum @see [CharactersAllowedType](../../com.aspose.ocr.models/charactersallowedtype/) value. | ### setAllowedCharacters(String allowedCharacters) {#setAllowedCharacters-java.lang.String} ``` public void setAllowedCharacters(String allowedCharacters) ``` Allowed characters set. Determines the array of characters allowed for recognition result. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | allowedCharacters | java.lang.String | contains string of characters. | ### setAutomaticColorInversion(boolean automaticColorInversion) {#setAutomaticColorInversion-boolean} ``` public void setAutomaticColorInversion(boolean automaticColorInversion) ``` Detect images with white text on dark/black background and automatically choose a special OCR algorithm for them. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | automaticColorInversion | boolean | contains boolean value - a automaticColorInversion is set. True by default. | ### setDetectAreasMode(DetectAreasMode detectAreasMode) {#setDetectAreasMode-com.aspose.ocr.models.DetectAreasMode} ``` public void setDetectAreasMode(DetectAreasMode detectAreasMode) ``` Selects the content-area detection strategy. Use [DetectAreasMode.DOCUMENT\_LAYOUT](../../com.aspose.ocr.models/detectareasmode/\#DOCUMENT-LAYOUT) to detect complete document structure, including columns, tables, images, charts, and formulas. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | detectAreasMode | [DetectAreasMode](../../com.aspose.ocr.models/detectareasmode/) | contains enum @see [DetectAreasMode](../../com.aspose.ocr.models/detectareasmode/) value. | ### setDetectFonts(boolean detectFonts) {#setDetectFonts-boolean} ``` public void setDetectFonts(boolean detectFonts) ``` Enables font detection for each recognized text line. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | detectFonts | boolean | true to fill RecognitionResult.LinesResult\#font.font. | ### setIgnoredCharacters(String characters) {#setIgnoredCharacters-java.lang.String} ``` public void setIgnoredCharacters(String characters) ``` Sets blacklist for recognition symbols. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | characters | java.lang.String | Characters excluded from recognition. | ### setLanguage(Language language) {#setLanguage-com.aspose.ocr.models.Language} ``` public void setLanguage(Language language) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | language | [Language](../../com.aspose.ocr.models/language/) | Sets the language used for OCR. Multi-language (none) by default. | ### setLanguageDetectionLevel(LanguageDetectionLevel languageDetectionLevel) {#setLanguageDetectionLevel-com.aspose.ocr.models.LanguageDetectionLevel} ``` 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:** | Parameter | Type | Description | | --- | --- | --- | | languageDetectionLevel | [LanguageDetectionLevel](../../com.aspose.ocr.models/languagedetectionlevel/) | enum value to set level (Paragraph, Word, Page). | ### setLinesFiltration(boolean linesFiltration) {#setLinesFiltration-boolean} ``` public void setLinesFiltration(boolean linesFiltration) ``` Allows to recognize text in the tables (regions surrounded lines). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | linesFiltration | boolean | false - allows increase performance and don't detect tables and remove lines; otherwise - true. Disabled (false) by default. | ### setRecognitionAreas(ArrayList recognitionAreas) {#setRecognitionAreas-java.util.ArrayList-java.awt.Rectangle} ``` public void setRecognitionAreas(ArrayList 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)](../../com.aspose.ocr/recognitionsettings/\#setDetectAreasMode-DetectAreasMode) (DetectAreasMode)\} not NONE or [PreprocessingFilter.AutoSkew()](../../com.aspose.ocr/preprocessingfilter/\#AutoSkew) (boolean)\} properties will be ignored. Disables DetectAreas and AutoSkew. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | recognitionAreas | java.util.ArrayList | Rectangles for recognition. | ### setRecognizeSingleLine(boolean recognizeSingleLine) {#setRecognizeSingleLine-boolean} ``` 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)](../../com.aspose.ocr/recognitionsettings/\#setRecognitionAreas-ArrayList) settings, so all areas settings will be ignored. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | recognizeSingleLine | boolean | True for single-line image | ### setRetainImageForExport(boolean retainImageForExport) {#setRetainImageForExport-boolean} ``` public void setRetainImageForExport(boolean retainImageForExport) ``` Sets whether the preprocessed source image is retained in the recognition result. Disabled ( false ) by default to avoid keeping page images in memory. Enable this option when the image must be available through [RecognitionResult.image](../../com.aspose.ocr/recognitionresult/\#image), for example for legacy export APIs. [OcrOutput.save(String, Format)](../../com.aspose.ocr/ocroutput/\#save-String--Format) can reload source images without this option. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | retainImageForExport | boolean | true to retain the image in each recognition result. | ### setThreadsCount(int threadsCount) {#setThreadsCount-int} ``` public void setThreadsCount(int threadsCount) ``` Sets the number of threads used to recognize fragments of a single image. By default, 0 means that a single image will use the number of threads equal to the number of processors. ThreadsCount = 1 means that fragments of a single image are recognized sequentially. Multipage inputs are processed by a fixed pool of four pages, with sequential fragment recognition inside each page. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | threadsCount | int | the number of threads that will be created for parallel recognition of image fragments. | ### setUpscaleSmallFont(boolean upscaleSmallFont) {#setUpscaleSmallFont-boolean} ``` public void setUpscaleSmallFont(boolean upscaleSmallFont) ``` Allows you to use additional algorithms specifically for small font recognition. Useful for images with small size characters. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | upscaleSmallFont | boolean | contains boolean value - an upscaleSmallFont is set. |