net.sourceforge.tess4j

Interface TessAPI

All Superinterfaces:

com.sun.jna.Library

public interface TessAPI
extends com.sun.jna.Library

A Java wrapper for Tesseract OCR 3.02 API using JNA Interface Mapping.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TessAPI.ETEXT_DESC
static class	TessAPI.TessBaseAPI
static interface	TessAPI.TessOcrEngineMode When Tesseract/Cube is initialized we can choose to instantiate/load/run only the Tesseract part, only the Cube part or both along with the combiner.
static interface	TessAPI.TessOrientation +------------------+ | 1 Aaaa Aaaa Aaaa | | Aaa aa aaa aa | | aaaaaa A aa aaa.
static class	TessAPI.TessPageIterator
static interface	TessAPI.TessPageIteratorLevel Enum of the elements of the page hierarchy, used in ResultIterator to provide functions that operate on each level without having to have 5x as many functions.
static interface	TessAPI.TessPageSegMode Possible modes for page layout analysis.
static interface	TessAPI.TessPolyBlockType
static class	TessAPI.TessResultIterator
static interface	TessAPI.TessTextlineOrder The text lines are read in the given sequence. In English, the order is top-to-bottom.
static interface	TessAPI.TessWritingDirection The grapheme clusters within a line of text are laid out logically in this direction, judged when looking at the text line rotated so that its Orientation is "page up". For English text, the writing direction is left-to-right.

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 int	FALSE
static TessAPI	INSTANCE An instance of the class library.
static java.lang.String	LIB_NAME Native library name.
static java.lang.String	LIB_NAME_NON_WIN
static int	TRUE
static boolean	WINDOWS

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

Methods

