net.sourceforge.tess4j

Class Tesseract1

java.lang.Object

net.sourceforge.tess4j.TessAPI1

net.sourceforge.tess4j.Tesseract1

All Implemented Interfaces:

com.sun.jna.Library

public class Tesseract1
extends TessAPI1

An object layer on top of TessAPI1, provides character recognition support for common image formats, and multi-page TIFF images beyond the uncompressed, binary TIFF format supported by Tesseract OCR engine. The extended capabilities are provided by the Java Advanced Imaging Image I/O Tools.

Support for PDF documents is available through Ghost4J, a JNA wrapper for GPL Ghostscript, which should be installed and included in system path.

Any program that uses the library will need to ensure that the required libraries (the .jar files for jna, jai-imageio, and ghost4j) are in its compile and run-time classpath.

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.tess4j.TessAPI1

TessAPI1.ETEXT_DESC, TessAPI1.TessBaseAPI, TessAPI1.TessMutableIterator, TessAPI1.TessOcrEngineMode, TessAPI1.TessOrientation, TessAPI1.TessPageIterator, TessAPI1.TessPageIteratorLevel, TessAPI1.TessPageSegMode, TessAPI1.TessPolyBlockType, TessAPI1.TessResultIterator, TessAPI1.TessTextlineOrder, TessAPI1.TessWritingDirection

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	htmlBeginTag
static java.lang.String	htmlEndTag

Fields inherited from class net.sourceforge.tess4j.TessAPI1

FALSE, LIB_NAME, LIB_NAME_NON_WIN, TRUE

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Constructor Summary

Constructors

Constructor and Description
Tesseract1() Public constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	dispose() Releases all of the native resources used by this instance.
java.lang.String	doOCR(java.awt.image.BufferedImage bi) Performs OCR operation.
java.lang.String	doOCR(java.awt.image.BufferedImage bi, java.awt.Rectangle rect) Performs OCR operation.
java.lang.String	doOCR(java.io.File imageFile) Performs OCR operation.
java.lang.String	doOCR(java.io.File imageFile, java.awt.Rectangle rect) Performs OCR operation.
java.lang.String	doOCR(int xsize, int ysize, java.nio.ByteBuffer buf, java.awt.Rectangle rect, int bpp) Performs OCR operation.
java.lang.String	doOCR(java.util.List<javax.imageio.IIOImage> imageList, java.awt.Rectangle rect) Performs OCR operation.
protected TessAPI1.TessBaseAPI	getHandle() Returns API handle.
protected java.lang.String	getOCRText() Gets recognized text.
protected void	init() Initializes Tesseract engine.
void	setDatapath(java.lang.String datapath)
void	setHocr(boolean hocr) Enables hocr output.
protected void	setImage(int xsize, int ysize, java.nio.ByteBuffer buf, java.awt.Rectangle rect, int bpp) Sets image to be processed.
protected void	setImage(java.awt.image.RenderedImage image, java.awt.Rectangle rect) A wrapper for setImage(int, int, ByteBuffer, Rectangle, int).
void	setLanguage(java.lang.String language) Sets language for OCR.
void	setOcrEngineMode(int ocrEngineMode) Sets OCR engine mode.
void	setPageSegMode(int mode)
void	setTessVariable(java.lang.String key, java.lang.String value) Set the value of Tesseract's internal parameter.
protected void	setTessVariables() Sets Tesseract's internal parameters.

Methods inherited from class net.sourceforge.tess4j.TessAPI1

TessBaseAPIAdaptToWordStr, TessBaseAPIAllWordConfidences, TessBaseAPIAnalyseLayout, TessBaseAPIClear, TessBaseAPIClearAdaptiveClassifier, TessBaseAPICreate, TessBaseAPIDelete, TessBaseAPIDumpPGM, TessBaseAPIEnd, TessBaseAPIGetAvailableLanguagesAsVector, TessBaseAPIGetBoolVariable, TessBaseAPIGetBoxText, TessBaseAPIGetDoubleVariable, TessBaseAPIGetHOCRText, TessBaseAPIGetInitLanguagesAsString, TessBaseAPIGetIntVariable, TessBaseAPIGetIterator, TessBaseAPIGetLoadedLanguagesAsVector, TessBaseAPIGetMutableIterator, TessBaseAPIGetPageSegMode, TessBaseAPIGetStringVariable, TessBaseAPIGetTextDirection, TessBaseAPIGetThresholdedImageScaleFactor, TessBaseAPIGetUnichar, TessBaseAPIGetUNLVText, TessBaseAPIGetUTF8Text, TessBaseAPIInit1, TessBaseAPIInit2, TessBaseAPIInit3, TessBaseAPIInitForAnalysePage, TessBaseAPIInitLangMod, TessBaseAPIIsValidWord, TessBaseAPIMeanTextConf, TessBaseAPIPrintVariablesToFile, TessBaseAPIProcessPages, TessBaseAPIReadConfigFile, TessBaseAPIRecognize, TessBaseAPIRecognizeForChopTest, TessBaseAPIRect, TessBaseAPISetImage, TessBaseAPISetInputName, TessBaseAPISetOutputName, TessBaseAPISetPageSegMode, TessBaseAPISetRectangle, TessBaseAPISetSourceResolution, TessBaseAPISetVariable, TessDeleteIntArray, TessDeleteText, TessDeleteTextArray, TessPageIteratorBaseline, TessPageIteratorBegin, TessPageIteratorBlockType, TessPageIteratorBoundingBox, TessPageIteratorCopy, TessPageIteratorDelete, TessPageIteratorIsAtBeginningOf, TessPageIteratorIsAtFinalElement, TessPageIteratorNext, TessPageIteratorOrientation, TessResultIteratorConfidence, TessResultIteratorCopy, TessResultIteratorDelete, TessResultIteratorGetPageIterator, TessResultIteratorGetPageIteratorConst, TessResultIteratorGetUTF8Text, TessResultIteratorSymbolIsDropcap, TessResultIteratorSymbolIsSubscript, TessResultIteratorSymbolIsSuperscript, TessResultIteratorWordFontAttributes, TessResultIteratorWordIsFromDictionary, TessResultIteratorWordIsNumeric, TessVersion

