tesseract-ocr  3.02.02
About: Tesseract is an Optical Character Recognition (OCR) engine.
  Fossies Dox: tesseract-ocr-3.02.02.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
tesseract::TessBaseAPI Class Reference

#include <baseapi.h>

Collaboration diagram for tesseract::TessBaseAPI:

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
 
void GetAvailableLanguagesAsVector (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)
 
PageIteratorAnalyseLayout ()
 
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)
 
ResultIteratorGetIterator ()
 
MutableIteratorGetMutableIterator ()
 
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 DawgGetDawg (int i) const
 
int NumDawgs () const
 
Tesseract *const tesseract () const
 
OcrEngineMode const oem () const
 
void InitTruthCallback (TruthCallback *cb)
 
CubeRecoContextGetCubeRecoContext () 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 ROWFindRowForBox (BLOCK_LIST *blocks, int left, int top, int right, int bottom)
 
static ROWMakeTessOCRRow (float baseline, float xheight, float descender, float ascender)
 
static TBLOBMakeTBLOB (Pix *pix)
 
static void NormalizeTBLOB (TBLOB *tblob, ROW *row, bool numeric_mode, DENORM *denorm)
 
static void DeleteBlockList (BLOCK_LIST *block_list)
 

Protected Member Functions

TESS_LOCAL bool InternalSetImage ()
 
virtual TESS_LOCAL void Threshold (Pix **pix)
 
TESS_LOCAL int FindLines ()
 
TESS_LOCAL void ClearResults ()
 
TESS_LOCAL LTRResultIteratorGetLTRIterator ()
 
TESS_LOCAL int TextLength (int *blob_count)
 
TESS_LOCAL void AdaptToCharacter (const char *unichar_repr, int length, float baseline, float xheight, float descender, float ascender)
 
TESS_LOCAL PAGE_RESRecognitionPass1 (BLOCK_LIST *block_list)
 
TESS_LOCAL PAGE_RESRecognitionPass2 (BLOCK_LIST *block_list, PAGE_RES *pass1_result)
 
TESS_LOCAL void DetectParagraphs (bool after_text_recognition)
 
TESS_LOCAL const PAGE_RESGetPageRes () const
 

Static Protected Member Functions

static TESS_LOCAL int TesseractExtractResult (char **text, int **lengths, float **costs, int **x0, int **y0, int **x1, int **y1, PAGE_RES *page_res)
 

Protected Attributes

Tesseracttesseract_
 The underlying data object. More...
 
Tesseractosd_tesseract_
 For orientation & script detection. More...
 
EquationDetectequ_detect_
 The equation detector. More...
 
ImageThresholderthresholder_
 Image thresholding module. More...
 
GenericVector< ParagraphModel * > * paragraph_models_
 
BLOCK_LIST * block_list_
 The page layout. More...
 
PAGE_RESpage_res_
 The page-level data. More...
 
STRINGinput_file_
 Name used by training code. More...
 
STRINGoutput_file_
 Name used by debug code. More...
 
STRINGdatapath_
 Current location of tessdata. More...
 
STRINGlanguage_
 Last initialized language. More...
 
OcrEngineMode last_oem_requested_
 Last ocr language mode requested. More...
 
bool recognition_done_
 page_res_ contains recognition data. More...
 
TruthCallbacktruth_cb_
 
int rect_left_
 
int rect_top_
 
int rect_width_
 
int rect_height_
 
int image_width_
 
int image_height_
 

Detailed Description

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.

Definition at line 102 of file baseapi.h.

Constructor & Destructor Documentation

tesseract::TessBaseAPI::TessBaseAPI ( )

Definition at line 101 of file baseapi.cpp.

tesseract::TessBaseAPI::~TessBaseAPI ( )
virtual

Definition at line 123 of file baseapi.cpp.

References End().

Member Function Documentation

void tesseract::TessBaseAPI::ClearAdaptiveClassifier ( )

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

