TessAPI (Tess4J API)

All Superinterfaces:

ITessAPI, com.sun.jna.Library
```
public interface TessAPI
extends com.sun.jna.Library, ITessAPI
```
A Java wrapper for Tesseract OCR 3.03 API using JNA Interface Mapping.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.sun.jna.Library
  com.sun.jna.Library.Handler
- Nested classes/interfaces inherited from interface net.sourceforge.tess4j.ITessAPI
  ITessAPI.CANCEL_FUNC, ITessAPI.EANYCODE_CHAR, ITessAPI.ETEXT_DESC, ITessAPI.TessBaseAPI, ITessAPI.TessMutableIterator, ITessAPI.TessOcrEngineMode, ITessAPI.TessOrientation, ITessAPI.TessPageIterator, ITessAPI.TessPageIteratorLevel, ITessAPI.TessPageSegMode, ITessAPI.TessPolyBlockType, ITessAPI.TessResultIterator, ITessAPI.TessResultRenderer, ITessAPI.TessTextlineOrder, ITessAPI.TessWritingDirection, ITessAPI.TimeVal

Field Summary

Fields
Modifier and Type Field and Description

static TessAPI INSTANCE
An instance of the class library.
- 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
- Fields inherited from interface net.sourceforge.tess4j.ITessAPI
  FALSE, TRUE