Modifier and Type	Method and Description
int	TessBaseAPIAdaptToWordStr(TessAPI.TessBaseAPI handle, int mode, java.lang.String wordstr) Applies the given word to the adaptive classifier if possible.
com.sun.jna.ptr.IntByReference	TessBaseAPIAllWordConfidences(TessAPI.TessBaseAPI handle) Returns all word confidences (between 0 and 100) in an array, terminated by -1.
TessAPI.TessPageIterator	TessBaseAPIAnalyseLayout(TessAPI.TessBaseAPI handle) Runs page layout analysis in the mode set by SetPageSegMode.
void	TessBaseAPIClear(TessAPI.TessBaseAPI handle) Free up recognition results and any stored image data, without actually freeing any recognition data that would be time-consuming to reload.
void	TessBaseAPIClearAdaptiveClassifier(TessAPI.TessBaseAPI handle) Call between pages or documents etc to free up memory and forget adaptive data.
TessAPI.TessBaseAPI	TessBaseAPICreate() Creates an instance of the base class for all Tesseract APIs.
void	TessBaseAPIDelete(TessAPI.TessBaseAPI handle) Disposes the TesseractAPI instance.
void	TessBaseAPIEnd(TessAPI.TessBaseAPI handle) Close down tesseract and free up all memory.
com.sun.jna.ptr.PointerByReference	TessBaseAPIGetAvailableLanguagesAsVector(TessAPI.TessBaseAPI handle) Returns the available languages in the vector of STRINGs.
int	TessBaseAPIGetBoolVariable(TessAPI.TessBaseAPI handle, java.lang.String name, java.nio.IntBuffer value)
java.lang.String	TessBaseAPIGetBoxText(TessAPI.TessBaseAPI handle, int page_number) The recognized text is returned as a char* which is coded in the same format as a box file used in training.
int	TessBaseAPIGetDoubleVariable(TessAPI.TessBaseAPI handle, java.lang.String name, java.nio.DoubleBuffer value)
java.lang.String	TessBaseAPIGetHOCRText(TessAPI.TessBaseAPI handle, int page_number) Make a HTML-formatted string with hOCR markup from the internal data structures.
java.lang.String	TessBaseAPIGetInitLanguagesAsString(TessAPI.TessBaseAPI handle) Returns the languages string used in the last valid initialization.
int	TessBaseAPIGetIntVariable(TessAPI.TessBaseAPI handle, java.lang.String name, java.nio.IntBuffer value) Returns true (1) if the parameter was found among Tesseract parameters.
TessAPI.TessResultIterator	TessBaseAPIGetIterator(TessAPI.TessBaseAPI handle) Get a reading-order iterator to the results of LayoutAnalysis and/or Recognize.
com.sun.jna.ptr.PointerByReference	TessBaseAPIGetLoadedLanguagesAsVector(TessAPI.TessBaseAPI handle) Returns the loaded languages in the vector of STRINGs.
int	TessBaseAPIGetPageSegMode(TessAPI.TessBaseAPI handle) Return the current page segmentation mode.
java.lang.String	TessBaseAPIGetStringVariable(TessAPI.TessBaseAPI handle, java.lang.String name)
int	TessBaseAPIGetTextDirection(TessAPI.TessBaseAPI handle, java.nio.IntBuffer out_offset, java.nio.FloatBuffer out_slope)
java.lang.String	TessBaseAPIGetUnichar(TessAPI.TessBaseAPI handle, int unichar_id) This method returns the string form of the specified unichar.
java.lang.String	TessBaseAPIGetUNLVText(TessAPI.TessBaseAPI handle) The recognized text is returned as a char* which is coded as UNLV format Latin-1 with specific reject and suspect codes and must be freed with the delete [] operator.
java.lang.String	TessBaseAPIGetUTF8Text(TessAPI.TessBaseAPI handle) The recognized text is returned as a char* which is coded as UTF-8 and must be freed with the delete [] operator.
int	TessBaseAPIInit1(TessAPI.TessBaseAPI handle, java.lang.String datapath, java.lang.String language, int oem, com.sun.jna.ptr.PointerByReference configs, int configs_size) Instances are now mostly thread-safe and totally independent, but some global parameters remain.
int	TessBaseAPIInit2(TessAPI.TessBaseAPI handle, java.lang.String datapath, java.lang.String language, int oem)
int	TessBaseAPIInit3(TessAPI.TessBaseAPI handle, java.lang.String datapath, java.lang.String language)
void	TessBaseAPIInitForAnalysePage(TessAPI.TessBaseAPI handle) Init only for page layout analysis.
int	TessBaseAPIInitLangMod(TessAPI.TessBaseAPI handle, java.lang.String datapath, java.lang.String language) Init only the lang model component of Tesseract.
int	TessBaseAPIIsValidWord(TessAPI.TessBaseAPI handle, java.lang.String word) Check whether a word is valid according to Tesseract's language model.
int	TessBaseAPIMeanTextConf(TessAPI.TessBaseAPI handle) Returns the (average) confidence value between 0 and 100.
void	TessBaseAPIPrintVariablesToFile(TessAPI.TessBaseAPI handle, java.lang.String filename) Print Tesseract parameters to the given file. Note: Must not be the first method called after instance create.
java.lang.String	TessBaseAPIProcessPages(TessAPI.TessBaseAPI handle, java.lang.String filename, java.lang.String retry_config, int timeout_millisec) Recognizes all the pages in the named file, as a multi-page tiff or list of filenames, or single image, and gets the appropriate kind of text according to parameters: tessedit_create_boxfile, tessedit_make_boxes_from_boxes, tessedit_write_unlv, tessedit_create_hocr.
void	TessBaseAPIReadConfigFile(TessAPI.TessBaseAPI handle, java.lang.String filename, int init_only) Read a "config" file containing a set of param, value pairs.
int	TessBaseAPIRecognize(TessAPI.TessBaseAPI handle, TessAPI.ETEXT_DESC monitor) Recognize the image from SetAndThresholdImage, generating Tesseract internal structures.
int	TessBaseAPIRecognizeForChopTest(TessAPI.TessBaseAPI handle, TessAPI.ETEXT_DESC monitor) Variant on Recognize used for testing chopper.
java.lang.String	TessBaseAPIRect(TessAPI.TessBaseAPI handle, java.nio.ByteBuffer imagedata, int bytes_per_pixel, int bytes_per_line, int left, int top, int width, int height) Recognize a rectangle from an image and return the result as a string.
void	TessBaseAPISetImage(TessAPI.TessBaseAPI handle, java.nio.ByteBuffer imagedata, int width, int height, int bytes_per_pixel, int bytes_per_line) Provide an image for Tesseract to recognize.
void	TessBaseAPISetInputName(TessAPI.TessBaseAPI handle, java.lang.String name) Set the name of the input file.
void	TessBaseAPISetOutputName(TessAPI.TessBaseAPI handle, java.lang.String name) Set the name of the bonus output files.
void	TessBaseAPISetPageSegMode(TessAPI.TessBaseAPI handle, int mode) Set the current page segmentation mode.
void	TessBaseAPISetRectangle(TessAPI.TessBaseAPI handle, int left, int top, int width, int height) Restrict recognition to a sub-rectangle of the image.
void	TessBaseAPISetSourceResolution(TessAPI.TessBaseAPI handle, int ppi) Set the resolution of the source image in pixels per inch so font size information can be calculated in results.
int	TessBaseAPISetVariable(TessAPI.TessBaseAPI handle, java.lang.String name, java.lang.String value) Set the value of an internal "parameter." Supply the name of the parameter and the value as a string, just as you would in a config file.
java.lang.String	TessBaseGetInitLanguagesAsString(TessAPI.TessBaseAPI handle) Returns the languages string used in the last valid initialization.
int	TessPageIteratorBaseline(TessAPI.TessPageIterator handle, int level, java.nio.IntBuffer x1, java.nio.IntBuffer y1, java.nio.IntBuffer x2, java.nio.IntBuffer y2)
void	TessPageIteratorBegin(TessAPI.TessPageIterator handle)
int	TessPageIteratorBlockType(TessAPI.TessPageIterator handle)
int	TessPageIteratorBoundingBox(TessAPI.TessPageIterator handle, int level, java.nio.IntBuffer left, java.nio.IntBuffer top, java.nio.IntBuffer right, java.nio.IntBuffer bottom)
TessAPI.TessPageIterator	TessPageIteratorCopy(TessAPI.TessPageIterator handle)
void	TessPageIteratorDelete(TessAPI.TessPageIterator handle)
int	TessPageIteratorIsAtBeginningOf(TessAPI.TessPageIterator handle, int level)
int	TessPageIteratorIsAtFinalElement(TessAPI.TessPageIterator handle, int level, int element)
int	TessPageIteratorNext(TessAPI.TessPageIterator handle, int level)
void	TessPageIteratorOrientation(TessAPI.TessPageIterator handle, java.nio.IntBuffer orientation, java.nio.IntBuffer writing_direction, java.nio.IntBuffer textline_order, java.nio.FloatBuffer deskew_angle)
float	TessResultIteratorConfidence(TessAPI.TessResultIterator handle, int level)
TessAPI.TessResultIterator	TessResultIteratorCopy(TessAPI.TessResultIterator handle)
void	TessResultIteratorDelete(TessAPI.TessResultIterator handle)
TessAPI.TessPageIterator	TessResultIteratorGetPageIterator(TessAPI.TessResultIterator handle)
TessAPI.TessPageIterator	TessResultIteratorGetPageIteratorConst(TessAPI.TessResultIterator handle)
java.lang.String	TessResultIteratorGetUTF8Text(TessAPI.TessResultIterator handle, int level)
int	TessResultIteratorSymbolIsDropcap(TessAPI.TessResultIterator handle)
int	TessResultIteratorSymbolIsSubscript(TessAPI.TessResultIterator handle)
int	TessResultIteratorSymbolIsSuperscript(TessAPI.TessResultIterator handle)
java.lang.String	TessResultIteratorWordFontAttributes(TessAPI.TessResultIterator handle, java.nio.IntBuffer is_bold, java.nio.IntBuffer is_italic, java.nio.IntBuffer is_underlined, java.nio.IntBuffer is_monospace, java.nio.IntBuffer is_serif, java.nio.IntBuffer is_smallcaps, java.nio.IntBuffer pointsize, java.nio.IntBuffer font_id)
int	TessResultIteratorWordIsFromDictionary(TessAPI.TessResultIterator handle)
int	TessResultIteratorWordIsNumeric(TessAPI.TessResultIterator handle)
java.lang.String	TessVersion() Returns the version identifier.