Definition at line 419 of file baseapi.cpp.

References NULL, tesseract::Tesseract::ResetAdaptiveClassifier(), tesseract::Tesseract::ResetDocumentDictionary(), and tesseract_.

void tesseract::TessBaseAPI::ClearResults ( )
protected

Delete the pageres and block list ready for a new page.

Delete the pageres and clear the block list ready for a new page.

Definition at line 1699 of file baseapi.cpp.

References block_list_, tesseract::Tesseract::Clear(), GenericVector< T >::delete_data_pointers(), NULL, page_res_, paragraph_models_, recognition_done_, and tesseract_.

Referenced by Clear(), DetectOS(), FindLines(), InternalSetImage(), RecognizeForChopTest(), and SetRectangle().

void tesseract::TessBaseAPI::GetAvailableLanguagesAsVector ( GenericVector< STRING > *  langs) const

Returns the available languages in the vector of STRINGs.

Definition at line 293 of file baseapi.cpp.

References BOOL, GenericVector< T >::clear(), tesseract::CCUtil::datadir, NULL, GenericVector< T >::push_back(), STRING::string(), tesseract_, and TRUE.

Referenced by main().

bool tesseract::TessBaseAPI::GetBoolVariable ( const char *  name,
bool *  value 
) const
bool tesseract::TessBaseAPI::GetDoubleVariable ( const char *  name,
double *  value 
) const
const char * tesseract::TessBaseAPI::GetInitLanguagesAsString ( ) const

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.

Definition at line 269 of file baseapi.cpp.

References language_, NULL, and STRING::string().

bool tesseract::TessBaseAPI::GetIntVariable ( const char *  name,
int *  value 
) const

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

Definition at line 165 of file baseapi.cpp.

References GlobalParams(), tesseract::ParamsVectors::int_params, NULL, tesseract::CCUtil::params(), and tesseract_.

Referenced by AdaptToWordStr(), and DetectParagraphs().

void tesseract::TessBaseAPI::GetLoadedLanguagesAsVector ( GenericVector< STRING > *  langs) const

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.

Definition at line 279 of file baseapi.cpp.

References GenericVector< T >::clear(), tesseract::Tesseract::get_sub_lang(), tesseract::CCUtil::lang, NULL, tesseract::Tesseract::num_sub_langs(), GenericVector< T >::push_back(), and tesseract_.

LTRResultIterator * tesseract::TessBaseAPI::GetLTRIterator ( )
protected

Return an LTR Result Iterator – used only for training, as we really want to ignore all BiDi smarts at that point. delete once you're done with it.

Get a left-to-right iterator to the results of LayoutAnalysis and/or Recognize. The returned iterator must be deleted after use.

Definition at line 973 of file baseapi.cpp.

References tesseract::ImageThresholder::GetScaledYResolution(), tesseract::ImageThresholder::GetScaleFactor(), NULL, page_res_, rect_height_, rect_left_, rect_top_, rect_width_, tesseract_, and thresholder_.

Referenced by GetBoxText().

PageSegMode tesseract::TessBaseAPI::GetPageSegMode ( ) const

Return the current page segmentation mode.

Definition at line 377 of file baseapi.cpp.

References NULL, tesseract::PSM_SINGLE_BLOCK, and tesseract_.

Referenced by AdaptToWordStr(), and main().

const char * tesseract::TessBaseAPI::GetStringVariable ( const char *  name) const

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

Definition at line 181 of file baseapi.cpp.

References GlobalParams(), NULL, tesseract::CCUtil::params(), tesseract::StringParam::string(), tesseract::ParamsVectors::string_params, and tesseract_.

bool tesseract::TessBaseAPI::GetVariableAsString ( const char *  name,
STRING val 
)

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

Definition at line 196 of file baseapi.cpp.

References tesseract::ParamUtils::GetParamAsString(), tesseract::CCUtil::params(), and tesseract_.

