OcrResultIterator Class

Class to iterate over tesseract results, providing access to all levels of the page hierarchy.

Inheritance Hierarchy

SystemObject
Patagames.OcrOcrResultIterator
Patagames.OcrOcrMutableIterator

Namespace: Patagames.Ocr
Assembly: Patagames.Ocr (in Patagames.Ocr.dll) Version: 4.2.411

Syntax

C++

JavaScript

Copy

public class OcrResultIterator : IDisposable

Public Class OcrResultIterator
	Implements IDisposable

public ref class OcrResultIterator : IDisposable

type OcrResultIterator =  
    class
        interface IDisposable
    end

public class OcrResultIterator implements IDisposable

Patagames.Ocr.OcrResultIterator = function();

Type.createClass(
	'Patagames.Ocr.OcrResultIterator',
	null,
	IDisposable);

The OcrResultIterator type exposes the following members.

Properties

	Name	Description
	ChoiceIterator	Gets instance of OcrChoiceIterator class.
	Handle	Handle to internal tesseract iterator
	PageIterator	Gets instance of OcrPageIterator class.
	SymbolIsDropcap	Returns true if the current symbol is a dropcap. If iterating at a higher level object than symbols, eg words, then this will return the attributes of the first symbol in that word.
	SymbolIsSubscript	Returns true if the current symbol is a subscript. If iterating at a higher level object than symbols, eg words, then this will return the attributes of the first symbol in that word.
	SymbolIsSuperscript	Returns true if the current symbol is a superscript. If iterating at a higher level object than symbols, eg words, then this will return the attributes of the first symbol in that word.
	WordFontId	Gets the font id.
	WordFontName	Gets a font name of the word
	WordIsBold	Check whether a font of the word is bold.
	WordIsFromDictionary	Returns true if the current word was found in a dictionary.
	WordIsItalic	Check whether a font of the word is italic.
	WordIsMonospace	Check whether a font of the word is monospace.
	WordIsNumeric	Returns true if the current word is numeric.
	WordIsSerif	Check whether a font of the word is a serif font.
	WordIsSmallCaps	Check whether a font of the word have a small caps
	WordIsUnderlined	Check whether a font of the word is underlined.
	WordPointSize	Gets the point size of the font. Pointsize is returned in printers points (1/72 inch.)
	WordRecognitionLanguage	Return the name of the language used to recognize this word.

Top

Methods

	Name	Description
	Copy	ResultIterators may be copied! This makes it possible to iterate over all the objects at a lower level, while maintaining an iterator to objects at a higher level.
	Dispose	Releases all resources used by this OcrResultIterator
	GetConfidence	Returns the mean confidence of the current object at the given level. The number should be interpreted as a percent probability. (0.0f-100.0f)
	GetUtf8Text	Get the UTF-8 encoded text string for the current object at the given level.
	Next	Moves to the start of the next object at the given level in the page hierarchy in the appropriate reading order.
	WordFontAttributes	Get the font attributes of the current word. If iterating at a higher level object than words, eg textlines, then this will return the attributes of the first word in that textline.

Top

Remarks

Caution
This class points to data held within the OcrApi class, and therefore can only be used while the OcrApi class still exists and has not been subjected to a call of Init, SetImage, Recognize, Clear, Release or anything else that changes the internal PAGE_RES.

OcrResultIterator adds text-specific methods for access to OCR output.

Reference

Patagames.Ocr Namespace