Field Detail

WINDOWS

static final boolean WINDOWS

LIB_NAME

static final java.lang.String LIB_NAME

Native library name.

See Also:

Constant Field Values

LIB_NAME_NON_WIN

static final java.lang.String LIB_NAME_NON_WIN

See Also:

Constant Field Values

INSTANCE

static final TessAPI INSTANCE

An instance of the class library.

TRUE

static final int TRUE

See Also:

Constant Field Values

FALSE

static final int FALSE

See Also:

Constant Field Values

Method Detail

TessVersion

java.lang.String TessVersion()

Returns the version identifier.

TessBaseAPICreate

TessAPI.TessBaseAPI TessBaseAPICreate()

Creates an instance of the base class for all Tesseract APIs.

TessBaseAPIDelete

void TessBaseAPIDelete(TessAPI.TessBaseAPI handle)

Disposes the TesseractAPI instance.

TessBaseAPISetInputName

void TessBaseAPISetInputName(TessAPI.TessBaseAPI handle,
                           java.lang.String name)

Set the name of the input file. Needed only for training and reading a UNLV zone file.

TessBaseAPISetOutputName

void TessBaseAPISetOutputName(TessAPI.TessBaseAPI handle,
                            java.lang.String name)

Set the name of the bonus output files. Needed only for debugging.