int tesseract::TessBaseAPI::Init ( const char *  datapath,
const char *  language,
OcrEngineMode  oem,
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.

The datapath must be the name of the data directory (no ending /) or some other file in which the data directory resides (for instance argv[0].) The language is (usually) an ISO 639-3 string or NULL will default to eng. If numeric_mode is true, then only digits and Roman numerals will be returned.

Returns
: 0 on success and -1 on initialization failure.

Definition at line 213 of file baseapi.cpp.

References datapath_, tesseract::Tesseract::init_tesseract(), tesseract::CCUtil::lang, language_, last_oem_requested_, NULL, oem(), output_file_, tesseract::Tesseract::ResetAdaptiveClassifier(), STRING::string(), and tesseract_.

Referenced by main().

int tesseract::TessBaseAPI::Init ( const char *  datapath,
const char *  language,
OcrEngineMode  oem 
)
inline

Definition at line 206 of file baseapi.h.

References NULL.

int tesseract::TessBaseAPI::Init ( const char *  datapath,
const char *  language 
)
inline

Definition at line 209 of file baseapi.h.

References NULL, and tesseract::OEM_DEFAULT.

void tesseract::TessBaseAPI::InitForAnalysePage ( )

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

Definition at line 344 of file baseapi.cpp.

References tesseract::Classify::InitAdaptiveClassifier(), NULL, and tesseract_.

int tesseract::TessBaseAPI::InitLangMod ( const char *  datapath,
const char *  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.

Definition at line 334 of file baseapi.cpp.

References tesseract::Tesseract::init_tesseract_lm(), NULL, and tesseract_.

bool tesseract::TessBaseAPI::InternalSetImage ( )
protected

Common code for setting the image. Returns true if Init has been called.

Common code for setting the image.

Definition at line 1586 of file baseapi.cpp.

References ClearResults(), NULL, tesseract_, thresholder_, and tprintf().

Referenced by SetImage().

void tesseract::TessBaseAPI::PrintVariables ( FILE *  fp) const

Print Tesseract parameters to the given file.

Definition at line 201 of file baseapi.cpp.

References tesseract::CCUtil::params(), tesseract::ParamUtils::PrintParams(), and tesseract_.

Referenced by ProcessPage().

void tesseract::TessBaseAPI::ReadConfigFile ( const char *  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()).

Read a "config" file containing a set of parameter name, value pairs. Searches the standard places: tessdata/configs, tessdata/tessconfigs and also accepts a relative or absolute path name.

Definition at line 356 of file baseapi.cpp.

References tesseract::Tesseract::read_config_file(), tesseract::SET_PARAM_CONSTRAINT_NON_INIT_ONLY, and tesseract_.

Referenced by ProcessPage().

void tesseract::TessBaseAPI::ReadDebugConfigFile ( const char *  filename)

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

Definition at line 361 of file baseapi.cpp.

References tesseract::Tesseract::read_config_file(), tesseract::SET_PARAM_CONSTRAINT_DEBUG_ONLY, and tesseract_.

bool tesseract::TessBaseAPI::SetDebugVariable ( const char *  name,
const char *  value 
)
void tesseract::TessBaseAPI::SetInputName ( const char *  name)

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

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

Definition at line 138 of file baseapi.cpp.

References input_file_, and NULL.

Referenced by GetHOCRText(), and ProcessPage().

void tesseract::TessBaseAPI::SetOutputName ( const char *  name)

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

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

Definition at line 146 of file baseapi.cpp.

References NULL, and output_file_.

Referenced by main().

void tesseract::TessBaseAPI::SetPageSegMode ( PageSegMode  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).

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

Definition at line 370 of file baseapi.cpp.

References NULL, and tesseract_.

Referenced by AdaptToWordStr(), and main().

bool tesseract::TessBaseAPI::SetVariable ( const char *  name,
const char *  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(). TODO(rays) Add a command-line option to dump the parameters to stdout and add a pointer to it in the FAQ

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

Definition at line 153 of file baseapi.cpp.

References NULL, tesseract::CCUtil::params(), tesseract::SET_PARAM_CONSTRAINT_NON_INIT_ONLY, tesseract::ParamUtils::SetParam(), and tesseract_.

Referenced by AdaptToWordStr(), and ProcessPages().

char * tesseract::TessBaseAPI::TesseractRect ( const unsigned char *  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.

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 one pixel is 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.

Definition at line 397 of file baseapi.cpp.

References GetUTF8Text(), tesseract::kMinRectSize, NULL, SetImage(), SetRectangle(), and tesseract_.

int tesseract::TessBaseAPI::TextLength ( int *  blob_count)
protected

Return the length of the output text string, as UTF8, assuming one newline per line and one per block, with a terminator, and assuming a single character reject marker for each rejected character. Also return the number of recognized blobs in blob_count.

Return the length of the output text string, as UTF8, assuming liberally two spacing marks after each word (as paragraphs end with two newlines), and assuming a single character reject marker for each rejected character. Also return the number of recognized blobs in blob_count.

Definition at line 1726 of file baseapi.cpp.

References WERD_RES::best_choice, PAGE_RES_IT::forward(), STRING::length(), WERD_CHOICE::length(), REJMAP::length(), NULL, page_res_, WERD_RES::reject_map, PAGE_RES_IT::restart_page(), tesseract_, WERD_CHOICE::unichar_string(), and PAGE_RES_IT::word().

Referenced by GetBoxText(), and GetUNLVText().

void tesseract::TessBaseAPI::Threshold ( Pix **  pix)
protectedvirtual
const char * tesseract::TessBaseAPI::Version ( )
static

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

Definition at line 130 of file baseapi.cpp.

Referenced by main().

Member Data Documentation

BLOCK_LIST* tesseract::TessBaseAPI::block_list_
protected
STRING* tesseract::TessBaseAPI::datapath_
protected

Current location of tessdata.

Definition at line 770 of file baseapi.h.

Referenced by End(), FindLines(), and Init().

EquationDetect* tesseract::TessBaseAPI::equ_detect_
protected

The equation detector.

Definition at line 763 of file baseapi.h.

Referenced by End(), and FindLines().

STRING* tesseract::TessBaseAPI::input_file_
protected

Name used by training code.

Definition at line 768 of file baseapi.h.

Referenced by DetectOS(), End(), FindLines(), GetHOCRText(), Recognize(), and SetInputName().

STRING* tesseract::TessBaseAPI::language_
protected

Last initialized language.

Definition at line 771 of file baseapi.h.

Referenced by End(), FindLines(), GetInitLanguagesAsString(), and Init().

OcrEngineMode tesseract::TessBaseAPI::last_oem_requested_
protected

Last ocr language mode requested.

Definition at line 772 of file baseapi.h.

Referenced by Init().

Tesseract* tesseract::TessBaseAPI::osd_tesseract_
protected

For orientation & script detection.

Definition at line 762 of file baseapi.h.

Referenced by End(), and FindLines().

STRING* tesseract::TessBaseAPI::output_file_
protected

Name used by debug code.

Definition at line 769 of file baseapi.h.

Referenced by End(), Init(), Recognize(), and SetOutputName().

GenericVector<ParagraphModel *>* tesseract::TessBaseAPI::paragraph_models_
protected

Definition at line 765 of file baseapi.h.

Referenced by ClearResults(), DetectParagraphs(), and End().

bool tesseract::TessBaseAPI::recognition_done_
protected

page_res_ contains recognition data.

Definition at line 773 of file baseapi.h.

Referenced by AllWordConfidences(), ClearResults(), FindLines(), GetBoxText(), GetUNLVText(), GetUTF8Text(), Recognize(), and RecognizeForChopTest().

TruthCallback* tesseract::TessBaseAPI::truth_cb_
protected

Definition at line 774 of file baseapi.h.

Referenced by Recognize().


The documentation for this class was generated from the following files: