TessEngineMBS.AllWordConfidences as Integer()

The number of confidences should correspond to the number of space-delimited words in GetText.

TessEngineMBS.AnalyseLayout as TessPageIteratorMBS

May optionally be called prior to Recognize to get access to just the page layout results. Returns an iterator to the results.

Returns nil on error or an empty page.

TessEngineMBS.Clear

Afterwards, you must call SetImage or TesseractRect before doing any Recognize or Get* operation.

TessEngineMBS.Constructor

Please call Initialize after this to get started.

TessEngineMBS.GetAltoText(PageNumber as Integer) as String

TessEngineMBS.GetAvailableLanguages as String()

Var OCR As TessEngineMBS // your instance of tesseract
Var AvailableLanguages() As String = OCR.GetAvailableLanguages

Some examples using this method:

• /OCR/Tesseract4/Tesseract4
• /OCR/tesseract5/Tesseract5

TessEngineMBS.GetBoolVariable(Name as String, byref value as boolean) as Boolean

Returns true if the parameter was found among Tesseract parameters.
Fills in value with the value of the parameter.

TessEngineMBS.GetBoxText(PageNumber as Integer) as String

Constructs coordinates in the original image - not just the rectangle.
PageNumber is a 0-based page index that will appear in the box file.

TessEngineMBS.GetDoubleVariable(Name as String, byref value as Double) as Boolean

Returns true if the parameter was found among Tesseract parameters.
Fills in value with the value of the parameter.

TessEngineMBS.GetHOCRText(PageNumber as Integer) as String

PageNumber is 0-based but will appear in the output as 1-based.

TessEngineMBS.GetIntVariable(Name as String, byref value as Integer) as Boolean

Returns true if the parameter was found among Tesseract parameters.
Fills in value with the value of the parameter.

TessEngineMBS.GetLoadedLanguages as String()

Var OCR As TessEngineMBS // your instance of tesseract
Var LoadedLanguages() As String = OCR.GetLoadedLanguages

Includes all languages loaded by the last Init, including those loaded as dependencies of other loaded languages.

Some examples using this method:

• /OCR/Tesseract4/Tesseract4
• /OCR/tesseract5/Tesseract5

TessEngineMBS.GetLSTMBoxText(PageNumber as Integer) as String

Constructs coordinates in the original image - not just the rectangle.
PageNumber is a 0-based page index that will appear in the box file.

TessEngineMBS.GetStringVariable(Name as String) as String

Returns true if the parameter was found among Tesseract parameters.
Fills in value with the value of the parameter.

TessEngineMBS.GetText as String

TessEngineMBS.GetTsvText(PageNumber as Integer) as String

PageNumber is 0-based but will appear in the output as 1-based.

TessEngineMBS.GetUNLVText as String

TessEngineMBS.GetWordStrBoxText(PageNumber as Integer) as String

PageNumber is a 0-based page index that will appear in the box file.

TessEngineMBS.Initialize(dataPath as String, language as String, Mode as Integer = 3, configs() as String = nil) as Boolean

Var OCR As new TessEngineMBS // your instance of tesseract

If Not ocr.Initialize("C:\Program Files\Tesseract-OCR\tessdata", "eng") Then
  MsgBox "failed to initialize"
  Quit
End If

Returns true on success and false on failure.

The datapath must be the name of the tessdata directory.
The language is (usually) an ISO 639-3 string or "" will default to eng.
It is entirely safe (and eventually will be efficient too) to call Initialize multiple times on the same instance to change language, or just to reset the classifier.

The language may be a string of the form [~]<lang>[+[~]<lang>]* indicating that multiple languages are to be loaded. Eg hin+eng will load Hindi and English. Languages may specify internally that they want to be loaded with one or more other languages, so the ~ sign is available to override that. Eg if hin were set to load eng by default, then hin+~eng would force loading only hin. The number of loaded languages is limited only by memory, with the caveat that loading additional languages will impact both speed and accuracy, as there is more work to do to decide on the applicable language, and there is more chance of hallucinating incorrect words.

Warning: On changing languages, all Tesseract parameters are reset back to their default values. (Which may vary between languages.)
If you have a rare need to set a Variable that controls initialization for a second call to Init you should explicitly call End() and then use SetVariable before Init. This is only a very rare use case, since there are very few uses that require any parameters to be set before Init.

TessEngineMBS.IsValidWord(Word as String) as Boolean

Return false if the word is invalid, true if valid.

TessEngineMBS.PrintVariablesToFile(File as FolderItem) as Boolean

Returns true on success.
Fails if the file can't be created.

TessEngineMBS.PrintVariablesToPath(Path as String) as Boolean

Returns true on success.
Fails if the file can't be created.

TessEngineMBS.Recognize as Boolean

Returns true on success.

Optional. The Get*Text functions below will call Recognize if needed.

After Recognize, the output is kept internally until the next SetImage.

Some examples using this method:

• /OCR/Tesseract4/Tesseract4
• /OCR/tesseract5/Tesseract5

TessEngineMBS.ResultIterator as TessResultIteratorMBS

Loop over it to query details.
The result iterator is only valid until you end the engine.

Some examples using this method:

• /OCR/Tesseract4/Tesseract4
• /OCR/tesseract5/Tesseract5

TessEngineMBS.SetImage(pic as picture)

Var OCR As TessEngineMBS // your instance of tesseract

Var f As FolderItem = SpecialFolder.Desktop.Child("test.jpg")
Var p As Picture = f.OpenAsPicture
OCR.SetImage(p)

Pass Xojo picture and we copy the pixels.
Mask or alpha channel is ignored.

TessEngineMBS.SetImageData(Data as MemoryBlock)

Image data can be an image file content like JPEG or PNG.
Supported formats depends on what leptonica was compiled to support.

See also:

• SetImageData(Data as String)

TessEngineMBS.SetImageData(Data as String)

Image data can be an image file content like JPEG or PNG.
Supported formats depends on what leptonica was compiled to support.

See also:

• SetImageData(Data as MemoryBlock)

TessEngineMBS.SetImageFile(File as FolderItem)

Var OCR As TessEngineMBS // your instance of tesseract

Var f As FolderItem = SpecialFolder.Desktop.Child("test.jpg")
OCR.SetImageFile(f)

Point to an image file like JPEG or PNG.
Supported formats depends on what leptonica was compiled to support.

See also:

• SetImageFile(Path as String)

TessEngineMBS.SetImageFile(Path as String)

Point to an image file like JPEG or PNG.
Supported formats depends on what leptonica was compiled to support.

See also:

• SetImageFile(File as FolderItem)

TessEngineMBS.SetRectangle(Left as Integer, Top as Integer, Width as Integer, Height as Integer)

Call after SetImage.
Each SetRectangle clears the recogntion results so multiple rectangles can be recognized with the same image.

TessEngineMBS.SetVariable(Name as String, Value as String)

Var OCR As TessEngineMBS // your instance of tesseract

OCR.SetVariable("tessedit_char_blacklist", "xyz")

Supply the name of the parameter and the value as a string, just as you would in a config file.
Returns false if the name lookup failed.
e.g.
SetVariable("tessedit_char_blacklist", "xyz") to ignore x, y and z.
Or
SetVariable("classify_bln_numeric_mode", "1") to set numeric-only mode.

SetVariable may be used before Init, but settings will revert to defaults on End().

Note: Must be called after Initialize(). Only works for non-init variables (init variables should be passed to Initialize()).