TessBaseAPISetVariable

int TessBaseAPISetVariable(TessAPI.TessBaseAPI handle,
                         java.lang.String name,
                         java.lang.String value)

Set the value of an internal "parameter." Supply the name of the parameter and the value as a string, just as you would in a config file. Returns false if the name lookup failed. E.g., SetVariable("tessedit_char_blacklist", "xyz"); to ignore x, y and z. Or SetVariable("classify_bln_numeric_mode", "1"); to set numeric-only mode. SetVariable may be used before Init, but settings will revert to defaults on End().

Note: Must be called after Init(). Only works for non-init variables (init variables should be passed to Init()).

TessBaseAPIGetIntVariable

int TessBaseAPIGetIntVariable(TessAPI.TessBaseAPI handle,
                            java.lang.String name,
                            java.nio.IntBuffer value)

Returns true (1) if the parameter was found among Tesseract parameters. Fills in value with the value of the parameter.

TessBaseAPIGetBoolVariable

int TessBaseAPIGetBoolVariable(TessAPI.TessBaseAPI handle,
                             java.lang.String name,
                             java.nio.IntBuffer value)

TessBaseAPIGetDoubleVariable

int TessBaseAPIGetDoubleVariable(TessAPI.TessBaseAPI handle,
                               java.lang.String name,
                               java.nio.DoubleBuffer value)

TessBaseAPIGetStringVariable

java.lang.String TessBaseAPIGetStringVariable(TessAPI.TessBaseAPI handle,
                                            java.lang.String name)

TessBaseAPIPrintVariablesToFile

void TessBaseAPIPrintVariablesToFile(TessAPI.TessBaseAPI handle,
                                   java.lang.String filename)

Print Tesseract parameters to the given file.

Note: Must not be the first method called after instance create.

TessBaseAPIInit1

int TessBaseAPIInit1(TessAPI.TessBaseAPI handle,
                   java.lang.String datapath,
                   java.lang.String language,
                   int oem,
                   com.sun.jna.ptr.PointerByReference configs,
                   int configs_size)

Instances are now mostly thread-safe and totally independent, but some global parameters remain. Basically it is safe to use multiple TessBaseAPIs in different threads in parallel, UNLESS: you use SetVariable on some of the Params in classify and textord. If you do, then the effect will be to change it for all your instances.

Start tesseract. Returns zero on success and -1 on failure. NOTE that the only members that may be called before Init are those listed above here in the class definition.

