com.googlecode.tesseract.android

Class ResultIterator

java.lang.Object

com.googlecode.tesseract.android.PageIterator

com.googlecode.tesseract.android.ResultIterator

public class ResultIterator
extends PageIterator

Java interface for the ResultIterator. Does not implement all available JNI methods, but does implement enough to be useful. Comments are adapted from original Tesseract source.

Method Summary

Modifier and Type	Method and Description
float	confidence(int level) Returns the mean confidence of the current object at the given level.
void	delete() Deletes the iterator after use
List<Pair<String,Double>>	getSymbolChoicesAndConfidence() Returns all possible matching text strings and their confidence level for the current object.
String	getUTF8Text(int level) Returns the text string for the current object at the given level.
boolean	isAtBeginningOf(int level) Returns true if the iterator is at the start of an object at the given level.
boolean	isAtFinalElement(int level, int element) Returns whether the iterator is positioned at the last element in a given level.

Methods inherited from class com.googlecode.tesseract.android.PageIterator

begin, getBoundingBox, getBoundingRect, next

Methods inherited from class java.lang.Object

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

Method Detail

getUTF8Text

public String getUTF8Text(int level)

Returns the text string for the current object at the given level.

Parameters:

level - the page iterator level. See TessBaseAPI.PageIteratorLevel.

Returns:

the text string for the current object at the given level.

confidence

public float confidence(int level)

Returns the mean confidence of the current object at the given level. The number should be interpreted as a percent probability (0-100).

Parameters:

level - the page iterator level. See TessBaseAPI.PageIteratorLevel.

Returns:

the mean confidence of the current object at the given level.

isAtBeginningOf

public boolean isAtBeginningOf(int level)

Returns true if the iterator is at the start of an object at the given level. Possible uses include determining if a call to Next(RIL_WORD) moved to the start of a RIL_PARA.

Parameters:

level - the page iterator level. See TessBaseAPI.PageIteratorLevel.

Returns:

true if iterator points to the start of an object at the given level.

isAtFinalElement

public boolean isAtFinalElement(int level,
                                int element)

Returns 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)

Parameters:

level - the page iterator level. See TessBaseAPI.PageIteratorLevel.

element - the page iterator level. See TessBaseAPI.PageIteratorLevel.

Returns:

true if iterator points to the last element in a given level.

getSymbolChoicesAndConfidence

public List<Pair<String,Double>> getSymbolChoicesAndConfidence()

Returns all possible matching text strings and their confidence level for the current object.

The default matching text is blank (""). The default confidence level is zero (0.0)

Returns:

A list of pairs with the UTF symbol and the confidence

delete

public void delete()

Deletes the iterator after use