org.bytedeco.javacpp

Class tesseract.TessBaseAPI

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.tesseract.TessBaseAPI

All Implemented Interfaces:

AutoCloseable

Enclosing class:

tesseract

@Namespace(value="tesseract")
@NoOffset
public static class tesseract.TessBaseAPI
extends Pointer

Base class for all tesseract APIs. Specific classes can add ability to work on different inputs or produce different outputs. This class is mostly an interface layer on top of the Tesseract instance class to hide the data types so that users of this class don't have to include any other Tesseract headers.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
tesseract.TessBaseAPI()
tesseract.TessBaseAPI(long size) Native array allocator.
tesseract.TessBaseAPI(Pointer p) Pointer cast constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	AdaptToWordStr(int mode, BytePointer wordstr) Applies the given word to the adaptive classifier if possible.
boolean	AdaptToWordStr(int mode, String wordstr)
IntPointer	AllWordConfidences() Returns all word confidences (between 0 and 100) in an array, terminated by -1.
tesseract.PageIterator	AnalyseLayout() Runs page layout analysis in the mode set by SetPageSegMode.
tesseract.PageIterator	AnalyseLayout(boolean merge_similar_words)
static void	CatchSignals() Writes the thresholded image to stderr as a PBM file on receipt of a SIGSEGV, SIGFPE, or SIGBUS signal.
void	Clear() Free up recognition results and any stored image data, without actually freeing any recognition data that would be time-consuming to reload.
void	ClearAdaptiveClassifier() Call between pages or documents etc to free up memory and forget adaptive data.
static void	ClearPersistentCache() Clear any library-level memory caches.
static void	DeleteBlockList(tesseract.BLOCK_LIST block_list) Delete a block list.
boolean	DetectOS(tesseract.OSResults arg0) Estimates the Orientation And Script of the image.
void	DumpPGM(BytePointer filename) Deprecated. Use GetThresholdedImage and write the image using pixWrite instead if possible.
void	DumpPGM(String filename)
void	End() Close down tesseract and free up all memory.
tesseract.BLOCK_LIST	FindLinesCreateBlockList() Find lines from the image making the BLOCK_LIST.
static tesseract.ROW	FindRowForBox(tesseract.BLOCK_LIST blocks, int left, int top, int right, int bottom) This method returns the row to which a box of specified dimensions would belong.
void	GetAvailableLanguagesAsVector(tesseract.StringGenericVector langs) Returns the available languages in the vector of STRINGs.
void	GetBlockTextOrientations(int[] block_orientation, boolean[] vertical_writing)
void	GetBlockTextOrientations(int[] block_orientation, BoolPointer vertical_writing)
void	GetBlockTextOrientations(IntBuffer block_orientation, boolean[] vertical_writing)
void	GetBlockTextOrientations(IntBuffer block_orientation, BoolPointer vertical_writing)
void	GetBlockTextOrientations(IntPointer block_orientation, boolean[] vertical_writing)
void	GetBlockTextOrientations(IntPointer block_orientation, BoolPointer vertical_writing)
void	GetBlockTextOrientations(PointerPointer block_orientation, PointerPointer vertical_writing) Return text orientation of each block as determined by an earlier run of layout analysis.
boolean	GetBoolVariable(BytePointer name, BoolPointer value)
boolean	GetBoolVariable(String name, boolean[] value)
BytePointer	GetBoxText(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.
lept.BOXA	GetComponentImages(int level, boolean text_only, boolean raw_image, int raw_padding, lept.PIXA pixa, int[] blockids, int[] paraids)
lept.BOXA	GetComponentImages(int level, boolean text_only, boolean raw_image, int raw_padding, lept.PIXA pixa, IntBuffer blockids, IntBuffer paraids)
lept.BOXA	GetComponentImages(int level, boolean text_only, boolean raw_image, int raw_padding, lept.PIXA pixa, IntPointer blockids, IntPointer paraids)
lept.BOXA	GetComponentImages(int level, boolean text_only, boolean raw_image, int raw_padding, PointerPointer pixa, PointerPointer blockids, PointerPointer paraids) Get the given level kind of components (block, textline, word etc.) as a leptonica-style Boxa, Pixa pair, in reading order.
lept.BOXA	GetComponentImages(int level, boolean text_only, lept.PIXA pixa, int[] blockids)
lept.BOXA	GetComponentImages(int level, boolean text_only, lept.PIXA pixa, IntBuffer blockids)
lept.BOXA	GetComponentImages(int level, boolean text_only, lept.PIXA pixa, IntPointer blockids)
lept.BOXA	GetComponentImages(int level, boolean text_only, PointerPointer pixa, PointerPointer blockids)
lept.BOXA	GetConnectedComponents(lept.PIXA cc)
lept.BOXA	GetConnectedComponents(PointerPointer cc) Gets the individual connected (text) components (created after pages segmentation step, but before recognition) as a leptonica-style Boxa, Pixa pair, in reading order.
tesseract.CubeRecoContext	GetCubeRecoContext() Return a pointer to underlying CubeRecoContext object if present.
BytePointer	GetDatapath()
tesseract.Dawg	GetDawg(int i) Return the pointer to the i-th dawg loaded into tesseract_ object.
boolean	GetDoubleVariable(BytePointer name, double[] value)
boolean	GetDoubleVariable(BytePointer name, DoubleBuffer value)
boolean	GetDoubleVariable(BytePointer name, DoublePointer value)
boolean	GetDoubleVariable(String name, double[] value)
boolean	GetDoubleVariable(String name, DoubleBuffer value)
boolean	GetDoubleVariable(String name, DoublePointer value)
void	GetFeaturesForBlob(tesseract.TBLOB blob, tesseract.INT_FEATURE_STRUCT int_features, int[] num_features, int[] feature_outline_index)
void	GetFeaturesForBlob(tesseract.TBLOB blob, tesseract.INT_FEATURE_STRUCT int_features, IntBuffer num_features, IntBuffer feature_outline_index)
void	GetFeaturesForBlob(tesseract.TBLOB blob, tesseract.INT_FEATURE_STRUCT int_features, IntPointer num_features, IntPointer feature_outline_index) This method returns the features associated with the input image.
BytePointer	GetHOCRText(int page_number) Make a HTML-formatted string with hOCR markup from the internal data structures.
BytePointer	GetInitLanguagesAsString() Returns the languages string used in the last valid initialization.
lept.PIX	GetInputImage()
BytePointer	GetInputName() These functions are required for searchable PDF output.
boolean	GetIntVariable(BytePointer name, int[] value)
boolean	GetIntVariable(BytePointer name, IntBuffer value)
boolean	GetIntVariable(BytePointer name, IntPointer value) Returns true if the parameter was found among Tesseract parameters.
boolean	GetIntVariable(String name, int[] value)
boolean	GetIntVariable(String name, IntBuffer value)
boolean	GetIntVariable(String name, IntPointer value)
tesseract.ResultIterator	GetIterator() Get a reading-order iterator to the results of LayoutAnalysis and/or Recognize.
void	GetLoadedLanguagesAsVector(tesseract.StringGenericVector langs) Returns the loaded languages in the vector of STRINGs.
tesseract.MutableIterator	GetMutableIterator() Get a mutable iterator to the results of LayoutAnalysis and/or Recognize.
static long	getOpenCLDevice(Pointer device)
static long	getOpenCLDevice(PointerPointer device) If compiled with OpenCL AND an available OpenCL device is deemed faster than serial code, then "device" is populated with the cl_device_id and returns sizeof(cl_device_id) otherwise *device=NULL and returns 0.
BytePointer	GetOsdText(int page_number) The recognized text is returned as a char* which is coded as UTF8 and must be freed with the delete [] operator.
int	GetPageSegMode() Return the current page segmentation mode.
lept.BOXA	GetRegions(lept.PIXA pixa)
lept.BOXA	GetRegions(PointerPointer pixa) Get the result of page layout analysis as a leptonica-style Boxa, Pixa pair, in reading order.
int	GetSourceYResolution()
BytePointer	GetStringVariable(BytePointer name) Returns the pointer to the string that represents the value of the parameter if it was found among Tesseract parameters.
String	GetStringVariable(String name)
lept.BOXA	GetStrips(lept.PIXA pixa, int[] blockids)
lept.BOXA	GetStrips(lept.PIXA pixa, IntBuffer blockids)
lept.BOXA	GetStrips(lept.PIXA pixa, IntPointer blockids)
lept.BOXA	GetStrips(PointerPointer pixa, PointerPointer blockids) Get textlines and strips of image regions as a leptonica-style Boxa, Pixa pair, in reading order.
boolean	GetTextDirection(int[] out_offset, float[] out_slope)
boolean	GetTextDirection(IntBuffer out_offset, FloatBuffer out_slope)
boolean	GetTextDirection(IntPointer out_offset, FloatPointer out_slope)
lept.BOXA	GetTextlines(boolean raw_image, int raw_padding, lept.PIXA pixa, int[] blockids, int[] paraids)
lept.BOXA	GetTextlines(boolean raw_image, int raw_padding, lept.PIXA pixa, IntBuffer blockids, IntBuffer paraids)
lept.BOXA	GetTextlines(boolean raw_image, int raw_padding, lept.PIXA pixa, IntPointer blockids, IntPointer paraids)
lept.BOXA	GetTextlines(boolean raw_image, int raw_padding, PointerPointer pixa, PointerPointer blockids, PointerPointer paraids) Get the textlines as a leptonica-style Boxa, Pixa pair, in reading order.
lept.BOXA	GetTextlines(lept.PIXA pixa, int[] blockids)
lept.BOXA	GetTextlines(lept.PIXA pixa, IntBuffer blockids)
lept.BOXA	GetTextlines(lept.PIXA pixa, IntPointer blockids)
lept.BOXA	GetTextlines(PointerPointer pixa, PointerPointer blockids)
lept.PIX	GetThresholdedImage() Get a copy of the internal thresholded image from Tesseract.
int	GetThresholdedImageScaleFactor() Returns the scale factor of the thresholded image that would be returned by GetThresholdedImage() and the various GetX() methods that call GetComponentImages().
BytePointer	GetUnichar(int unichar_id) This method returns the string form of the specified unichar.
BytePointer	GetUNLVText() 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.
BytePointer	GetUTF8Text() The recognized text is returned as a char* which is coded as UTF8 and must be freed with the delete [] operator.
boolean	GetVariableAsString(BytePointer name, tesseract.STRING val) Get value of named variable as a string, if it exists.
boolean	GetVariableAsString(String name, tesseract.STRING val)
lept.BOXA	GetWords(lept.PIXA pixa)
lept.BOXA	GetWords(PointerPointer pixa) Get the words as a leptonica-style Boxa, Pixa pair, in reading order.
int	Init(BytePointer datapath, BytePointer language)
int	Init(BytePointer datapath, BytePointer language, int oem)
int	Init(BytePointer datapath, BytePointer language, int mode, byte[] configs, int configs_size, tesseract.StringGenericVector vars_vec, tesseract.StringGenericVector vars_values, boolean set_only_non_debug_params)
int	Init(BytePointer datapath, BytePointer language, int mode, ByteBuffer configs, int configs_size, tesseract.StringGenericVector vars_vec, tesseract.StringGenericVector vars_values, boolean set_only_non_debug_params)
int	Init(BytePointer datapath, BytePointer language, int mode, BytePointer configs, int configs_size, tesseract.StringGenericVector vars_vec, tesseract.StringGenericVector vars_values, boolean set_only_non_debug_params)
int	Init(BytePointer datapath, BytePointer language, int mode, PointerPointer configs, int configs_size, tesseract.StringGenericVector vars_vec, tesseract.StringGenericVector vars_values, boolean set_only_non_debug_params) Instances are now mostly thread-safe and totally independent, but some global parameters remain.
int	Init(String datapath, String language)
int	Init(String datapath, String language, int oem)
int	Init(String datapath, String language, int mode, byte[] configs, int configs_size, tesseract.StringGenericVector vars_vec, tesseract.StringGenericVector vars_values, boolean set_only_non_debug_params)
int	Init(String datapath, String language, int mode, ByteBuffer configs, int configs_size, tesseract.StringGenericVector vars_vec, tesseract.StringGenericVector vars_values, boolean set_only_non_debug_params)
int	Init(String datapath, String language, int mode, BytePointer configs, int configs_size, tesseract.StringGenericVector vars_vec, tesseract.StringGenericVector vars_values, boolean set_only_non_debug_params)
void	InitForAnalysePage() Init only for page layout analysis.
int	InitLangMod(BytePointer datapath, BytePointer language) Init only the lang model component of Tesseract.
int	InitLangMod(String datapath, String language)
void	InitTruthCallback(tesseract.TruthCallback4 cb)
boolean	IsValidCharacter(BytePointer utf8_character)
boolean	IsValidCharacter(String utf8_character)
int	IsValidWord(BytePointer word) Check whether a word is valid according to Tesseract's language model
int	IsValidWord(String word)
static tesseract.TBLOB	MakeTBLOB(lept.PIX pix) Returns a TBLOB corresponding to the entire input image.
static tesseract.ROW	MakeTessOCRRow(float baseline, float xheight, float descender, float ascender) Returns a ROW object created from the input row specification.
int	MeanTextConf() Returns the (average) confidence value between 0 and 100.
static void	NormalizeTBLOB(tesseract.TBLOB tblob, tesseract.ROW row, boolean numeric_mode) This method baseline normalizes a TBLOB in-place.
int	NumDawgs() Return the number of dawgs loaded into tesseract_ object.
int	oem()
tesseract.TessBaseAPI	position(long position)
void	PrintVariables(Pointer fp) Print Tesseract parameters to the given file.
boolean	ProcessPage(lept.PIX pix, int page_index, BytePointer filename, BytePointer retry_config, int timeout_millisec, tesseract.TessResultRenderer renderer) Turn a single image into symbolic text.
boolean	ProcessPage(lept.PIX pix, int page_index, String filename, String retry_config, int timeout_millisec, tesseract.TessResultRenderer renderer)
boolean	ProcessPages(BytePointer filename, BytePointer retry_config, int timeout_millisec, tesseract.TessResultRenderer renderer) Turns images into symbolic text.
boolean	ProcessPages(String filename, String retry_config, int timeout_millisec, tesseract.TessResultRenderer renderer)
boolean	ProcessPagesInternal(BytePointer filename, BytePointer retry_config, int timeout_millisec, tesseract.TessResultRenderer renderer)
boolean	ProcessPagesInternal(String filename, String retry_config, int timeout_millisec, tesseract.TessResultRenderer renderer)
void	ReadConfigFile(BytePointer filename) Read a "config" file containing a set of param, value pairs.
void	ReadConfigFile(String filename)
void	ReadDebugConfigFile(BytePointer filename) Same as above, but only set debug params from the given config file.
void	ReadDebugConfigFile(String filename)
int	Recognize(tesseract.ETEXT_DESC monitor) Recognize the image from SetAndThresholdImage, generating Tesseract internal structures.
int	RecognizeForChopTest(tesseract.ETEXT_DESC monitor) Variant on Recognize used for testing chopper.
void	RunAdaptiveClassifier(tesseract.TBLOB blob, int num_max_matches, int[] unichar_ids, float[] ratings, int[] num_matches_returned)
void	RunAdaptiveClassifier(tesseract.TBLOB blob, int num_max_matches, IntBuffer unichar_ids, FloatBuffer ratings, IntBuffer num_matches_returned)
void	RunAdaptiveClassifier(tesseract.TBLOB blob, int num_max_matches, IntPointer unichar_ids, FloatPointer ratings, IntPointer num_matches_returned) Method to run adaptive classifier on a blob.
void	set_min_orientation_margin(double margin)
boolean	SetDebugVariable(BytePointer name, BytePointer value)
boolean	SetDebugVariable(String name, String value)
void	SetDictFunc(tesseract.DictFunc f) Sets Dict::letter_is_okay_ function to point to the given function.
void	SetImage(byte[] imagedata, int width, int height, int bytes_per_pixel, int bytes_per_line)
void	SetImage(ByteBuffer imagedata, int width, int height, int bytes_per_pixel, int bytes_per_line)
void	SetImage(BytePointer imagedata, int width, int height, int bytes_per_pixel, int bytes_per_line) Provide an image for Tesseract to recognize.
void	SetImage(lept.PIX pix) Provide an image for Tesseract to recognize.
void	SetInputImage(lept.PIX pix)
void	SetInputName(BytePointer name) Set the name of the input file.
void	SetInputName(String name)
void	SetOutputName(BytePointer name) Set the name of the bonus output files.
void	SetOutputName(String name)
void	SetPageSegMode(int mode) Set the current page segmentation mode.
void	SetProbabilityInContextFunc(tesseract.ProbabilityInContextFunc f) Sets Dict::probability_in_context_ function to point to the given function.
void	SetRectangle(int left, int top, int width, int height) Restrict recognition to a sub-rectangle of the image.
void	SetSourceResolution(int ppi) Set the resolution of the source image in pixels per inch so font size information can be calculated in results.
void	SetThresholder(tesseract.ImageThresholder thresholder) In extreme cases only, usually with a subclass of Thresholder, it is possible to provide a different Thresholder.
boolean	SetVariable(BytePointer name, BytePointer 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.
boolean	SetVariable(String name, String value)
tesseract.Tesseract	tesseract()
byte[]	TesseractRect(byte[] imagedata, int bytes_per_pixel, int bytes_per_line, int left, int top, int width, int height)
ByteBuffer	TesseractRect(ByteBuffer imagedata, int bytes_per_pixel, int bytes_per_line, int left, int top, int width, int height)
BytePointer	TesseractRect(BytePointer 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.
static BytePointer	Version() Returns the version identifier as a static string.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, free, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, physicalBytes, position, put, realloc, setNull, sizeof, toString, totalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

tesseract.TessBaseAPI

public tesseract.TessBaseAPI(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

tesseract.TessBaseAPI

public tesseract.TessBaseAPI(long size)

Native array allocator. Access with Pointer.position(long).

tesseract.TessBaseAPI

public tesseract.TessBaseAPI()

Method Detail

position

public tesseract.TessBaseAPI position(long position)

Overrides:

position in class Pointer

Version

@Cast(value="const char*")
public static BytePointer Version()

Returns the version identifier as a static string. Do not delete.

getOpenCLDevice

@Cast(value="size_t")
public static long getOpenCLDevice(@Cast(value="void**")
                             PointerPointer device)

If compiled with OpenCL AND an available OpenCL device is deemed faster than serial code, then "device" is populated with the cl_device_id and returns sizeof(cl_device_id) otherwise *device=NULL and returns 0.

getOpenCLDevice

@Cast(value="size_t")
public static long getOpenCLDevice(@Cast(value="void**")@ByPtrPtr
                             Pointer device)

CatchSignals

public static void CatchSignals()

Writes the thresholded image to stderr as a PBM file on receipt of a SIGSEGV, SIGFPE, or SIGBUS signal. (Linux/Unix only).

SetInputName

public void SetInputName(@Cast(value="const char*")
                BytePointer name)

Set the name of the input file. Needed for training and reading a UNLV zone file, and for searchable PDF output.

SetInputName

public void SetInputName(String name)

GetInputName

@Cast(value="const char*")
public BytePointer GetInputName()

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.

SetInputImage

public void SetInputImage(lept.PIX pix)

GetInputImage

public lept.PIX GetInputImage()

GetSourceYResolution

public int GetSourceYResolution()

GetDatapath

@Cast(value="const char*")
public BytePointer GetDatapath()

SetOutputName

public void SetOutputName(@Cast(value="const char*")
                 BytePointer name)

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

SetOutputName

public void SetOutputName(String name)

SetVariable

@Cast(value="bool")
public boolean SetVariable(@Cast(value="const char*")
                            BytePointer name,
                            @Cast(value="const char*")
                            BytePointer 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. Eg 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()).

SetVariable

@Cast(value="bool")
public boolean SetVariable(String name,
                            String value)

SetDebugVariable

@Cast(value="bool")
public boolean SetDebugVariable(@Cast(value="const char*")
                                 BytePointer name,
                                 @Cast(value="const char*")
                                 BytePointer value)

SetDebugVariable

@Cast(value="bool")
public boolean SetDebugVariable(String name,
                                 String value)

GetIntVariable

@Cast(value="bool")
public boolean GetIntVariable(@Cast(value="const char*")
                               BytePointer name,
                               IntPointer value)

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

GetIntVariable

@Cast(value="bool")
public boolean GetIntVariable(String name,
                               IntBuffer value)

GetIntVariable

@Cast(value="bool")
public boolean GetIntVariable(@Cast(value="const char*")
                               BytePointer name,
                               int[] value)

GetIntVariable

@Cast(value="bool")
public boolean GetIntVariable(String name,
                               IntPointer value)

GetIntVariable

@Cast(value="bool")
public boolean GetIntVariable(@Cast(value="const char*")
                               BytePointer name,
                               IntBuffer value)

GetIntVariable

@Cast(value="bool")
public boolean GetIntVariable(String name,
                               int[] value)

GetBoolVariable

@Cast(value="bool")
public boolean GetBoolVariable(@Cast(value="const char*")
                                BytePointer name,
                                @Cast(value="bool*")
                                BoolPointer value)

GetBoolVariable

@Cast(value="bool")
public boolean GetBoolVariable(String name,
                                @Cast(value="bool*")
                                boolean[] value)

GetDoubleVariable

@Cast(value="bool")
public boolean GetDoubleVariable(@Cast(value="const char*")
                                  BytePointer name,
                                  DoublePointer value)

GetDoubleVariable

@Cast(value="bool")
public boolean GetDoubleVariable(String name,
                                  DoubleBuffer value)

GetDoubleVariable

@Cast(value="bool")
public boolean GetDoubleVariable(@Cast(value="const char*")
                                  BytePointer name,
                                  double[] value)

GetDoubleVariable

@Cast(value="bool")
public boolean GetDoubleVariable(String name,
                                  DoublePointer value)

GetDoubleVariable

@Cast(value="bool")
public boolean GetDoubleVariable(@Cast(value="const char*")
                                  BytePointer name,
                                  DoubleBuffer value)

GetDoubleVariable

@Cast(value="bool")
public boolean GetDoubleVariable(String name,
                                  double[] value)

GetStringVariable

@Cast(value="const char*")
public BytePointer GetStringVariable(@Cast(value="const char*")
                                      BytePointer name)

Returns the pointer to the string that represents the value of the parameter if it was found among Tesseract parameters.

GetStringVariable

public String GetStringVariable(String name)

PrintVariables

public void PrintVariables(@Cast(value="FILE*")
                  Pointer fp)

Print Tesseract parameters to the given file.

GetVariableAsString

@Cast(value="bool")
public boolean GetVariableAsString(@Cast(value="const char*")
                                    BytePointer name,
                                    tesseract.STRING val)

Get value of named variable as a string, if it exists.

GetVariableAsString

@Cast(value="bool")
public boolean GetVariableAsString(String name,
                                    tesseract.STRING val)

Init

public int Init(@Cast(value="const char*")
       BytePointer datapath,
       @Cast(value="const char*")
       BytePointer language,
       @Cast(value="tesseract::OcrEngineMode")
       int mode,
       @Cast(value="char**")
       PointerPointer configs,
       int configs_size,
       @Const
       tesseract.StringGenericVector vars_vec,
       @Const
       tesseract.StringGenericVector vars_values,
       @Cast(value="bool")
       boolean set_only_non_debug_params)

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. Eg 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. Eg 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.

Init

public int Init(@Cast(value="const char*")
       BytePointer datapath,
       @Cast(value="const char*")
       BytePointer language,
       @Cast(value="tesseract::OcrEngineMode")
       int mode,
       @Cast(value="char**")@ByPtrPtr
       BytePointer configs,
       int configs_size,
       @Const
       tesseract.StringGenericVector vars_vec,
       @Const
       tesseract.StringGenericVector vars_values,
       @Cast(value="bool")
       boolean set_only_non_debug_params)

Init

public int Init(String datapath,
       String language,
       @Cast(value="tesseract::OcrEngineMode")
       int mode,
       @Cast(value="char**")@ByPtrPtr
       ByteBuffer configs,
       int configs_size,
       @Const
       tesseract.StringGenericVector vars_vec,
       @Const
       tesseract.StringGenericVector vars_values,
       @Cast(value="bool")
       boolean set_only_non_debug_params)

Init

public int Init(@Cast(value="const char*")
       BytePointer datapath,
       @Cast(value="const char*")
       BytePointer language,
       @Cast(value="tesseract::OcrEngineMode")
       int mode,
       @Cast(value="char**")@ByPtrPtr
       byte[] configs,
       int configs_size,
       @Const
       tesseract.StringGenericVector vars_vec,
       @Const
       tesseract.StringGenericVector vars_values,
       @Cast(value="bool")
       boolean set_only_non_debug_params)

Init

public int Init(String datapath,
       String language,
       @Cast(value="tesseract::OcrEngineMode")
       int mode,
       @Cast(value="char**")@ByPtrPtr
       BytePointer configs,
       int configs_size,
       @Const
       tesseract.StringGenericVector vars_vec,
       @Const
       tesseract.StringGenericVector vars_values,
       @Cast(value="bool")
       boolean set_only_non_debug_params)

Init

public int Init(@Cast(value="const char*")
       BytePointer datapath,
       @Cast(value="const char*")
       BytePointer language,
       @Cast(value="tesseract::OcrEngineMode")
       int mode,
       @Cast(value="char**")@ByPtrPtr
       ByteBuffer configs,
       int configs_size,
       @Const
       tesseract.StringGenericVector vars_vec,
       @Const
       tesseract.StringGenericVector vars_values,
       @Cast(value="bool")
       boolean set_only_non_debug_params)

Init

public int Init(String datapath,
       String language,
       @Cast(value="tesseract::OcrEngineMode")
       int mode,
       @Cast(value="char**")@ByPtrPtr
       byte[] configs,
       int configs_size,
       @Const
       tesseract.StringGenericVector vars_vec,
       @Const
       tesseract.StringGenericVector vars_values,
       @Cast(value="bool")
       boolean set_only_non_debug_params)

Init

public int Init(@Cast(value="const char*")
       BytePointer datapath,
       @Cast(value="const char*")
       BytePointer language,
       @Cast(value="tesseract::OcrEngineMode")
       int oem)

Init

public int Init(String datapath,
       String language,
       @Cast(value="tesseract::OcrEngineMode")
       int oem)

Init

public int Init(@Cast(value="const char*")
       BytePointer datapath,
       @Cast(value="const char*")
       BytePointer language)

Init

public int Init(String datapath,
       String language)

GetInitLanguagesAsString

@Cast(value="const char*")
public BytePointer GetInitLanguagesAsString()

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.

GetLoadedLanguagesAsVector

public void GetLoadedLanguagesAsVector(tesseract.StringGenericVector langs)

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.

GetAvailableLanguagesAsVector

public void GetAvailableLanguagesAsVector(tesseract.StringGenericVector langs)

Returns the available languages in the vector of STRINGs.

InitLangMod

public int InitLangMod(@Cast(value="const char*")
              BytePointer datapath,
              @Cast(value="const char*")
              BytePointer 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.

InitLangMod

public int InitLangMod(String datapath,
              String language)

InitForAnalysePage

public void InitForAnalysePage()

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

ReadConfigFile

public void ReadConfigFile(@Cast(value="const char*")
                  BytePointer filename)

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()).

ReadConfigFile

public void ReadConfigFile(String filename)

ReadDebugConfigFile

public void ReadDebugConfigFile(@Cast(value="const char*")
                       BytePointer filename)

Same as above, but only set debug params from the given config file.

ReadDebugConfigFile

public void ReadDebugConfigFile(String filename)

SetPageSegMode

public void SetPageSegMode(@Cast(value="tesseract::PageSegMode")
                  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).

GetPageSegMode

@Cast(value="tesseract::PageSegMode")
public int GetPageSegMode()

Return the current page segmentation mode.

TesseractRect

@Cast(value="char*")
public BytePointer TesseractRect(@Cast(value="const unsigned char*")
                                  BytePointer 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.

TesseractRect

@Cast(value="char*")
public ByteBuffer TesseractRect(@Cast(value="const unsigned char*")
                                 ByteBuffer imagedata,
                                 int bytes_per_pixel,
                                 int bytes_per_line,
                                 int left,
                                 int top,
                                 int width,
                                 int height)

TesseractRect

@Cast(value="char*")
public byte[] TesseractRect(@Cast(value="const unsigned char*")
                             byte[] imagedata,
                             int bytes_per_pixel,
                             int bytes_per_line,
                             int left,
                             int top,
                             int width,
                             int height)

ClearAdaptiveClassifier

public void ClearAdaptiveClassifier()

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

SetImage

public void SetImage(@Cast(value="const unsigned char*")
            BytePointer 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.

SetImage

public void SetImage(@Cast(value="const unsigned char*")
            ByteBuffer imagedata,
            int width,
            int height,
            int bytes_per_pixel,
            int bytes_per_line)

SetImage

public void SetImage(@Cast(value="const unsigned char*")
            byte[] imagedata,
            int width,
            int height,
            int bytes_per_pixel,
            int bytes_per_line)

SetImage

public void SetImage(lept.PIX pix)

Provide an image for Tesseract to recognize. As with SetImage above, Tesseract doesn't take a copy or ownership or pixDestroy the image, so it must persist until after Recognize. Pix vs raw, which to use? Use Pix where possible. A future version of Tesseract may choose to use Pix as its internal representation and discard IMAGE altogether. Because of that, an implementation that sources and targets Pix may end up with less copies than an implementation that does not.

SetSourceResolution

public void SetSourceResolution(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().

SetRectangle

public void SetRectangle(int left,
                int top,
                int width,
                int height)

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

SetThresholder

public void SetThresholder(tesseract.ImageThresholder thresholder)

In extreme cases only, usually with a subclass of Thresholder, it is possible to provide a different Thresholder. The Thresholder may be preloaded with an image, settings etc, or they may be set after. Note that Tesseract takes ownership of the Thresholder and will delete it when it it is replaced or the API is destructed.

GetThresholdedImage

public lept.PIX GetThresholdedImage()

Get a copy of the internal thresholded image from Tesseract. Caller takes ownership of the Pix and must pixDestroy it. May be called any time after SetImage, or after TesseractRect.

GetRegions

public lept.BOXA GetRegions(@Cast(value="Pixa**")
                   PointerPointer pixa)

Get the result of page layout analysis as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize.

GetRegions

public lept.BOXA GetRegions(@ByPtrPtr
                   lept.PIXA pixa)

GetTextlines

public lept.BOXA GetTextlines(@Cast(value="const bool")
                     boolean raw_image,
                     int raw_padding,
                     @Cast(value="Pixa**")
                     PointerPointer pixa,
                     @Cast(value="int**")
                     PointerPointer blockids,
                     @Cast(value="int**")
                     PointerPointer paraids)

Get the textlines as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize. If raw_image is true, then extract from the original image instead of the thresholded image and pad by raw_padding pixels. If blockids is not NULL, the block-id of each line is also returned as an array of one element per line. delete [] after use. If paraids is not NULL, the paragraph-id of each line within its block is also returned as an array of one element per line. delete [] after use.

GetTextlines

public lept.BOXA GetTextlines(@Cast(value="const bool")
                     boolean raw_image,
                     int raw_padding,
                     @ByPtrPtr
                     lept.PIXA pixa,
                     @ByPtrPtr
                     IntPointer blockids,
                     @ByPtrPtr
                     IntPointer paraids)

GetTextlines

public lept.BOXA GetTextlines(@Cast(value="const bool")
                     boolean raw_image,
                     int raw_padding,
                     @ByPtrPtr
                     lept.PIXA pixa,
                     @ByPtrPtr
                     IntBuffer blockids,
                     @ByPtrPtr
                     IntBuffer paraids)

GetTextlines

public lept.BOXA GetTextlines(@Cast(value="const bool")
                     boolean raw_image,
                     int raw_padding,
                     @ByPtrPtr
                     lept.PIXA pixa,
                     @ByPtrPtr
                     int[] blockids,
                     @ByPtrPtr
                     int[] paraids)

GetTextlines

public lept.BOXA GetTextlines(@Cast(value="Pixa**")
                     PointerPointer pixa,
                     @Cast(value="int**")
                     PointerPointer blockids)

GetTextlines

public lept.BOXA GetTextlines(@ByPtrPtr
                     lept.PIXA pixa,
                     @ByPtrPtr
                     IntPointer blockids)

GetTextlines

public lept.BOXA GetTextlines(@ByPtrPtr
                     lept.PIXA pixa,
                     @ByPtrPtr
                     IntBuffer blockids)

GetTextlines

public lept.BOXA GetTextlines(@ByPtrPtr
                     lept.PIXA pixa,
                     @ByPtrPtr
                     int[] blockids)

GetStrips

public lept.BOXA GetStrips(@Cast(value="Pixa**")
                  PointerPointer pixa,
                  @Cast(value="int**")
                  PointerPointer blockids)

Get textlines and strips of image regions as a leptonica-style Boxa, Pixa pair, in reading order. Enables downstream handling of non-rectangular regions. Can be called before or after Recognize. If blockids is not NULL, the block-id of each line is also returned as an array of one element per line. delete [] after use.

GetStrips

public lept.BOXA GetStrips(@ByPtrPtr
                  lept.PIXA pixa,
                  @ByPtrPtr
                  IntPointer blockids)

GetStrips

public lept.BOXA GetStrips(@ByPtrPtr
                  lept.PIXA pixa,
                  @ByPtrPtr
                  IntBuffer blockids)

GetStrips

public lept.BOXA GetStrips(@ByPtrPtr
                  lept.PIXA pixa,
                  @ByPtrPtr
                  int[] blockids)

GetWords

public lept.BOXA GetWords(@Cast(value="Pixa**")
                 PointerPointer pixa)

Get the words as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize.

GetWords

public lept.BOXA GetWords(@ByPtrPtr
                 lept.PIXA pixa)

GetConnectedComponents

public lept.BOXA GetConnectedComponents(@Cast(value="Pixa**")
                               PointerPointer cc)

Gets the individual connected (text) components (created after pages segmentation step, but before recognition) as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize. Note: the caller is responsible for calling boxaDestroy() on the returned Boxa array and pixaDestroy() on cc array.

GetConnectedComponents

public lept.BOXA GetConnectedComponents(@ByPtrPtr
                               lept.PIXA cc)

GetComponentImages

public lept.BOXA GetComponentImages(@Cast(value="const tesseract::PageIteratorLevel")
                           int level,
                           @Cast(value="const bool")
                           boolean text_only,
                           @Cast(value="const bool")
                           boolean raw_image,
                           int raw_padding,
                           @Cast(value="Pixa**")
                           PointerPointer pixa,
                           @Cast(value="int**")
                           PointerPointer blockids,
                           @Cast(value="int**")
                           PointerPointer paraids)

Get the given level kind of components (block, textline, word etc.) as a leptonica-style Boxa, Pixa pair, in reading order. Can be called before or after Recognize. If blockids is not NULL, the block-id of each component is also returned as an array of one element per component. delete [] after use. If blockids is not NULL, the paragraph-id of each component with its block is also returned as an array of one element per component. delete [] after use. If raw_image is true, then portions of the original image are extracted instead of the thresholded image and padded with raw_padding. If text_only is true, then only text components are returned.

GetComponentImages

public lept.BOXA GetComponentImages(@Cast(value="const tesseract::PageIteratorLevel")
                           int level,
                           @Cast(value="const bool")
                           boolean text_only,
                           @Cast(value="const bool")
                           boolean raw_image,
                           int raw_padding,
                           @ByPtrPtr
                           lept.PIXA pixa,
                           @ByPtrPtr
                           IntPointer blockids,
                           @ByPtrPtr
                           IntPointer paraids)

GetComponentImages

public lept.BOXA GetComponentImages(@Cast(value="const tesseract::PageIteratorLevel")
                           int level,
                           @Cast(value="const bool")
                           boolean text_only,
                           @Cast(value="const bool")
                           boolean raw_image,
                           int raw_padding,
                           @ByPtrPtr
                           lept.PIXA pixa,
                           @ByPtrPtr
                           IntBuffer blockids,
                           @ByPtrPtr
                           IntBuffer paraids)

GetComponentImages

public lept.BOXA GetComponentImages(@Cast(value="const tesseract::PageIteratorLevel")
                           int level,
                           @Cast(value="const bool")
                           boolean text_only,
                           @Cast(value="const bool")
                           boolean raw_image,
                           int raw_padding,
                           @ByPtrPtr
                           lept.PIXA pixa,
                           @ByPtrPtr
                           int[] blockids,
                           @ByPtrPtr
                           int[] paraids)

GetComponentImages

public lept.BOXA GetComponentImages(@Cast(value="const tesseract::PageIteratorLevel")
                           int level,
                           @Cast(value="const bool")
                           boolean text_only,
                           @Cast(value="Pixa**")
                           PointerPointer pixa,
                           @Cast(value="int**")
                           PointerPointer blockids)

GetComponentImages

public lept.BOXA GetComponentImages(@Cast(value="const tesseract::PageIteratorLevel")
                           int level,
                           @Cast(value="const bool")
                           boolean text_only,
                           @ByPtrPtr
                           lept.PIXA pixa,
                           @ByPtrPtr
                           IntPointer blockids)

GetComponentImages

public lept.BOXA GetComponentImages(@Cast(value="const tesseract::PageIteratorLevel")
                           int level,
                           @Cast(value="const bool")
                           boolean text_only,
                           @ByPtrPtr
                           lept.PIXA pixa,
                           @ByPtrPtr
                           IntBuffer blockids)

GetComponentImages

public lept.BOXA GetComponentImages(@Cast(value="const tesseract::PageIteratorLevel")
                           int level,
                           @Cast(value="const bool")
                           boolean text_only,
                           @ByPtrPtr
                           lept.PIXA pixa,
                           @ByPtrPtr
                           int[] blockids)

GetThresholdedImageScaleFactor

public int GetThresholdedImageScaleFactor()

Returns the scale factor of the thresholded image that would be returned by GetThresholdedImage() and the various GetX() methods that call GetComponentImages(). Returns 0 if no thresholder has been set.

DumpPGM

public void DumpPGM(@Cast(value="const char*")
           BytePointer filename)

Deprecated. Use GetThresholdedImage and write the image using pixWrite instead if possible.

Dump the internal binary image to a PGM file.

DumpPGM

public void DumpPGM(String filename)

AnalyseLayout

public tesseract.PageIterator AnalyseLayout()

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. If merge_similar_words is true, words are combined where suitable for use with a line recognizer. Use if you want to use AnalyseLayout to find the textlines, and then want to process textline fragments with an external line recognizer. Returns NULL on error or an empty page. 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.

AnalyseLayout

public tesseract.PageIterator AnalyseLayout(@Cast(value="bool")
                                   boolean merge_similar_words)

Recognize

public int Recognize(tesseract.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.

RecognizeForChopTest

public int RecognizeForChopTest(tesseract.ETEXT_DESC monitor)

Variant on Recognize used for testing chopper.

ProcessPages

@Cast(value="bool")
public boolean ProcessPages(@Cast(value="const char*")
                             BytePointer filename,
                             @Cast(value="const char*")
                             BytePointer retry_config,
                             int timeout_millisec,
                             tesseract.TessResultRenderer renderer)

Turns images into symbolic text. filename can point to a single image, a multi-page TIFF, or a plain text list of image filenames. retry_config is useful for debugging. If not NULL, you can fall back to an alternate configuration if a page fails for some reason. timeout_millisec terminates processing if any single page takes too long. Set to 0 for unlimited time. renderer is responible for creating the output. For example, use the TessTextRenderer if you want plaintext output, or the TessPDFRender to produce searchable PDF. If tessedit_page_number is non-negative, will only process that single page. Works for multi-page tiff file, or filelist. Returns true if successful, false on error.

ProcessPages

@Cast(value="bool")
public boolean ProcessPages(String filename,
                             String retry_config,
                             int timeout_millisec,
                             tesseract.TessResultRenderer renderer)

ProcessPagesInternal

@Cast(value="bool")
public boolean ProcessPagesInternal(@Cast(value="const char*")
                                     BytePointer filename,
                                     @Cast(value="const char*")
                                     BytePointer retry_config,
                                     int timeout_millisec,
                                     tesseract.TessResultRenderer renderer)

ProcessPagesInternal

@Cast(value="bool")
public boolean ProcessPagesInternal(String filename,
                                     String retry_config,
                                     int timeout_millisec,
                                     tesseract.TessResultRenderer renderer)

ProcessPage

@Cast(value="bool")
public boolean ProcessPage(lept.PIX pix,
                            int page_index,
                            @Cast(value="const char*")
                            BytePointer filename,
                            @Cast(value="const char*")
                            BytePointer retry_config,
                            int timeout_millisec,
                            tesseract.TessResultRenderer renderer)

Turn a single image into symbolic text. The pix is the image processed. filename and page_index are metadata used by side-effect processes, such as reading a box file or formatting as hOCR. See ProcessPages for desciptions of other parameters.

ProcessPage

@Cast(value="bool")
public boolean ProcessPage(lept.PIX pix,
                            int page_index,
                            String filename,
                            String retry_config,
                            int timeout_millisec,
                            tesseract.TessResultRenderer renderer)

GetIterator

public tesseract.ResultIterator GetIterator()

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.

GetMutableIterator

public tesseract.MutableIterator GetMutableIterator()

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.

GetUTF8Text

@Cast(value="char*")
public BytePointer GetUTF8Text()

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

GetHOCRText

@Cast(value="char*")
public BytePointer GetHOCRText(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.

GetBoxText

@Cast(value="char*")
public BytePointer GetBoxText(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.

GetUNLVText

@Cast(value="char*")
public BytePointer GetUNLVText()

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.

GetOsdText

@Cast(value="char*")
public BytePointer GetOsdText(int page_number)

The recognized text is returned as a char* which is coded as UTF8 and must be freed with the delete [] operator. page_number is a 0-based page index that will appear in the osd file.

MeanTextConf

public int MeanTextConf()

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

AllWordConfidences

public IntPointer AllWordConfidences()

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.

AdaptToWordStr

@Cast(value="bool")
public boolean AdaptToWordStr(@Cast(value="tesseract::PageSegMode")
                               int mode,
                               @Cast(value="const char*")
                               BytePointer 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.

AdaptToWordStr

@Cast(value="bool")
public boolean AdaptToWordStr(@Cast(value="tesseract::PageSegMode")
                               int mode,
                               String wordstr)

Clear

public void Clear()

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.

End

public void End()

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.

ClearPersistentCache

public static void ClearPersistentCache()

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.

IsValidWord

public int IsValidWord(@Cast(value="const char*")
              BytePointer 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.

IsValidWord

public int IsValidWord(String word)

IsValidCharacter

@Cast(value="bool")
public boolean IsValidCharacter(@Cast(value="const char*")
                                 BytePointer utf8_character)

IsValidCharacter

@Cast(value="bool")
public boolean IsValidCharacter(String utf8_character)

GetTextDirection

@Cast(value="bool")
public boolean GetTextDirection(IntPointer out_offset,
                                 FloatPointer out_slope)

GetTextDirection

@Cast(value="bool")
public boolean GetTextDirection(IntBuffer out_offset,
                                 FloatBuffer out_slope)

GetTextDirection

@Cast(value="bool")
public boolean GetTextDirection(int[] out_offset,
                                 float[] out_slope)

SetDictFunc

public void SetDictFunc(tesseract.DictFunc f)

Sets Dict::letter_is_okay_ function to point to the given function.

SetProbabilityInContextFunc

public void SetProbabilityInContextFunc(tesseract.ProbabilityInContextFunc f)

Sets Dict::probability_in_context_ function to point to the given function.

DetectOS

@Cast(value="bool")
public boolean DetectOS(tesseract.OSResults arg0)

Estimates the Orientation And Script of the image.

Returns:

true if the image was processed successfully.

GetFeaturesForBlob

public void GetFeaturesForBlob(tesseract.TBLOB blob,
                      tesseract.INT_FEATURE_STRUCT int_features,
                      IntPointer num_features,
                      IntPointer feature_outline_index)

This method returns the features associated with the input image.

GetFeaturesForBlob

public void GetFeaturesForBlob(tesseract.TBLOB blob,
                      tesseract.INT_FEATURE_STRUCT int_features,
                      IntBuffer num_features,
                      IntBuffer feature_outline_index)

GetFeaturesForBlob

public void GetFeaturesForBlob(tesseract.TBLOB blob,
                      tesseract.INT_FEATURE_STRUCT int_features,
                      int[] num_features,
                      int[] feature_outline_index)

FindRowForBox

public static tesseract.ROW FindRowForBox(tesseract.BLOCK_LIST blocks,
                          int left,
                          int top,
                          int right,
                          int bottom)

This method returns the row to which a box of specified dimensions would belong. If no good match is found, it returns NULL.

RunAdaptiveClassifier

public void RunAdaptiveClassifier(tesseract.TBLOB blob,
                         int num_max_matches,
                         IntPointer unichar_ids,
                         FloatPointer ratings,
                         IntPointer num_matches_returned)

Method to run adaptive classifier on a blob. It returns at max num_max_matches results.

RunAdaptiveClassifier

public void RunAdaptiveClassifier(tesseract.TBLOB blob,
                         int num_max_matches,
                         IntBuffer unichar_ids,
                         FloatBuffer ratings,
                         IntBuffer num_matches_returned)

RunAdaptiveClassifier

public void RunAdaptiveClassifier(tesseract.TBLOB blob,
                         int num_max_matches,
                         int[] unichar_ids,
                         float[] ratings,
                         int[] num_matches_returned)

GetUnichar

@Cast(value="const char*")
public BytePointer GetUnichar(int unichar_id)

This method returns the string form of the specified unichar.

GetDawg

@Const
public tesseract.Dawg GetDawg(int i)

Return the pointer to the i-th dawg loaded into tesseract_ object.

NumDawgs

public int NumDawgs()

Return the number of dawgs loaded into tesseract_ object.

MakeTessOCRRow

public static tesseract.ROW MakeTessOCRRow(float baseline,
                           float xheight,
                           float descender,
                           float ascender)

Returns a ROW object created from the input row specification.

MakeTBLOB

public static tesseract.TBLOB MakeTBLOB(lept.PIX pix)

Returns a TBLOB corresponding to the entire input image.

NormalizeTBLOB

public static void NormalizeTBLOB(tesseract.TBLOB tblob,
                  tesseract.ROW row,
                  @Cast(value="bool")
                  boolean numeric_mode)

This method baseline normalizes a TBLOB in-place. The input row is used for normalization. The denorm is an optional parameter in which the normalization-antidote is returned.

tesseract

public tesseract.Tesseract tesseract()

oem

@Cast(value="tesseract::OcrEngineMode")
public int oem()

InitTruthCallback

public void InitTruthCallback(@Cast(value="tesseract::TruthCallback*")
                     tesseract.TruthCallback4 cb)

GetCubeRecoContext

public tesseract.CubeRecoContext GetCubeRecoContext()

Return a pointer to underlying CubeRecoContext object if present.

set_min_orientation_margin

public void set_min_orientation_margin(double margin)

GetBlockTextOrientations

public void GetBlockTextOrientations(@Cast(value="int**")
                            PointerPointer block_orientation,
                            @Cast(value="bool**")
                            PointerPointer vertical_writing)

Return text orientation of each block as determined by an earlier run of layout analysis.

GetBlockTextOrientations

public void GetBlockTextOrientations(@ByPtrPtr
                            IntPointer block_orientation,
                            @Cast(value="bool**")@ByPtrPtr
                            BoolPointer vertical_writing)

GetBlockTextOrientations

public void GetBlockTextOrientations(@ByPtrPtr
                            IntBuffer block_orientation,
                            @Cast(value="bool**")@ByPtrPtr
                            boolean[] vertical_writing)

GetBlockTextOrientations

public void GetBlockTextOrientations(@ByPtrPtr
                            int[] block_orientation,
                            @Cast(value="bool**")@ByPtrPtr
                            BoolPointer vertical_writing)

GetBlockTextOrientations

public void GetBlockTextOrientations(@ByPtrPtr
                            IntPointer block_orientation,
                            @Cast(value="bool**")@ByPtrPtr
                            boolean[] vertical_writing)

GetBlockTextOrientations

public void GetBlockTextOrientations(@ByPtrPtr
                            IntBuffer block_orientation,
                            @Cast(value="bool**")@ByPtrPtr
                            BoolPointer vertical_writing)

GetBlockTextOrientations

public void GetBlockTextOrientations(@ByPtrPtr
                            int[] block_orientation,
                            @Cast(value="bool**")@ByPtrPtr
                            boolean[] vertical_writing)

FindLinesCreateBlockList

public tesseract.BLOCK_LIST FindLinesCreateBlockList()

Find lines from the image making the BLOCK_LIST.

DeleteBlockList

public static void DeleteBlockList(tesseract.BLOCK_LIST block_list)

Delete a block list. This is to keep BLOCK_LIST pointer opaque and let go of including the other headers.