The datapath must be the name of the parent directory of tessdata and must end in / . Any name after the last / will be stripped. The language is (usually) an ISO 639-3 string or NULL will default to eng. It is entirely safe (and eventually will be efficient too) to call Init multiple times on the same instance to change language, or just to reset the classifier. The language may be a string of the form [~][+[~]]* indicating that multiple languages are to be loaded. E.g., hin+eng will load Hindi and English. Languages may specify internally that they want to be loaded with one or more other languages, so the ~ sign is available to override that. E.g., if hin were set to load eng by default, then hin+~eng would force loading only hin. The number of loaded languages is limited only by memory, with the caveat that loading additional languages will impact both speed and accuracy, as there is more work to do to decide on the applicable language, and there is more chance of hallucinating incorrect words. WARNING: On changing languages, all Tesseract parameters are reset back to their default values. (Which may vary between languages.) If you have a rare need to set a Variable that controls initialization for a second call to Init you should explicitly call End() and then use SetVariable before Init. This is only a very rare use case, since there are very few uses that require any parameters to be set before Init.

If set_only_non_debug_params is true, only params that do not contain "debug" in the name will be set.

TessBaseAPIInit2

int TessBaseAPIInit2(TessAPI.TessBaseAPI handle,
                   java.lang.String datapath,
                   java.lang.String language,
                   int oem)

TessBaseAPIInit3

int TessBaseAPIInit3(TessAPI.TessBaseAPI handle,
                   java.lang.String datapath,
                   java.lang.String language)

TessBaseAPIGetInitLanguagesAsString

java.lang.String TessBaseAPIGetInitLanguagesAsString(TessAPI.TessBaseAPI handle)

Returns the languages string used in the last valid initialization. If the last initialization specified "deu+hin" then that will be returned. If hin loaded eng automatically as well, then that will not be included in this list. To find the languages actually loaded, use GetLoadedLanguagesAsVector. The returned string should NOT be deleted.

TessBaseAPIGetLoadedLanguagesAsVector

com.sun.jna.ptr.PointerByReference TessBaseAPIGetLoadedLanguagesAsVector(TessAPI.TessBaseAPI handle)

Returns the loaded languages in the vector of STRINGs. Includes all languages loaded by the last Init, including those loaded as dependencies of other loaded languages.

TessBaseAPIGetAvailableLanguagesAsVector

com.sun.jna.ptr.PointerByReference TessBaseAPIGetAvailableLanguagesAsVector(TessAPI.TessBaseAPI handle)

Returns the available languages in the vector of STRINGs.

TessBaseAPIInitLangMod

int TessBaseAPIInitLangMod(TessAPI.TessBaseAPI handle,
                         java.lang.String datapath,
                         java.lang.String language)

Init only the lang model component of Tesseract. The only functions that work after this init are SetVariable and IsValidWord. WARNING: temporary! This function will be removed from here and placed in a separate API at some future time.

TessBaseAPIInitForAnalysePage

void TessBaseAPIInitForAnalysePage(TessAPI.TessBaseAPI handle)

Init only for page layout analysis. Use only for calls to SetImage and AnalysePage. Calls that attempt recognition will generate an error.

TessBaseAPIReadConfigFile

void TessBaseAPIReadConfigFile(TessAPI.TessBaseAPI handle,
                             java.lang.String filename,
                             int init_only)

Read a "config" file containing a set of param, value pairs. Searches the standard places: tessdata/configs, tessdata/tessconfigs and also accepts a relative or absolute path name. Note: only non-init params will be set (init params are set by Init()).

TessBaseAPISetPageSegMode

void TessBaseAPISetPageSegMode(TessAPI.TessBaseAPI handle,
                             int mode)

Set the current page segmentation mode. Defaults to PSM_SINGLE_BLOCK. The mode is stored as an IntParam so it can also be modified by ReadConfigFile or SetVariable("tessedit_pageseg_mode", mode as string).

TessBaseAPIGetPageSegMode

int TessBaseAPIGetPageSegMode(TessAPI.TessBaseAPI handle)

Return the current page segmentation mode.

TessBaseAPIRect

java.lang.String TessBaseAPIRect(TessAPI.TessBaseAPI handle,
                               java.nio.ByteBuffer imagedata,
                               int bytes_per_pixel,
                               int bytes_per_line,
                               int left,
                               int top,
                               int width,
                               int height)

Recognize a rectangle from an image and return the result as a string. May be called many times for a single Init. Currently has no error checking. Greyscale of 8 and color of 24 or 32 bits per pixel may be given. Palette color images will not work properly and must be converted to 24 bit. Binary images of 1 bit per pixel may also be given but they must be byte packed with the MSB of the first byte being the first pixel, and a 1 represents WHITE. For binary images set bytes_per_pixel=0. The recognized text is returned as a char* which is coded as UTF8 and must be freed with the delete [] operator.

Note that TesseractRect is the simplified convenience interface. For advanced uses, use SetImage, (optionally) SetRectangle, Recognize, and one or more of the Get*Text functions below.

TessBaseAPIClearAdaptiveClassifier

void TessBaseAPIClearAdaptiveClassifier(TessAPI.TessBaseAPI handle)

Call between pages or documents etc to free up memory and forget adaptive data.

TessBaseAPISetImage

void TessBaseAPISetImage(TessAPI.TessBaseAPI handle,
                       java.nio.ByteBuffer imagedata,
                       int width,
                       int height,
                       int bytes_per_pixel,
                       int bytes_per_line)

Provide an image for Tesseract to recognize. Format is as TesseractRect above. Does not copy the image buffer, or take ownership. The source image may be destroyed after Recognize is called, either explicitly or implicitly via one of the Get*Text functions. SetImage clears all recognition results, and sets the rectangle to the full image, so it may be followed immediately by a GetUTF8Text, and it will automatically perform recognition.

TessBaseAPISetSourceResolution

void TessBaseAPISetSourceResolution(TessAPI.TessBaseAPI handle,
                                  int ppi)

Set the resolution of the source image in pixels per inch so font size information can be calculated in results. Call this after SetImage().

TessBaseAPISetRectangle

void TessBaseAPISetRectangle(TessAPI.TessBaseAPI handle,
                           int left,
                           int top,
                           int width,
                           int height)

Restrict recognition to a sub-rectangle of the image. Call after SetImage. Each SetRectangle clears the recognition results so multiple rectangles can be recognized with the same image.

TessBaseAPIAnalyseLayout

TessAPI.TessPageIterator TessBaseAPIAnalyseLayout(TessAPI.TessBaseAPI handle)

Runs page layout analysis in the mode set by SetPageSegMode. May optionally be called prior to Recognize to get access to just the page layout results. Returns an iterator to the results. Returns NULL on error. The returned iterator must be deleted after use. WARNING! This class points to data held within the TessBaseAPI class, and therefore can only be used while the TessBaseAPI class still exists and has not been subjected to a call of Init, SetImage, Recognize, Clear, End, DetectOS, or anything else that changes the internal PAGE_RES.

TessBaseAPIRecognize

int TessBaseAPIRecognize(TessAPI.TessBaseAPI handle,
                       TessAPI.ETEXT_DESC monitor)

Recognize the image from SetAndThresholdImage, generating Tesseract internal structures. Returns 0 on success. Optional. The Get*Text functions below will call Recognize if needed. After Recognize, the output is kept internally until the next SetImage.

TessBaseAPIRecognizeForChopTest

int TessBaseAPIRecognizeForChopTest(TessAPI.TessBaseAPI handle,
                                  TessAPI.ETEXT_DESC monitor)

Variant on Recognize used for testing chopper.

TessBaseAPIGetIterator

TessAPI.TessResultIterator TessBaseAPIGetIterator(TessAPI.TessBaseAPI handle)

Get a reading-order iterator to the results of LayoutAnalysis and/or Recognize. The returned iterator must be deleted after use. WARNING! This class points to data held within the TessBaseAPI class, and therefore can only be used while the TessBaseAPI class still exists and has not been subjected to a call of Init, SetImage, Recognize, Clear, End, DetectOS, or anything else that changes the internal PAGE_RES.

TessBaseAPIProcessPages

java.lang.String TessBaseAPIProcessPages(TessAPI.TessBaseAPI handle,
                                       java.lang.String filename,
                                       java.lang.String retry_config,
                                       int timeout_millisec)

Recognizes all the pages in the named file, as a multi-page tiff or list of filenames, or single image, and gets the appropriate kind of text according to parameters: tessedit_create_boxfile, tessedit_make_boxes_from_boxes, tessedit_write_unlv, tessedit_create_hocr. Calls ProcessPage on each page in the input file, which may be a multi-page tiff, single-page other file format, or a plain text list of images to read. If tessedit_page_number is non-negative, processing begins at that page of a multi-page tiff file, or filelist. The text is returned in text_out. Returns false on error. If non-zero timeout_millisec terminates processing after the timeout on a single page. If non-NULL and non-empty, and some page fails for some reason, the page is reprocessed with the retry_config config file. Useful for interactively debugging a bad page.

