com.aspose.ocr

Class RecognitionResult

java.lang.Object

com.aspose.ocr.RecognitionResult

public class RecognitionResult
extends Object

The results of the image recognition. Contains elements with recognition information and methods for result export.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RecognitionResult.LinesResult

Field Summary

Fields

Modifier and Type	Field and Description
Language	language The language of the recognized text in the image.
ArrayList<Rectangle>	recognitionAreasRectangles Deprecated. Will be removed in the release 25.10.0
ArrayList<String>	recognitionAreasText Deprecated. Will be removed in the release 25.10.0
ArrayList<char[]>	recognitionCharactersList A set of characters found by the recognition algorithm and arranged in descending order of probability.
ArrayList<RecognitionResult.LinesResult>	recognitionLinesResult Gets a list of recognition results with a list of rows (Rectangles).
String	recognitionText Recognition result of all page or one area.
double	skew Deprecated. Will be removed in the release 25.11.0
ArrayList<String>	warnings Gets or sets list of the warnings messages describing non-critical faults appeared during generation.

Constructor Summary

Constructors

Constructor and Description
RecognitionResult() Initializes a new instance of the

Method Summary

Modifier and Type	Method and Description
RecognitionResult	add(RecognitionResult other)
RecognitionResult	clone()
String	GetJson() Form JSON string with recognition results.
HashMap<String,RecognitionResult.LinesResult>	GetKeywords() Get keywords from pasport (Test mode.
String	getSpellCheckCorrectedText() Corrects text (replaces misspelled words).
String	getSpellCheckCorrectedText(SpellCheckLanguage language) Corrects text (replaces misspelled words).
List<SpellCheckError>	getSpellCheckErrorList() Find the misspelled words with suggested spellings for a given input text.
List<SpellCheckError>	getSpellCheckErrorList(SpellCheckLanguage language) Find the misspelled words with suggested spellings for a given input text.
String	GetXml() Form JSON string with recognition results.
void	save(String fullFileName) Saves the document in the plain text
void	save(String fullFileName, Format format) Saves the document in the plain text or other document format.
void	save(String fullFileName, Format format, PdfOptimizationMode optimizePdf) Saves the document in the plain text or other document format.
void	saveSpellCheckCorrectedText(String fullFileName, Format format) Saves the corrected with English dictionary text in the document in the plain text or Microsoft Word Text Document format.
void	saveSpellCheckCorrectedText(String fullFileName, Format format, SpellCheckLanguage language) Saves the corrected text in the document in the plain text or other format.
void	SetKeyword(String key, RecognitionResult.LinesResult result)
void	useUserDictionary(String dictionaryPath) Allows to use own dictionary for spell-check correction.

Methods inherited from class java.lang.Object

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

Field Detail

recognitionAreasText

@Deprecated
public ArrayList<String> recognitionAreasText

Deprecated. Will be removed in the release 25.10.0

List recognition results of a list of areas (Rectangles).

recognitionLinesResult

public ArrayList<RecognitionResult.LinesResult> recognitionLinesResult

Gets a list of recognition results with a list of rows (Rectangles).

recognitionText

public String recognitionText

Recognition result of all page or one area.

recognitionAreasRectangles

@Deprecated
public ArrayList<Rectangle> recognitionAreasRectangles

Deprecated. Will be removed in the release 25.10.0

List recognition results of a list of areas (Rectangles).

recognitionCharactersList

public ArrayList<char[]> recognitionCharactersList

A set of characters found by the recognition algorithm and arranged in descending order of probability.

skew

@Deprecated
public double skew

Deprecated. Will be removed in the release 25.11.0

Skew angle of the image. Will be calculated only in case PreprocessingFilter.AutoSkew()

language

public Language language

The language of the recognized text in the image. This value is determined automatically if Language.AUTO, Language.MULTILANGUAGE, or Language.UNIVERSAL is selected.

warnings

public ArrayList<String> warnings

Gets or sets list of the warnings messages describing non-critical faults appeared during generation.

Constructor Detail

RecognitionResult

public RecognitionResult()

Initializes a new instance of the

See Also:

class.

Method Detail

GetJson

public String GetJson()

Form JSON string with recognition results.

Returns:

Recognition results as JSON string.

GetXml

public String GetXml()

Form JSON string with recognition results.

Returns:

Recognition results as XML string.

save

public void save(String fullFileName)

Saves the document in the plain text

Parameters:

fullFileName - Filename with a path for saving recognition result

save

public void save(String fullFileName,
                 Format format)

Saves the document in the plain text or other document format.

Parameters:

fullFileName - Filename with a path for saving recognition result.

format - Document format enum type of Format.

save

public void save(String fullFileName,
                 Format format,
                 PdfOptimizationMode optimizePdf)

Saves the document in the plain text or other document format.

Parameters:

fullFileName - Filename with a path for saving recognition result.

format - Document format enum type of Format.

optimizePdf - Reduce the PDF file size by lowering the quality of background images. By default, the original image quality is preserved.

saveSpellCheckCorrectedText

public void saveSpellCheckCorrectedText(String fullFileName,
                                        Format format,
                                        SpellCheckLanguage language)

Saves the corrected text in the document in the plain text or other format.

Parameters:

fullFileName - Filename with a path for saving recognition result.

format - Document format enum type of Format.

language - Dictionary for spell check.

saveSpellCheckCorrectedText

public void saveSpellCheckCorrectedText(String fullFileName,
                                        Format format)

Saves the corrected with English dictionary text in the document in the plain text or Microsoft Word Text Document format.

Parameters:

fullFileName - Filename with a path for saving recognition result.

format - Document format enum type of Format.

getSpellCheckCorrectedText

public String getSpellCheckCorrectedText(SpellCheckLanguage language)

Corrects text (replaces misspelled words).

Parameters:

language - Dictionary to use.

Returns:

Corrected recognition results string.

getSpellCheckCorrectedText

public String getSpellCheckCorrectedText()

Corrects text (replaces misspelled words).

Returns:

Corrected recognition results string. Default English dictionary.

getSpellCheckErrorList

public List<SpellCheckError> getSpellCheckErrorList(SpellCheckLanguage language)

Find the misspelled words with suggested spellings for a given input text.

Parameters:

language - Dictionary to use.

Returns:

ArrayList of SpellCheckError object representing misspelled words with lists suggested correct spellings for the each misspelled word, and with the edit distance.

getSpellCheckErrorList

public List<SpellCheckError> getSpellCheckErrorList()

Find the misspelled words with suggested spellings for a given input text. Default English dictionary.

Returns:

ArrayList of SpellCheckError object representing misspelled words with lists suggested correct spellings for the each misspelled word, and with the edit distance.

useUserDictionary

public void useUserDictionary(String dictionaryPath)

Allows to use own dictionary for spell-check correction.

Parameters:

dictionaryPath - 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.

GetKeywords

public HashMap<String,RecognitionResult.LinesResult> GetKeywords()

Get keywords from pasport (Test mode. Works only for USA and MADAGASCAR passports).

Returns:

Dictionary with keyword as a key and LinesResult as a value.

SetKeyword

public void SetKeyword(String key,
                       RecognitionResult.LinesResult result)

add

public RecognitionResult add(RecognitionResult other)

clone

public RecognitionResult clone()

Overrides:

clone in class Object