Methods inherited from class java.lang.Object

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

Field Detail

htmlBeginTag

public static final java.lang.String htmlBeginTag

See Also:

Constant Field Values

htmlEndTag

public static final java.lang.String htmlEndTag

See Also:

Constant Field Values

Constructor Detail

Tesseract1

public Tesseract1()

Public constructor.

Method Detail

setDatapath

public void setDatapath(java.lang.String datapath)

Parameters:

datapath - the tessdata path to set

setLanguage

public void setLanguage(java.lang.String language)

Sets language for OCR.

Parameters:

language - the language code, which follows ISO 639-3 standard.

setOcrEngineMode

public void setOcrEngineMode(int ocrEngineMode)

Sets OCR engine mode.

Parameters:

ocrEngineMode - the OcrEngineMode to set

setPageSegMode

public void setPageSegMode(int mode)

Parameters:

mode - the page segmentation mode to set

setHocr

public void setHocr(boolean hocr)

Enables hocr output.

Parameters:

hocr - to enable or disable hocr output

setTessVariable

public void setTessVariable(java.lang.String key,
                   java.lang.String value)

Set the value of Tesseract's internal parameter.

Parameters:

key - variable name, e.g., tessedit_create_hocr, tessedit_char_whitelist, etc.

value - value for corresponding variable, e.g., "1", "0", "0123456789", etc.

getHandle

protected TessAPI1.TessBaseAPI getHandle()

Returns API handle.

doOCR

public java.lang.String doOCR(java.io.File imageFile)
                       throws TesseractException

Performs OCR operation.

Parameters:

imageFile - an image file

Returns:

the recognized text

Throws:

TesseractException

doOCR

public java.lang.String doOCR(java.io.File imageFile,
                     java.awt.Rectangle rect)
                       throws TesseractException

Performs OCR operation.

Parameters:

imageFile - an image file

rect - the bounding rectangle defines the region of the image to be recognized. A rectangle of zero dimension or null indicates the whole image.

Returns:

the recognized text

Throws:

TesseractException

doOCR

public java.lang.String doOCR(java.awt.image.BufferedImage bi)
                       throws TesseractException

Performs OCR operation.

Parameters:

bi - a buffered image

Returns:

the recognized text

Throws:

TesseractException

doOCR

public java.lang.String doOCR(java.awt.image.BufferedImage bi,
                     java.awt.Rectangle rect)
                       throws TesseractException

Performs OCR operation.

Parameters:

bi - a buffered image

rect - the bounding rectangle defines the region of the image to be recognized. A rectangle of zero dimension or null indicates the whole image.

Returns:

the recognized text

Throws:

TesseractException

doOCR

public java.lang.String doOCR(java.util.List<javax.imageio.IIOImage> imageList,
                     java.awt.Rectangle rect)
                       throws TesseractException

Performs OCR operation.

Parameters:

imageList - a list of IIOImage objects

rect - the bounding rectangle defines the region of the image to be recognized. A rectangle of zero dimension or null indicates the whole image.

Returns:

the recognized text

Throws:

TesseractException

doOCR

public java.lang.String doOCR(int xsize,
                     int ysize,
                     java.nio.ByteBuffer buf,
                     java.awt.Rectangle rect,
                     int bpp)
                       throws TesseractException

Performs OCR operation. Use SetImage, (optionally) SetRectangle, and one or more of the Get*Text functions.

Parameters:

xsize - width of image

ysize - height of image

buf - pixel data

rect - the bounding rectangle defines the region of the image to be recognized. A rectangle of zero dimension or null indicates the whole image.

bpp - bits per pixel, represents the bit depth of the image, with 1 for binary bitmap, 8 for gray, and 24 for color RGB.

Returns:

the recognized text

Throws:

TesseractException

init

protected void init()

Initializes Tesseract engine.

setTessVariables

protected void setTessVariables()

Sets Tesseract's internal parameters.

setImage

protected void setImage(java.awt.image.RenderedImage image,
            java.awt.Rectangle rect)
                 throws java.io.IOException

A wrapper for setImage(int, int, ByteBuffer, Rectangle, int).

Throws:

java.io.IOException

setImage

protected void setImage(int xsize,
            int ysize,
            java.nio.ByteBuffer buf,
            java.awt.Rectangle rect,
            int bpp)

Sets image to be processed.

Parameters:

xsize - width of image

ysize - height of image

buf - pixel data

rect - the bounding rectangle defines the region of the image to be recognized. A rectangle of zero dimension or null indicates the whole image.

bpp - bits per pixel, represents the bit depth of the image, with 1 for binary bitmap, 8 for gray, and 24 for color RGB.

getOCRText

protected java.lang.String getOCRText()

Gets recognized text.

dispose

protected void dispose()

Releases all of the native resources used by this instance.