TessBaseAPIGetUTF8Text

java.lang.String TessBaseAPIGetUTF8Text(TessAPI.TessBaseAPI handle)

The recognized text is returned as a char* which is coded as UTF-8 and must be freed with the delete [] operator.

TessBaseAPIGetHOCRText

java.lang.String TessBaseAPIGetHOCRText(TessAPI.TessBaseAPI handle,
                                      int page_number)

Make a HTML-formatted string with hOCR markup from the internal data structures. page_number is 0-based but will appear in the output as 1-based.

TessBaseAPIGetBoxText

java.lang.String TessBaseAPIGetBoxText(TessAPI.TessBaseAPI handle,
                                     int page_number)

The recognized text is returned as a char* which is coded in the same format as a box file used in training. Returned string must be freed with the delete [] operator. Constructs coordinates in the original image - not just the rectangle. page_number is a 0-based page index that will appear in the box file.

TessBaseAPIGetUNLVText

java.lang.String TessBaseAPIGetUNLVText(TessAPI.TessBaseAPI handle)

The recognized text is returned as a char* which is coded as UNLV format Latin-1 with specific reject and suspect codes and must be freed with the delete [] operator.

TessBaseAPIMeanTextConf

int TessBaseAPIMeanTextConf(TessAPI.TessBaseAPI handle)

Returns the (average) confidence value between 0 and 100.

TessBaseAPIAllWordConfidences

com.sun.jna.ptr.IntByReference TessBaseAPIAllWordConfidences(TessAPI.TessBaseAPI handle)

Returns all word confidences (between 0 and 100) in an array, terminated by -1. The calling function must delete [] after use. The number of confidences should correspond to the number of space-delimited words in GetUTF8Text.

TessBaseAPIAdaptToWordStr

int TessBaseAPIAdaptToWordStr(TessAPI.TessBaseAPI handle,
                            int mode,
                            java.lang.String wordstr)

Applies the given word to the adaptive classifier if possible. The word must be SPACE-DELIMITED UTF-8 - l i k e t h i s , so it can tell the boundaries of the graphemes. Assumes that SetImage/SetRectangle have been used to set the image to the given word. The mode arg should be PSM_SINGLE_WORD or PSM_CIRCLE_WORD, as that will be used to control layout analysis. The currently set PageSegMode is preserved. Returns false if adaption was not possible for some reason.

TessBaseAPIClear

void TessBaseAPIClear(TessAPI.TessBaseAPI handle)

Free up recognition results and any stored image data, without actually freeing any recognition data that would be time-consuming to reload. Afterwards, you must call SetImage or TesseractRect before doing any Recognize or Get* operation.

TessBaseAPIEnd

void TessBaseAPIEnd(TessAPI.TessBaseAPI handle)

Close down tesseract and free up all memory. End() is equivalent to destructing and reconstructing your TessBaseAPI. Once End() has been used, none of the other API functions may be used other than Init and anything declared above it in the class definition.

TessBaseAPIIsValidWord

int TessBaseAPIIsValidWord(TessAPI.TessBaseAPI handle,
                         java.lang.String word)

Check whether a word is valid according to Tesseract's language model.

Returns:

0 if the word is invalid, non-zero if valid. @warning temporary! This function will be removed from here and placed in a separate API at some future time.

TessBaseAPIGetTextDirection

int TessBaseAPIGetTextDirection(TessAPI.TessBaseAPI handle,
                              java.nio.IntBuffer out_offset,
                              java.nio.FloatBuffer out_slope)

TessBaseAPIGetUnichar

java.lang.String TessBaseAPIGetUnichar(TessAPI.TessBaseAPI handle,
                                     int unichar_id)

This method returns the string form of the specified unichar.

TessBaseGetInitLanguagesAsString

java.lang.String TessBaseGetInitLanguagesAsString(TessAPI.TessBaseAPI handle)