Fields
Modifier and Type	Field and Description
`static TessAPI`	`INSTANCE` An instance of the class library.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`TessBaseAPIAdaptToWordStr(ITessAPI.TessBaseAPI handle, int mode, java.lang.String wordstr)` Applies the given word to the adaptive classifier if possible.
`com.sun.jna.ptr.IntByReference`	`TessBaseAPIAllWordConfidences(ITessAPI.TessBaseAPI handle)` Returns an array of all word confidences, terminated by -1.
`ITessAPI.TessPageIterator`	`TessBaseAPIAnalyseLayout(ITessAPI.TessBaseAPI handle)` Runs page layout analysis in the mode set by `SetPageSegMode`.
`void`	`TessBaseAPIClear(ITessAPI.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(ITessAPI.TessBaseAPI handle)` Call between pages or documents etc to free up memory and forget adaptive data.
`void`	`TessBaseAPIClearPersistentCache(ITessAPI.TessBaseAPI handle)` Clear any library-level memory caches.
`ITessAPI.TessBaseAPI`	`TessBaseAPICreate()` Creates an instance of the base class for all Tesseract APIs.
`void`	`TessBaseAPIDelete(ITessAPI.TessBaseAPI handle)` Disposes the TesseractAPI instance.
`void`	`TessBaseAPIDumpPGM(ITessAPI.TessBaseAPI handle, java.lang.String filename)` Dump the internal binary image to a PGM file.
`void`	`TessBaseAPIEnd(ITessAPI.TessBaseAPI handle)` Close down tesseract and free up all memory.
`com.sun.jna.ptr.PointerByReference`	`TessBaseAPIGetAvailableLanguagesAsVector(ITessAPI.TessBaseAPI handle)` Returns the available languages in the vector of STRINGs.
`int`	`TessBaseAPIGetBoolVariable(ITessAPI.TessBaseAPI handle, java.lang.String name, java.nio.IntBuffer value)` Get the value of an internal bool parameter.
`com.sun.jna.Pointer`	`TessBaseAPIGetBoxText(ITessAPI.TessBaseAPI handle, int page_number)` The recognized text is returned as a char* which is coded as a UTF8 box file and must be freed with the delete [] operator.
`java.lang.String`	`TessBaseAPIGetDatapath(ITessAPI.TessBaseAPI handle)`
`int`	`TessBaseAPIGetDoubleVariable(ITessAPI.TessBaseAPI handle, java.lang.String name, java.nio.DoubleBuffer value)` Get the value of an internal double parameter.
`com.sun.jna.Pointer`	`TessBaseAPIGetHOCRText(ITessAPI.TessBaseAPI handle, int page_number)` Make a HTML-formatted string with hOCR markup from the internal data structures.
`java.lang.String`	`TessBaseAPIGetInitLanguagesAsString(ITessAPI.TessBaseAPI handle)` Returns the languages string used in the last valid initialization.
`java.lang.String`	`TessBaseAPIGetInputName(ITessAPI.TessBaseAPI handle)` These functions are required for searchable PDF output.
`int`	`TessBaseAPIGetIntVariable(ITessAPI.TessBaseAPI handle, java.lang.String name, java.nio.IntBuffer value)` Get the value of an internal int parameter.
`ITessAPI.TessResultIterator`	`TessBaseAPIGetIterator(ITessAPI.TessBaseAPI handle)` Get a reading-order iterator to the results of LayoutAnalysis and/or `Recognize`.
`com.sun.jna.ptr.PointerByReference`	`TessBaseAPIGetLoadedLanguagesAsVector(ITessAPI.TessBaseAPI handle)` Returns the loaded languages in the vector of STRINGs.
`ITessAPI.TessMutableIterator`	`TessBaseAPIGetMutableIterator(ITessAPI.TessBaseAPI handle)` Get a mutable iterator to the results of LayoutAnalysis and/or `Recognize`.
`int`	`TessBaseAPIGetPageSegMode(ITessAPI.TessBaseAPI handle)` Return the current page segmentation mode.
`int`	`TessBaseAPIGetSourceYResolution(ITessAPI.TessBaseAPI handle)`
`java.lang.String`	`TessBaseAPIGetStringVariable(ITessAPI.TessBaseAPI handle, java.lang.String name)` Get the value of an internal string parameter.
`int`	`TessBaseAPIGetTextDirection(ITessAPI.TessBaseAPI handle, java.nio.IntBuffer out_offset, java.nio.FloatBuffer out_slope)` Gets text direction.
`int`	`TessBaseAPIGetThresholdedImageScaleFactor(ITessAPI.TessBaseAPI handle)`
`java.lang.String`	`TessBaseAPIGetUnichar(ITessAPI.TessBaseAPI handle, int unichar_id)` Gets the string of the specified unichar.
`com.sun.jna.Pointer`	`TessBaseAPIGetUNLVText(ITessAPI.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.
`com.sun.jna.Pointer`	`TessBaseAPIGetUTF8Text(ITessAPI.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(ITessAPI.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(ITessAPI.TessBaseAPI handle, java.lang.String datapath, java.lang.String language, int oem)`
`int`	`TessBaseAPIInit3(ITessAPI.TessBaseAPI handle, java.lang.String datapath, java.lang.String language)`
`int`	`TessBaseAPIInit4(ITessAPI.TessBaseAPI handle, java.lang.String datapath, java.lang.String language, int oem, com.sun.jna.ptr.PointerByReference configs, int configs_size, com.sun.jna.ptr.PointerByReference vars_vec, com.sun.jna.ptr.PointerByReference vars_values, NativeSize vars_vec_size, int set_only_non_debug_params)`
`void`	`TessBaseAPIInitForAnalysePage(ITessAPI.TessBaseAPI handle)` Init only for page layout analysis.
`int`	`TessBaseAPIInitLangMod(ITessAPI.TessBaseAPI handle, java.lang.String datapath, java.lang.String language)` Init only the lang model component of Tesseract.
`int`	`TessBaseAPIIsValidWord(ITessAPI.TessBaseAPI handle, java.lang.String word)` Check whether a word is valid according to Tesseract's language model.
`int`	`TessBaseAPIMeanTextConf(ITessAPI.TessBaseAPI handle)` Returns the average word confidence for Tesseract page result.
`void`	`TessBaseAPIPrintVariablesToFile(ITessAPI.TessBaseAPI handle, java.lang.String filename)` Print Tesseract parameters to the given file. Note: Must not be the first method called after instance create.
`com.sun.jna.Pointer`	`TessBaseAPIProcessPages(ITessAPI.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`.
`int`	`TessBaseAPIProcessPages1(ITessAPI.TessBaseAPI handle, java.lang.String filename, java.lang.String retry_config, int timeout_millisec, ITessAPI.TessResultRenderer renderer)`
`void`	`TessBaseAPIReadConfigFile(ITessAPI.TessBaseAPI handle, java.lang.String filename, int init_only)` Read a "config" file containing a set of param, value pairs.
`int`	`TessBaseAPIRecognize(ITessAPI.TessBaseAPI handle, ITessAPI.ETEXT_DESC monitor)` Recognize the image from `SetAndThresholdImage`, generating Tesseract internal structures.
`int`	`TessBaseAPIRecognizeForChopTest(ITessAPI.TessBaseAPI handle, ITessAPI.ETEXT_DESC monitor)` Variant on Recognize used for testing chopper.
`com.sun.jna.Pointer`	`TessBaseAPIRect(ITessAPI.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(ITessAPI.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(ITessAPI.TessBaseAPI handle, java.lang.String name)` Set the name of the input file.
`void`	`TessBaseAPISetOutputName(ITessAPI.TessBaseAPI handle, java.lang.String name)` Set the name of the bonus output files.
`void`	`TessBaseAPISetPageSegMode(ITessAPI.TessBaseAPI handle, int mode)` Set the current page segmentation mode.
`void`	`TessBaseAPISetRectangle(ITessAPI.TessBaseAPI handle, int left, int top, int width, int height)` Restrict recognition to a sub-rectangle of the image.
`void`	`TessBaseAPISetSourceResolution(ITessAPI.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(ITessAPI.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.
`ITessAPI.TessResultRenderer`	`TessBoxTextRendererCreate()`
`void`	`TessDeleteIntArray(java.nio.IntBuffer arr)` Deallocates the memory block occupied by integer array.
`void`	`TessDeleteResultRenderer(ITessAPI.TessResultRenderer renderer)`
`void`	`TessDeleteText(com.sun.jna.Pointer text)` Deallocates the memory block occupied by text.
`void`	`TessDeleteTextArray(com.sun.jna.ptr.PointerByReference arr)` Deallocates the memory block occupied by text array.
`ITessAPI.TessResultRenderer`	`TessHOcrRendererCreate()`
`int`	`TessPageIteratorBaseline(ITessAPI.TessPageIterator handle, int level, java.nio.IntBuffer x1, java.nio.IntBuffer y1, java.nio.IntBuffer x2, java.nio.IntBuffer y2)` Returns the baseline of the current object at the given level.
`void`	`TessPageIteratorBegin(ITessAPI.TessPageIterator handle)` Resets the iterator to point to the start of the page.
`int`	`TessPageIteratorBlockType(ITessAPI.TessPageIterator handle)` Returns the type of the current block.
`int`	`TessPageIteratorBoundingBox(ITessAPI.TessPageIterator handle, int level, java.nio.IntBuffer left, java.nio.IntBuffer top, java.nio.IntBuffer right, java.nio.IntBuffer bottom)` Returns the bounding rectangle of the current object at the given level in coordinates of the original image.
`ITessAPI.TessPageIterator`	`TessPageIteratorCopy(ITessAPI.TessPageIterator handle)` Creates a copy of the specified PageIterator instance.
`void`	`TessPageIteratorDelete(ITessAPI.TessPageIterator handle)` Deletes the specified PageIterator instance.
`int`	`TessPageIteratorIsAtBeginningOf(ITessAPI.TessPageIterator handle, int level)` Returns TRUE if the iterator is at the start of an object at the given level.
`int`	`TessPageIteratorIsAtFinalElement(ITessAPI.TessPageIterator handle, int level, int element)` Returns whether the iterator is positioned at the last element in a given level.
`int`	`TessPageIteratorNext(ITessAPI.TessPageIterator handle, int level)` Moves to the start of the next object at the given level in the page hierarchy, and returns false if the end of the page was reached.
`void`	`TessPageIteratorOrientation(ITessAPI.TessPageIterator handle, java.nio.IntBuffer orientation, java.nio.IntBuffer writing_direction, java.nio.IntBuffer textline_order, java.nio.FloatBuffer deskew_angle)` Returns the orientation.
`ITessAPI.TessResultRenderer`	`TessPDFRendererCreate(java.lang.String datadir)`
`float`	`TessResultIteratorConfidence(ITessAPI.TessResultIterator handle, int level)` Returns the mean confidence of the current object at the given level.
`ITessAPI.TessResultIterator`	`TessResultIteratorCopy(ITessAPI.TessResultIterator handle)` Creates a copy of the specified ResultIterator instance.
`void`	`TessResultIteratorDelete(ITessAPI.TessResultIterator handle)` Deletes the specified ResultIterator handle.
`ITessAPI.TessPageIterator`	`TessResultIteratorGetPageIterator(ITessAPI.TessResultIterator handle)` Gets the PageIterator of the specified ResultIterator instance.
`ITessAPI.TessPageIterator`	`TessResultIteratorGetPageIteratorConst(ITessAPI.TessResultIterator handle)` Gets the PageIterator of the specified ResultIterator instance.
`com.sun.jna.Pointer`	`TessResultIteratorGetUTF8Text(ITessAPI.TessResultIterator handle, int level)` Returns the null terminated UTF-8 encoded text string for the current object at the given level.
`int`	`TessResultIteratorSymbolIsDropcap(ITessAPI.TessResultIterator handle)` Returns TRUE if the current symbol is a dropcap.
`int`	`TessResultIteratorSymbolIsSubscript(ITessAPI.TessResultIterator handle)` Returns TRUE if the current symbol is a subscript.
`int`	`TessResultIteratorSymbolIsSuperscript(ITessAPI.TessResultIterator handle)` Returns TRUE if the current symbol is a superscript.
`java.lang.String`	`TessResultIteratorWordFontAttributes(ITessAPI.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)` Returns the font attributes of the current word.
`int`	`TessResultIteratorWordIsFromDictionary(ITessAPI.TessResultIterator handle)` Returns TRUE if the current word was found in a dictionary.
`int`	`TessResultIteratorWordIsNumeric(ITessAPI.TessResultIterator handle)` Returns TRUE if the current word is numeric.
`int`	`TessResultRendererAddError(ITessAPI.TessResultRenderer renderer, com.sun.jna.ptr.PointerByReference api)`
`int`	`TessResultRendererAddImage(ITessAPI.TessResultRenderer renderer, com.sun.jna.ptr.PointerByReference api)`
`int`	`TessResultRendererBeginDocument(ITessAPI.TessResultRenderer renderer, java.lang.String title)`
`int`	`TessResultRendererEndDocument(ITessAPI.TessResultRenderer renderer)`
`com.sun.jna.Pointer`	`TessResultRendererExtention(ITessAPI.TessResultRenderer renderer)`
`int`	`TessResultRendererGetOutput(ITessAPI.TessResultRenderer renderer, com.sun.jna.ptr.PointerByReference data, com.sun.jna.ptr.IntByReference data_len)`
`int`	`TessResultRendererImageNum(ITessAPI.TessResultRenderer renderer)`
`void`	`TessResultRendererInsert(ITessAPI.TessResultRenderer renderer, ITessAPI.TessResultRenderer next)`
`ITessAPI.TessResultRenderer`	`TessResultRendererNext(ITessAPI.TessResultRenderer renderer)`
`com.sun.jna.Pointer`	`TessResultRendererTitle(ITessAPI.TessResultRenderer renderer)`
`com.sun.jna.Pointer`	`TessResultRendererTypename(ITessAPI.TessResultRenderer renderer)`
`ITessAPI.TessResultRenderer`	`TessTextRendererCreate()`
`ITessAPI.TessResultRenderer`	`TessUnlvRendererCreate()`
`java.lang.String`	`TessVersion()` Gets the version identifier.

- Field Detail
  - INSTANCE
```
static final TessAPI INSTANCE
```
    An instance of the class library.
- Method Detail
  - TessVersion
```
java.lang.String TessVersion()
```
    Gets the version identifier.
    
    Returns:
    
    the version identifier
  - TessDeleteText
```
void TessDeleteText(com.sun.jna.Pointer text)
```
    Deallocates the memory block occupied by text.
    
    Parameters:
    
    text - the pointer to text
  - TessDeleteTextArray
```
void TessDeleteTextArray(com.sun.jna.ptr.PointerByReference arr)
```
    Deallocates the memory block occupied by text array.
    
    Parameters:
    
    arr - text array pointer reference
  - TessDeleteIntArray
```
void TessDeleteIntArray(java.nio.IntBuffer arr)
```
    Deallocates the memory block occupied by integer array.
    
    Parameters:
    
    arr - int array
  - TessTextRendererCreate
```
ITessAPI.TessResultRenderer TessTextRendererCreate()
```
  - TessHOcrRendererCreate
```
ITessAPI.TessResultRenderer TessHOcrRendererCreate()
```
  - TessPDFRendererCreate
```
ITessAPI.TessResultRenderer TessPDFRendererCreate(java.lang.String datadir)
```
  - TessUnlvRendererCreate
```
ITessAPI.TessResultRenderer TessUnlvRendererCreate()
```
  - TessBoxTextRendererCreate
```
ITessAPI.TessResultRenderer TessBoxTextRendererCreate()
```
  - TessDeleteResultRenderer
```
void TessDeleteResultRenderer(ITessAPI.TessResultRenderer renderer)
```
  - TessResultRendererInsert
```
void TessResultRendererInsert(ITessAPI.TessResultRenderer renderer,
                              ITessAPI.TessResultRenderer next)
```
  - TessResultRendererNext
```
ITessAPI.TessResultRenderer TessResultRendererNext(ITessAPI.TessResultRenderer renderer)
```
  - TessResultRendererBeginDocument
```
int TessResultRendererBeginDocument(ITessAPI.TessResultRenderer renderer,
                                    java.lang.String title)
```
  - TessResultRendererAddImage
```
int TessResultRendererAddImage(ITessAPI.TessResultRenderer renderer,
                               com.sun.jna.ptr.PointerByReference api)
```
  - TessResultRendererAddError
```
int TessResultRendererAddError(ITessAPI.TessResultRenderer renderer,
                               com.sun.jna.ptr.PointerByReference api)
```
  - TessResultRendererEndDocument
```
int TessResultRendererEndDocument(ITessAPI.TessResultRenderer renderer)
```
  - TessResultRendererGetOutput
```
int TessResultRendererGetOutput(ITessAPI.TessResultRenderer renderer,
                                com.sun.jna.ptr.PointerByReference data,
                                com.sun.jna.ptr.IntByReference data_len)
```
  - TessResultRendererTypename
```
com.sun.jna.Pointer TessResultRendererTypename(ITessAPI.TessResultRenderer renderer)
```
  - TessResultRendererExtention
```
com.sun.jna.Pointer TessResultRendererExtention(ITessAPI.TessResultRenderer renderer)
```
  - TessResultRendererTitle
```
com.sun.jna.Pointer TessResultRendererTitle(ITessAPI.TessResultRenderer renderer)
```
  - TessResultRendererImageNum
```
int TessResultRendererImageNum(ITessAPI.TessResultRenderer renderer)
```
  - TessBaseAPICreate
```
ITessAPI.TessBaseAPI TessBaseAPICreate()
```
    Creates an instance of the base class for all Tesseract APIs.
    
    Returns:
    
    the TesseractAPI instance
  - TessBaseAPIDelete
```
void TessBaseAPIDelete(ITessAPI.TessBaseAPI handle)
```
    Disposes the TesseractAPI instance.
    
    Parameters:
    
    handle - the TesseractAPI instance
  - TessBaseAPISetInputName
```
void TessBaseAPISetInputName(ITessAPI.TessBaseAPI handle,
                             java.lang.String name)
```
    Set the name of the input file. Needed only for training and reading a UNLV zone file, and for searchable PDF output.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    name - name of the input file
  - TessBaseAPIGetInputName
```
java.lang.String TessBaseAPIGetInputName(ITessAPI.TessBaseAPI handle)
```
    These functions are required for searchable PDF output. We need our hands on the input file so that we can include it in the PDF without transcoding. If that is not possible, we need the original image. Finally, resolution metadata is stored in the PDF so we need that as well.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    input file name
  - TessBaseAPIGetSourceYResolution
```
int TessBaseAPIGetSourceYResolution(ITessAPI.TessBaseAPI handle)
```
  - TessBaseAPIGetDatapath
```
java.lang.String TessBaseAPIGetDatapath(ITessAPI.TessBaseAPI handle)
```
  - TessBaseAPISetOutputName
```
void TessBaseAPISetOutputName(ITessAPI.TessBaseAPI handle,
                              java.lang.String name)
```
    Set the name of the bonus output files. Needed only for debugging.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    name - name of the output file
  - TessBaseAPISetVariable
```
int TessBaseAPISetVariable(ITessAPI.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()).
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    name - name of the input
    
    value - variable value
    
    Returns:
    
    1 on success
  - TessBaseAPIGetIntVariable
```
int TessBaseAPIGetIntVariable(ITessAPI.TessBaseAPI handle,
                              java.lang.String name,
                              java.nio.IntBuffer value)
```
    Get the value of an internal int parameter.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    name - name of the input
    
    value - pass the int buffer value
    
    Returns:
    
    1 on success
  - TessBaseAPIGetBoolVariable
```
int TessBaseAPIGetBoolVariable(ITessAPI.TessBaseAPI handle,
                               java.lang.String name,
                               java.nio.IntBuffer value)
```
    Get the value of an internal bool parameter.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    name - pass the name of the variable
    
    value - pass the int buffer value
    
    Returns:
    
    1 on success
  - TessBaseAPIGetDoubleVariable
```
int TessBaseAPIGetDoubleVariable(ITessAPI.TessBaseAPI handle,
                                 java.lang.String name,
                                 java.nio.DoubleBuffer value)
```
    Get the value of an internal double parameter.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    name - pass the name of the variable
    
    value - pass the double buffer value
    
    Returns:
    
    1 on success
  - TessBaseAPIGetStringVariable
```
java.lang.String TessBaseAPIGetStringVariable(ITessAPI.TessBaseAPI handle,
                                              java.lang.String name)
```
    Get the value of an internal string parameter.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    name - pass the name of the variable
    
    Returns:
    
    the string value
  - TessBaseAPIPrintVariablesToFile
```
void TessBaseAPIPrintVariablesToFile(ITessAPI.TessBaseAPI handle,
                                     java.lang.String filename)
```
    Print Tesseract parameters to the given file.
    
    Note: Must not be the first method called after instance create.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    filename - name of the file where the variables will be persisted
  - TessBaseAPIInit1
```
int TessBaseAPIInit1(ITessAPI.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.
    
    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. 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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    datapath - The datapath must be the name of the parent directory of tessdata and must end in /. Any name after the last / will be stripped.
    
    language - The language is (usually) an ISO 639-3 string or NULL will default to eng. The language may be a string of the form [~]<lang>[+[~]<lang>] indicating that multiple languages are to be loaded. E.g., hin+eng will load Hindi and English.
    
    oem - ocr engine mode
    
    configs - pointer configuration
    
    configs_size - pointer configuration size
    
    Returns:
    
    0 on success and -1 on initialization failure
  - TessBaseAPIInit2
```
int TessBaseAPIInit2(ITessAPI.TessBaseAPI handle,
                     java.lang.String datapath,
                     java.lang.String language,
                     int oem)
```
    Parameters:
    
    handle - the TesseractAPI instance
    
    datapath - The datapath must be the name of the parent directory of tessdata and must end in /. Any name after the last / will be stripped.
    
    language - The language is (usually) an ISO 639-3 string or NULL will default to eng. The language may be a string of the form [~]<lang>[+[~]<lang>] indicating that multiple languages are to be loaded. E.g., hin+eng will load Hindi and English.
    
    oem - ocr engine mode
    
    Returns:
    
    0 on success and -1 on initialization failure
  - TessBaseAPIInit3
```
int TessBaseAPIInit3(ITessAPI.TessBaseAPI handle,
                     java.lang.String datapath,
                     java.lang.String language)
```
    Parameters:
    
    handle - the TesseractAPI instance
    
    datapath - The datapath must be the name of the parent directory of tessdata and must end in /. Any name after the last / will be stripped.
    
    language - The language is (usually) an ISO 639-3 string or NULL will default to eng. The language may be a string of the form [~]<lang>[+[~]<lang>] indicating that multiple languages are to be loaded. E.g., hin+eng will load Hindi and English.
    
    Returns:
    
    0 on success and -1 on initialization failure
  - TessBaseAPIInit4
```
int TessBaseAPIInit4(ITessAPI.TessBaseAPI handle,
                     java.lang.String datapath,
                     java.lang.String language,
                     int oem,
                     com.sun.jna.ptr.PointerByReference configs,
                     int configs_size,
                     com.sun.jna.ptr.PointerByReference vars_vec,
                     com.sun.jna.ptr.PointerByReference vars_values,
                     NativeSize vars_vec_size,
                     int set_only_non_debug_params)
```
    Parameters:
    
    handle - the TesseractAPI instance
    
    datapath - The datapath must be the name of the parent directory of tessdata and must end in /. Any name after the last / will be stripped.
    
    language - The language is (usually) an ISO 639-3 string or NULL will default to eng. The language may be a string of the form [~]<lang>[+[~]<lang>] indicating that multiple languages are to be loaded. E.g., hin+eng will load Hindi and English.
    
    oem - ocr engine mode
    
    configs - pointer configuration
    
    configs_size - pointer configuration size
    
    vars_vec -
    
    vars_values -
    
    vars_vec_size -
    
    set_only_non_debug_params -
    
    Returns:
    
    0 on success and -1 on initialization failure
  - TessBaseAPIGetInitLanguagesAsString
```
java.lang.String TessBaseAPIGetInitLanguagesAsString(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    languages as string
  - TessBaseAPIGetLoadedLanguagesAsVector
```
com.sun.jna.ptr.PointerByReference TessBaseAPIGetLoadedLanguagesAsVector(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    loaded languages as vector
  - TessBaseAPIGetAvailableLanguagesAsVector
```
com.sun.jna.ptr.PointerByReference TessBaseAPIGetAvailableLanguagesAsVector(ITessAPI.TessBaseAPI handle)
```
    Returns the available languages in the vector of STRINGs.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    available languages as vector
  - TessBaseAPIInitLangMod
```
int TessBaseAPIInitLangMod(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    datapath - The datapath must be the name of the parent directory of tessdata and must end in /. Any name after the last / will be stripped.
    
    language - The language is (usually) an ISO 639-3 string or NULL will default to eng. The language may be a string of the form [~]<lang>[+[~]<lang>] indicating that multiple languages are to be loaded. E.g., hin+eng will load Hindi and English.
    
    Returns:
    
    api init language mode
  - TessBaseAPIInitForAnalysePage
```
void TessBaseAPIInitForAnalysePage(ITessAPI.TessBaseAPI handle)
```
    Init only for page layout analysis. Use only for calls to SetImage and AnalysePage. Calls that attempt recognition will generate an error.
    
    Parameters:
    
    handle - the TesseractAPI instance
  - TessBaseAPIReadConfigFile
```
void TessBaseAPIReadConfigFile(ITessAPI.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()).
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    filename - relative or absolute path for the "config" file containing a set of param and value pairs
    
    init_only -
  - TessBaseAPISetPageSegMode
```
void TessBaseAPISetPageSegMode(ITessAPI.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).
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    mode - tesseract page segment mode
  - TessBaseAPIGetPageSegMode
```
int TessBaseAPIGetPageSegMode(ITessAPI.TessBaseAPI handle)
```
    Return the current page segmentation mode.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    page segment mode value
  - TessBaseAPIRect
```
com.sun.jna.Pointer TessBaseAPIRect(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    imagedata - image byte buffer
    
    bytes_per_pixel - bytes per pixel
    
    bytes_per_line - bytes per line
    
    left - image left
    
    top - image top
    
    width - image width
    
    height - image height
    
    Returns:
    
    the pointer to recognized text
  - TessBaseAPIClearAdaptiveClassifier
```
void TessBaseAPIClearAdaptiveClassifier(ITessAPI.TessBaseAPI handle)
```
    Call between pages or documents etc to free up memory and forget adaptive data.
    
    Parameters:
    
    handle - the TesseractAPI instance
  - TessBaseAPISetImage
```
void TessBaseAPISetImage(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    imagedata - image byte buffer
    
    width - image width
    
    height - image height
    
    bytes_per_pixel - bytes per pixel
    
    bytes_per_line - bytes per line
  - TessBaseAPISetSourceResolution
```
void TessBaseAPISetSourceResolution(ITessAPI.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().
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    ppi - source resolution value
  - TessBaseAPISetRectangle
```
void TessBaseAPISetRectangle(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    left - value
    
    top - value
    
    width - value
    
    height - value
  - TessBaseAPIGetThresholdedImageScaleFactor
```
int TessBaseAPIGetThresholdedImageScaleFactor(ITessAPI.TessBaseAPI handle)
```
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    Scale factor from original image.
  - TessBaseAPIDumpPGM
```
void TessBaseAPIDumpPGM(ITessAPI.TessBaseAPI handle,
                        java.lang.String filename)
```
    Dump the internal binary image to a PGM file.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    filename - pgm file name
  - TessBaseAPIAnalyseLayout
```
ITessAPI.TessPageIterator TessBaseAPIAnalyseLayout(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    returns an iterator to the results. Returns NULL on error. The returned iterator must be deleted after use.
  - TessBaseAPIRecognize
```
int TessBaseAPIRecognize(ITessAPI.TessBaseAPI handle,
                         ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    monitor - the result as Tesseract internal structures
    
    Returns:
    
    0 on success
  - TessBaseAPIRecognizeForChopTest
```
int TessBaseAPIRecognizeForChopTest(ITessAPI.TessBaseAPI handle,
                                    ITessAPI.ETEXT_DESC monitor)
```
    Variant on Recognize used for testing chopper.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    monitor - the result as Tesseract internal structures
    
    Returns:
    
    0 on success
  - TessBaseAPIGetIterator
```
ITessAPI.TessResultIterator TessBaseAPIGetIterator(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    the result iterator
  - TessBaseAPIGetMutableIterator
```
ITessAPI.TessMutableIterator TessBaseAPIGetMutableIterator(ITessAPI.TessBaseAPI handle)
```
    Get a mutable 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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    the mutable iterator
  - TessBaseAPIProcessPages
```
com.sun.jna.Pointer TessBaseAPIProcessPages(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    filename - multi-page tiff or list of filenames
    
    retry_config - retry config values
    
    timeout_millisec - timeout value
    
    Returns:
    
    the pointer to output text
  - TessBaseAPIProcessPages1
```
int TessBaseAPIProcessPages1(ITessAPI.TessBaseAPI handle,
                             java.lang.String filename,
                             java.lang.String retry_config,
                             int timeout_millisec,
                             ITessAPI.TessResultRenderer renderer)
```
  - TessBaseAPIGetUTF8Text
```
com.sun.jna.Pointer TessBaseAPIGetUTF8Text(ITessAPI.TessBaseAPI handle)
```
    The recognized text is returned as a char* which is coded as UTF-8 and must be freed with the delete [] operator.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    the pointer to output text
  - TessBaseAPIGetHOCRText
```
com.sun.jna.Pointer TessBaseAPIGetHOCRText(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    page_number - page number
    
    Returns:
    
    the pointer to hOCR text
  - TessBaseAPIGetBoxText
```
com.sun.jna.Pointer TessBaseAPIGetBoxText(ITessAPI.TessBaseAPI handle,
                                          int page_number)
```
    The recognized text is returned as a char* which is coded as a UTF8 box file and must be freed with the delete [] operator. page_number is a 0-base page index that will appear in the box file.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    page_number - number of the page
    
    Returns:
    
    the pointer to box text
  - TessBaseAPIGetUNLVText
```
com.sun.jna.Pointer TessBaseAPIGetUNLVText(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    the pointer to UNLV text
  - TessBaseAPIMeanTextConf
```
int TessBaseAPIMeanTextConf(ITessAPI.TessBaseAPI handle)
```
    Returns the average word confidence for Tesseract page result.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    the (average) confidence value between 0 and 100.
  - TessBaseAPIAllWordConfidences
```
com.sun.jna.ptr.IntByReference TessBaseAPIAllWordConfidences(ITessAPI.TessBaseAPI handle)
```
    Returns an array of all word confidences, 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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    Returns:
    
    all word confidences (between 0 and 100) in an array, terminated by -1
  - TessBaseAPIAdaptToWordStr
```
int TessBaseAPIAdaptToWordStr(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    mode - tesseract page segment mode
    
    wordstr - 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.
    
    Returns:
    
    false if adaption was not possible for some reason.
  - TessBaseAPIClear
```
void TessBaseAPIClear(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
  - TessBaseAPIEnd
```
void TessBaseAPIEnd(ITessAPI.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.
    
    Parameters:
    
    handle - the TesseractAPI instance
  - TessBaseAPIIsValidWord
```
int TessBaseAPIIsValidWord(ITessAPI.TessBaseAPI handle,
                           java.lang.String word)
```
    Check whether a word is valid according to Tesseract's language model.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    word - word value
    
    Returns:
    
    0 if the word is invalid, non-zero if valid
  - TessBaseAPIGetTextDirection
```
int TessBaseAPIGetTextDirection(ITessAPI.TessBaseAPI handle,
                                java.nio.IntBuffer out_offset,
                                java.nio.FloatBuffer out_slope)
```
    Gets text direction.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    out_offset - offset
    
    out_slope - slope
    
    Returns:
    
    TRUE if text direction is valid
  - TessBaseAPIClearPersistentCache
```
void TessBaseAPIClearPersistentCache(ITessAPI.TessBaseAPI handle)
```
    Clear any library-level memory caches. There are a variety of expensive-to-load constant data structures (mostly language dictionaries) that are cached globally -- surviving the Init() and End() of individual TessBaseAPI's. This function allows the clearing of these caches.
    
    Parameters:
    
    handle - the TesseractAPI instance
  - TessBaseAPIGetUnichar
```
java.lang.String TessBaseAPIGetUnichar(ITessAPI.TessBaseAPI handle,
                                       int unichar_id)
```
    Gets the string of the specified unichar.
    
    Parameters:
    
    handle - the TesseractAPI instance
    
    unichar_id - the unichar id
    
    Returns:
    
    the string form of the specified unichar.
  - TessPageIteratorDelete
```
void TessPageIteratorDelete(ITessAPI.TessPageIterator handle)
```
    Deletes the specified PageIterator instance.
    
    Parameters:
    
    handle - the TessPageIterator instance
  - TessPageIteratorCopy
```
ITessAPI.TessPageIterator TessPageIteratorCopy(ITessAPI.TessPageIterator handle)
```
    Creates a copy of the specified PageIterator instance.
    
    Parameters:
    
    handle - the TessPageIterator instance
    
    Returns:
    
    page iterator copy
  - TessPageIteratorBegin
```
void TessPageIteratorBegin(ITessAPI.TessPageIterator handle)
```
    Resets the iterator to point to the start of the page.
    
    Parameters:
    
    handle - the TessPageIterator instance
  - TessPageIteratorNext
```
int TessPageIteratorNext(ITessAPI.TessPageIterator handle,
                         int level)
```
    Moves to the start of the next object at the given level in the page hierarchy, and returns false if the end of the page was reached. NOTE (CHANGED!) that ALL PageIteratorLevel level values will visit each non-text block at least once.
    Think of non text blocks as containing a single para, with at least one line, with a single imaginary word, containing a single symbol. The bounding boxes mark out any polygonal nature of the block, and PTIsTextType(BLockType()) is false for non-text blocks.
    Calls to Next with different levels may be freely intermixed. This function iterates words in right-to-left scripts correctly, if the appropriate language has been loaded into Tesseract.
    
    Parameters:
    
    handle - the TessPageIterator instance
    
    level - tesseract page level
    
    Returns:
    
    next iterator object
  - TessPageIteratorIsAtBeginningOf
```
int TessPageIteratorIsAtBeginningOf(ITessAPI.TessPageIterator handle,
                                    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:
    
    handle - the TessPageIterator instance
    
    level - tesseract page level
    
    Returns:
    
    1 if true
  - TessPageIteratorIsAtFinalElement
```
int TessPageIteratorIsAtFinalElement(ITessAPI.TessPageIterator handle,
                                     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:
    
    handle - the TessPageIterator instance
    
    level - tesseract page level
    
    element - page iterator level
    
    Returns:
    
    1 if true
  - TessPageIteratorBoundingBox
```
int TessPageIteratorBoundingBox(ITessAPI.TessPageIterator handle,
                                int level,
                                java.nio.IntBuffer left,
                                java.nio.IntBuffer top,
                                java.nio.IntBuffer right,
                                java.nio.IntBuffer bottom)
```
    Returns the bounding rectangle of the current object at the given level in coordinates of the original image.
    
    Parameters:
    
    handle - the TessPageIterator instance
    
    level - tesseract page level
    
    left - int buffer position
    
    top - int buffer position
    
    right - int buffer position
    
    bottom - int buffer position
    
    Returns:
    
    FALSE if there is no such object at the current position
  - TessPageIteratorBlockType
```
int TessPageIteratorBlockType(ITessAPI.TessPageIterator handle)
```
    Returns the type of the current block.
    
    Parameters:
    
    handle - the TessPageIterator instance
    
    Returns:
    
    TessPolyBlockType value
  - TessPageIteratorBaseline
```
int TessPageIteratorBaseline(ITessAPI.TessPageIterator handle,
                             int level,
                             java.nio.IntBuffer x1,
                             java.nio.IntBuffer y1,
                             java.nio.IntBuffer x2,
                             java.nio.IntBuffer y2)
```
    Returns the baseline of the current object at the given level. The baseline is the line that passes through (x1, y1) and (x2, y2).
    WARNING: with vertical text, baselines may be vertical!
    
    Parameters:
    
    handle - the TessPageIterator instance
    
    level - tesseract page level
    
    x1 - int buffer position
    
    y1 - int buffer position
    
    x2 - int buffer position
    
    y2 - int buffer position
    
    Returns:
    
    TRUE if the baseline is valid
  - TessPageIteratorOrientation
```
void TessPageIteratorOrientation(ITessAPI.TessPageIterator handle,
                                 java.nio.IntBuffer orientation,
                                 java.nio.IntBuffer writing_direction,
                                 java.nio.IntBuffer textline_order,
                                 java.nio.FloatBuffer deskew_angle)
```
    Returns the orientation.
    
    Parameters:
    
    handle - the TessPageIterator instance
    
    orientation - orientation value
    
    writing_direction - writing direction value
    
    textline_order - text line order
    
    deskew_angle - deskew angle
  - TessResultIteratorDelete
```
void TessResultIteratorDelete(ITessAPI.TessResultIterator handle)
```
    Deletes the specified ResultIterator handle.
    
    Parameters:
    
    handle - the TessResultIterator instance
  - TessResultIteratorCopy
```
ITessAPI.TessResultIterator TessResultIteratorCopy(ITessAPI.TessResultIterator handle)
```
    Creates a copy of the specified ResultIterator instance.
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    Returns:
    
    the copy object
  - TessResultIteratorGetPageIterator
```
ITessAPI.TessPageIterator TessResultIteratorGetPageIterator(ITessAPI.TessResultIterator handle)
```
    Gets the PageIterator of the specified ResultIterator instance.
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    Returns:
    
    the page iterator
  - TessResultIteratorGetPageIteratorConst
```
ITessAPI.TessPageIterator TessResultIteratorGetPageIteratorConst(ITessAPI.TessResultIterator handle)
```
    Gets the PageIterator of the specified ResultIterator instance.
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    Returns:
    
    the page iterator constant
  - TessResultIteratorGetUTF8Text
```
com.sun.jna.Pointer TessResultIteratorGetUTF8Text(ITessAPI.TessResultIterator handle,
                                                  int level)
```
    Returns the null terminated UTF-8 encoded text string for the current object at the given level. Use delete [] to free after use.
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    level - tesseract page level
    
    Returns:
    
    the pointer to recognized text
  - TessResultIteratorConfidence
```
float TessResultIteratorConfidence(ITessAPI.TessResultIterator handle,
                                   int level)
```
    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).
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    level - tesseract page level
    
    Returns:
    
    confidence value
  - TessResultIteratorWordFontAttributes
```
java.lang.String TessResultIteratorWordFontAttributes(ITessAPI.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)
```
    Returns the font attributes of the current word. If iterating at a higher level object than words, e.g., textlines, then this will return the attributes of the first word in that textline. The actual return value is a string representing a font name. It points to an internal table and SHOULD NOT BE DELETED. Lifespan is the same as the iterator itself, ie rendered invalid by various members of TessBaseAPI, including Init, SetImage, End or deleting the TessBaseAPI. Pointsize is returned in printers points (1/72 inch).
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    is_bold - font attribute
    
    is_italic - font attribute
    
    is_underlined - font attribute
    
    is_monospace - font attribute
    
    is_serif - font attribute
    
    is_smallcaps - font attribute
    
    pointsize - font attribute
    
    font_id - font attribute
    
    Returns:
    
    font name
  - TessResultIteratorWordIsFromDictionary
```
int TessResultIteratorWordIsFromDictionary(ITessAPI.TessResultIterator handle)
```
    Returns TRUE if the current word was found in a dictionary.
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    Returns:
    
    1 if word is from dictionary
  - TessResultIteratorWordIsNumeric
```
int TessResultIteratorWordIsNumeric(ITessAPI.TessResultIterator handle)
```
    Returns TRUE if the current word is numeric.
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    Returns:
    
    1 if word is numeric
  - TessResultIteratorSymbolIsSuperscript
```
int TessResultIteratorSymbolIsSuperscript(ITessAPI.TessResultIterator handle)
```
    Returns TRUE if the current symbol is a superscript. If iterating at a higher level object than symbols, e.g., words, then this will return the attributes of the first symbol in that word.
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    Returns:
    
    1 if symbol is superscript
  - TessResultIteratorSymbolIsSubscript
```
int TessResultIteratorSymbolIsSubscript(ITessAPI.TessResultIterator handle)
```
    Returns TRUE if the current symbol is a subscript. If iterating at a higher level object than symbols, e.g., words, then this will return the attributes of the first symbol in that word.
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    Returns:
    
    1 if symbol is subscript
  - TessResultIteratorSymbolIsDropcap
```
int TessResultIteratorSymbolIsDropcap(ITessAPI.TessResultIterator handle)
```
    Returns TRUE if the current symbol is a dropcap. If iterating at a higher level object than symbols, e.g., words, then this will return the attributes of the first symbol in that word.
    
    Parameters:
    
    handle - the TessResultIterator instance
    
    Returns:
    
    1 if symbol is dropcap

Interface TessAPI

Nested Class Summary

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

Nested classes/interfaces inherited from interface net.sourceforge.tess4j.ITessAPI

Field Summary

Fields inherited from interface com.sun.jna.Library

Fields inherited from interface net.sourceforge.tess4j.ITessAPI

Method Summary

Field Detail

INSTANCE

Method Detail

TessVersion

TessDeleteText

TessDeleteTextArray

TessDeleteIntArray

TessTextRendererCreate

TessHOcrRendererCreate

TessPDFRendererCreate

TessUnlvRendererCreate

TessBoxTextRendererCreate

TessDeleteResultRenderer

TessResultRendererInsert

TessResultRendererNext

TessResultRendererBeginDocument

TessResultRendererAddImage

TessResultRendererAddError

TessResultRendererEndDocument

TessResultRendererGetOutput

TessResultRendererTypename

TessResultRendererExtention

TessResultRendererTitle

TessResultRendererImageNum

TessBaseAPICreate

TessBaseAPIDelete

TessBaseAPISetInputName

TessBaseAPIGetInputName

TessBaseAPIGetSourceYResolution

TessBaseAPIGetDatapath

TessBaseAPISetOutputName

TessBaseAPISetVariable

TessBaseAPIGetIntVariable

TessBaseAPIGetBoolVariable

TessBaseAPIGetDoubleVariable

TessBaseAPIGetStringVariable

TessBaseAPIPrintVariablesToFile

TessBaseAPIInit1

TessBaseAPIInit2

TessBaseAPIInit3

TessBaseAPIInit4

TessBaseAPIGetInitLanguagesAsString

TessBaseAPIGetLoadedLanguagesAsVector

TessBaseAPIGetAvailableLanguagesAsVector

TessBaseAPIInitLangMod

TessBaseAPIInitForAnalysePage

TessBaseAPIReadConfigFile

TessBaseAPISetPageSegMode

TessBaseAPIGetPageSegMode

TessBaseAPIRect

TessBaseAPIClearAdaptiveClassifier

TessBaseAPISetImage

TessBaseAPISetSourceResolution

TessBaseAPISetRectangle

TessBaseAPIGetThresholdedImageScaleFactor

TessBaseAPIDumpPGM

TessBaseAPIAnalyseLayout

TessBaseAPIRecognize

TessBaseAPIRecognizeForChopTest

TessBaseAPIGetIterator

TessBaseAPIGetMutableIterator

TessBaseAPIProcessPages

TessBaseAPIProcessPages1

TessBaseAPIGetUTF8Text

TessBaseAPIGetHOCRText

TessBaseAPIGetBoxText

TessBaseAPIGetUNLVText

TessBaseAPIMeanTextConf

TessBaseAPIAllWordConfidences

TessBaseAPIAdaptToWordStr

TessBaseAPIClear

TessBaseAPIEnd