OcrPageIterator Class

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

Inheritance Hierarchy

SystemObject
Patagames.OcrOcrPageIterator

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

Syntax

public class OcrPageIterator : IDisposable

Public Class OcrPageIterator
	Implements IDisposable

public ref class OcrPageIterator : IDisposable

type OcrPageIterator =  
    class
        interface IDisposable
    end

public class OcrPageIterator implements IDisposable

Patagames.Ocr.OcrPageIterator = function();

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

The OcrPageIterator type exposes the following members.

Properties

	Name	Description
	BlockType	Gets the type of the current block. See PolyBlockType for details.
	DeskewAngle	Gets deskew angle of the current iterator
	FirstLineIndent	Gets the indent of the first line of current paragraph
	Handle	Handle to internal tesseract iterator
	IsCrown	Check whether the first line of the paragraph is aligned with the other lines of the paragraph.
	IsListItem	Check whether the current paragraph is a member of an ordered or unordered list
	Justify	Get ParagraphJustification for the current paragraph, if available.
	Orientations	Gets orientation of the current iterator
	TextlineOrder	Gets text line order of the current iterator
	WritingDirection	Gets writing direction of the current iterator

Methods

	Name	Description
	Begin	Moves the iterator to point to the start of the page to begin an iteration
	Copy	PageIterators 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 OcrPageIterator
	GetBaseLine	Get the baseline of the current object at the given level.
	GetBinaryImage	Get f binary image of the current object at the given level.
	GetBoundingBox	Gets bounding rectangle of the current object at the given level.
	GetImage	Get an image of the current object at the given level in greyscale if available in the input.
	GetIteratorParams	Get orientation for the block the iterator points to.
	GetParagraphInfo	Get information about the current paragraph, if available.
	IsAtBeginningOf	Check whether the iterator is at the start of an object at the given level
	IsAtFinalElement	Check whether the iterator is positioned at the last element in a given level. (e.g.the last word in a line, the last line in a block)
	Next	Moves to the start of the next object at the given level in the page hierarchy.

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.