Returns the languages string used in the last valid initialization. If the last initialization specified "deu+hin" then that will be returned. If hin loaded eng automatically as well, then that will not be included in this list. To find the languages actually loaded use GetLoadedLanguagesAsVector. The returned string should NOT be deleted.

TessPageIteratorDelete

void TessPageIteratorDelete(TessAPI.TessPageIterator handle)

TessPageIteratorCopy

TessAPI.TessPageIterator TessPageIteratorCopy(TessAPI.TessPageIterator handle)

TessPageIteratorBegin

void TessPageIteratorBegin(TessAPI.TessPageIterator handle)

TessPageIteratorNext

int TessPageIteratorNext(TessAPI.TessPageIterator handle,
                       int level)

TessPageIteratorIsAtBeginningOf

int TessPageIteratorIsAtBeginningOf(TessAPI.TessPageIterator handle,
                                  int level)

TessPageIteratorIsAtFinalElement

int TessPageIteratorIsAtFinalElement(TessAPI.TessPageIterator handle,
                                   int level,
                                   int element)

TessPageIteratorBoundingBox

int TessPageIteratorBoundingBox(TessAPI.TessPageIterator handle,
                              int level,
                              java.nio.IntBuffer left,
                              java.nio.IntBuffer top,
                              java.nio.IntBuffer right,
                              java.nio.IntBuffer bottom)

TessPageIteratorBlockType

int TessPageIteratorBlockType(TessAPI.TessPageIterator handle)

TessPageIteratorBaseline

int TessPageIteratorBaseline(TessAPI.TessPageIterator handle,
                           int level,
                           java.nio.IntBuffer x1,
                           java.nio.IntBuffer y1,
                           java.nio.IntBuffer x2,
                           java.nio.IntBuffer y2)

TessPageIteratorOrientation

void TessPageIteratorOrientation(TessAPI.TessPageIterator handle,
                               java.nio.IntBuffer orientation,
                               java.nio.IntBuffer writing_direction,
                               java.nio.IntBuffer textline_order,
                               java.nio.FloatBuffer deskew_angle)

TessResultIteratorDelete

void TessResultIteratorDelete(TessAPI.TessResultIterator handle)

TessResultIteratorCopy

TessAPI.TessResultIterator TessResultIteratorCopy(TessAPI.TessResultIterator handle)

TessResultIteratorGetPageIterator

TessAPI.TessPageIterator TessResultIteratorGetPageIterator(TessAPI.TessResultIterator handle)

TessResultIteratorGetPageIteratorConst

TessAPI.TessPageIterator TessResultIteratorGetPageIteratorConst(TessAPI.TessResultIterator handle)

TessResultIteratorGetUTF8Text

java.lang.String TessResultIteratorGetUTF8Text(TessAPI.TessResultIterator handle,
                                             int level)

TessResultIteratorConfidence

float TessResultIteratorConfidence(TessAPI.TessResultIterator handle,
                                 int level)

TessResultIteratorWordFontAttributes

java.lang.String TessResultIteratorWordFontAttributes(TessAPI.TessResultIterator handle,
                                                    java.nio.IntBuffer is_bold,
                                                    java.nio.IntBuffer is_italic,
                                                    java.nio.IntBuffer is_underlined,
                                                    java.nio.IntBuffer is_monospace,
                                                    java.nio.IntBuffer is_serif,
                                                    java.nio.IntBuffer is_smallcaps,
                                                    java.nio.IntBuffer pointsize,
                                                    java.nio.IntBuffer font_id)

TessResultIteratorWordIsFromDictionary

int TessResultIteratorWordIsFromDictionary(TessAPI.TessResultIterator handle)

TessResultIteratorWordIsNumeric

int TessResultIteratorWordIsNumeric(TessAPI.TessResultIterator handle)

TessResultIteratorSymbolIsSuperscript

int TessResultIteratorSymbolIsSuperscript(TessAPI.TessResultIterator handle)

TessResultIteratorSymbolIsSubscript

int TessResultIteratorSymbolIsSubscript(TessAPI.TessResultIterator handle)

TessResultIteratorSymbolIsDropcap

int TessResultIteratorSymbolIsDropcap(TessAPI.TessResultIterator handle)