Public Member Functions |
| TessBaseAPI () |
virtual | ~TessBaseAPI () |
void | SetInputName (const char *name) |
void | SetOutputName (const char *name) |
bool | SetVariable (const char *name, const char *value) |
bool | SetDebugVariable (const char *name, const char *value) |
bool | GetIntVariable (const char *name, int *value) const |
bool | GetBoolVariable (const char *name, bool *value) const |
bool | GetDoubleVariable (const char *name, double *value) const |
const char * | GetStringVariable (const char *name) const |
void | PrintVariables (FILE *fp) const |
bool | GetVariableAsString (const char *name, STRING *val) |
int | Init (const char *datapath, const char *language, OcrEngineMode mode, char **configs, int configs_size, const GenericVector< STRING > *vars_vec, const GenericVector< STRING > *vars_values, bool set_only_non_debug_params) |
int | Init (const char *datapath, const char *language, OcrEngineMode oem) |
int | Init (const char *datapath, const char *language) |
const char * | GetInitLanguagesAsString () const |
void | GetLoadedLanguagesAsVector (GenericVector< STRING > *langs) const |
int | InitLangMod (const char *datapath, const char *language) |
void | InitForAnalysePage () |
void | ReadConfigFile (const char *filename) |
void | ReadDebugConfigFile (const char *filename) |
void | SetPageSegMode (PageSegMode mode) |
PageSegMode | GetPageSegMode () const |
char * | TesseractRect (const unsigned char *imagedata, int bytes_per_pixel, int bytes_per_line, int left, int top, int width, int height) |
void | ClearAdaptiveClassifier () |
void | SetImage (const unsigned char *imagedata, int width, int height, int bytes_per_pixel, int bytes_per_line) |
void | SetImage (const Pix *pix) |
void | SetSourceResolution (int ppi) |
void | SetRectangle (int left, int top, int width, int height) |
void | SetThresholder (ImageThresholder *thresholder) |
Pix * | GetThresholdedImage () |
Boxa * | GetRegions (Pixa **pixa) |
Boxa * | GetTextlines (Pixa **pixa, int **blockids) |
Boxa * | GetStrips (Pixa **pixa, int **blockids) |
Boxa * | GetWords (Pixa **pixa) |
Boxa * | GetConnectedComponents (Pixa **cc) |
Boxa * | GetComponentImages (PageIteratorLevel level, bool text_only, Pixa **pixa, int **blockids) |
int | GetThresholdedImageScaleFactor () const |
void | DumpPGM (const char *filename) |
PageIterator * | AnalyseLayout () |
int | Recognize (ETEXT_DESC *monitor) |
int | RecognizeForChopTest (ETEXT_DESC *monitor) |
bool | ProcessPages (const char *filename, const char *retry_config, int timeout_millisec, STRING *text_out) |
bool | ProcessPage (Pix *pix, int page_index, const char *filename, const char *retry_config, int timeout_millisec, STRING *text_out) |
ResultIterator * | GetIterator () |
MutableIterator * | GetMutableIterator () |
char * | GetUTF8Text () |
char * | GetHOCRText (int page_number) |
char * | GetBoxText (int page_number) |
char * | GetUNLVText () |
int | MeanTextConf () |
int * | AllWordConfidences () |
bool | AdaptToWordStr (PageSegMode mode, const char *wordstr) |
void | Clear () |
void | End () |
int | IsValidWord (const char *word) |
bool | GetTextDirection (int *out_offset, float *out_slope) |
void | SetDictFunc (DictFunc f) |
void | SetProbabilityInContextFunc (ProbabilityInContextFunc f) |
void | SetFillLatticeFunc (FillLatticeFunc f) |
bool | DetectOS (OSResults *) |
void | GetFeaturesForBlob (TBLOB *blob, const DENORM &denorm, INT_FEATURE_ARRAY int_features, int *num_features, int *FeatureOutlineIndex) |
void | RunAdaptiveClassifier (TBLOB *blob, const DENORM &denorm, int num_max_matches, int *unichar_ids, float *ratings, int *num_matches_returned) |
const char * | GetUnichar (int unichar_id) |
const Dawg * | GetDawg (int i) const |
int | NumDawgs () const |
const char * | GetLastInitLanguage () const |
Tesseract *const | tesseract () const |
OcrEngineMode const | oem () const |
void | InitTruthCallback (TruthCallback *cb) |
CubeRecoContext * | GetCubeRecoContext () const |
void | set_min_orientation_margin (double margin) |
void | GetBlockTextOrientations (int **block_orientation, bool **vertical_writing) |
BLOCK_LIST * | FindLinesCreateBlockList () |
Static Public Member Functions |
static const char * | Version () |
static ROW * | FindRowForBox (BLOCK_LIST *blocks, int left, int top, int right, int bottom) |
static ROW * | MakeTessOCRRow (float baseline, float xheight, float descender, float ascender) |
static TBLOB * | MakeTBLOB (Pix *pix) |
static void | NormalizeTBLOB (TBLOB *tblob, ROW *row, bool numeric_mode, DENORM *denorm) |
static void | DeleteBlockList (BLOCK_LIST *block_list) |
Protected Member Functions |
bool | InternalSetImage () |
virtual void | Threshold (Pix **pix) |
int | FindLines () |
void | ClearResults () |
LTRResultIterator * | GetLTRIterator () |
int | TextLength (int *blob_count) |
void | AdaptToCharacter (const char *unichar_repr, int length, float baseline, float xheight, float descender, float ascender) |
PAGE_RES * | RecognitionPass1 (BLOCK_LIST *block_list) |
PAGE_RES * | RecognitionPass2 (BLOCK_LIST *block_list, PAGE_RES *pass1_result) |
void | DetectParagraphs (int debug_level) |
const PAGE_RES * | GetPageRes () const |
Static Protected Member Functions |
static int | TesseractExtractResult (char **text, int **lengths, float **costs, int **x0, int **y0, int **x1, int **y1, PAGE_RES *page_res) |
Protected Attributes |
Tesseract * | tesseract_ |
| The underlying data object.
|
Tesseract * | osd_tesseract_ |
| For orientation & script detection.
|
EquationDetect * | equ_detect_ |
| The equation detector.
|
ImageThresholder * | thresholder_ |
| Image thresholding module.
|
GenericVector< ParagraphModel * > * | paragraph_models_ |
BLOCK_LIST * | block_list_ |
| The page layout.
|
PAGE_RES * | page_res_ |
| The page-level data.
|
STRING * | input_file_ |
| Name used by training code.
|
STRING * | output_file_ |
| Name used by debug code.
|
STRING * | datapath_ |
| Current location of tessdata.
|
STRING * | language_ |
| Last initialized language.
|
OcrEngineMode | last_oem_requested_ |
| Last ocr language mode requested.
|
bool | recognition_done_ |
| page_res_ contains recognition data.
|
TruthCallback * | truth_cb_ |
int | rect_left_ |
int | rect_top_ |
int | rect_width_ |
int | rect_height_ |
int | image_width_ |
int | image_height_ |
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.
int tesseract::TessBaseAPI::Init |
( |
const char * |
datapath, |
|
|
const char * |
language, |
|
|
OcrEngineMode |
mode, |
|
|
char ** |
configs, |
|
|
int |
configs_size, |
|
|
const GenericVector< STRING > * |
vars_vec, |
|
|
const GenericVector< STRING > * |
vars_values, |
|
|
bool |
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 [~]<lang>[+[~]<lang>]* 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.