Click or drag to resize

OcrMutableIterator 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.6.411
Syntax
public class OcrMutableIterator : OcrResultIterator

The OcrMutableIterator type exposes the following members.

Properties
 NameDescription
Public propertyChoiceIterator Gets instance of OcrChoiceIterator class.
(Inherited from OcrResultIterator)
Public propertyHandle Handle to internal tesseract iterator
(Inherited from OcrResultIterator)
Public propertyPageIterator Gets instance of OcrPageIterator class.
(Inherited from OcrResultIterator)
Public propertySymbolIsDropcap 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.
(Inherited from OcrResultIterator)
Public propertySymbolIsSubscript 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.
(Inherited from OcrResultIterator)
Public propertySymbolIsSuperscript 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.
(Inherited from OcrResultIterator)
Public propertyWordFontId Gets the font id.
(Inherited from OcrResultIterator)
Public propertyWordFontName Gets a font name of the word
(Inherited from OcrResultIterator)
Public propertyWordIsBold Check whether a font of the word is bold.
(Inherited from OcrResultIterator)
Public propertyWordIsFromDictionary Returns true if the current word was found in a dictionary.
(Inherited from OcrResultIterator)
Public propertyWordIsItalic Check whether a font of the word is italic.
(Inherited from OcrResultIterator)
Public propertyWordIsMonospace Check whether a font of the word is monospace.
(Inherited from OcrResultIterator)
Public propertyWordIsNumeric Returns true if the current word is numeric.
(Inherited from OcrResultIterator)
Public propertyWordIsSerif Check whether a font of the word is a serif font.
(Inherited from OcrResultIterator)
Public propertyWordIsSmallCaps Check whether a font of the word have a small caps
(Inherited from OcrResultIterator)
Public propertyWordIsUnderlined Check whether a font of the word is underlined.
(Inherited from OcrResultIterator)
Public propertyWordPointSize Gets the point size of the font. Pointsize is returned in printers points (1/72 inch.)
(Inherited from OcrResultIterator)
Public propertyWordRecognitionLanguage Return the name of the language used to recognize this word.
(Inherited from OcrResultIterator)
Top
Methods
 NameDescription
Public methodCopy 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.
(Inherited from OcrResultIterator)
Public methodDispose Releases all resources used by this OcrResultIterator
(Inherited from OcrResultIterator)
Public methodGetConfidence 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)
(Inherited from OcrResultIterator)
Public methodGetUtf8Text Get the UTF-8 encoded text string for the current object at the given level.
(Inherited from OcrResultIterator)
Public methodNext Moves to the start of the next object at the given level in the page hierarchy in the appropriate reading order.
(Inherited from OcrResultIterator)
Public methodWordFontAttributes 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.
(Inherited from OcrResultIterator)
Top
Remarks
Caution note  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. OcrMutableIterator adds access to internal data structures.
See Also