tesseract  4.1.1
tesseract::TessBaseAPI Class Reference

#include <baseapi.h>

Public Member Functions

 TessBaseAPI ()
 
virtual ~TessBaseAPI ()
 
void SetInputName (const char *name)
 
const char * GetInputName ()
 
void SetInputImage (Pix *pix)
 
Pix * GetInputImage ()
 
int GetSourceYResolution ()
 
const char * GetDatapath ()
 
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)
 
int Init (const char *data, int data_size, 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, FileReader reader)
 
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 (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 (bool raw_image, int raw_padding, Pixa **pixa, int **blockids, int **paraids)
 
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, bool raw_image, int raw_padding, Pixa **pixa, int **blockids, int **paraids)
 
Boxa * GetComponentImages (const PageIteratorLevel level, const bool text_only, Pixa **pixa, int **blockids)
 
int GetThresholdedImageScaleFactor () const
 
PageIteratorAnalyseLayout ()
 
PageIteratorAnalyseLayout (bool merge_similar_words)
 
int Recognize (ETEXT_DESC *monitor)
 
int RecognizeForChopTest (ETEXT_DESC *monitor)
 
bool ProcessPages (const char *filename, const char *retry_config, int timeout_millisec, TessResultRenderer *renderer)
 
bool ProcessPagesInternal (const char *filename, const char *retry_config, int timeout_millisec, TessResultRenderer *renderer)
 
bool ProcessPage (Pix *pix, int page_index, const char *filename, const char *retry_config, int timeout_millisec, TessResultRenderer *renderer)
 
ResultIteratorGetIterator ()
 
MutableIteratorGetMutableIterator ()
 
char * GetUTF8Text ()
 
char * GetHOCRText (ETEXT_DESC *monitor, int page_number)
 
char * GetHOCRText (int page_number)
 
char * GetAltoText (ETEXT_DESC *monitor, int page_number)
 
char * GetAltoText (int page_number)
 
char * GetTSVText (int page_number)
 
char * GetLSTMBoxText (int page_number)
 
char * GetBoxText (int page_number)
 
char * GetWordStrBoxText (int page_number)
 
char * GetUNLVText ()
 
bool DetectOrientationScript (int *orient_deg, float *orient_conf, const char **script_name, float *script_conf)
 
char * GetOsdText (int page_number)
 
int MeanTextConf ()
 
int * AllWordConfidences ()
 
bool AdaptToWordStr (PageSegMode mode, const char *wordstr)
 
void Clear ()
 
void End ()
 
int IsValidWord (const char *word)
 
bool IsValidCharacter (const char *utf8_character)
 
bool GetTextDirection (int *out_offset, float *out_slope)
 
void SetDictFunc (DictFunc f)
 
void SetProbabilityInContextFunc (ProbabilityInContextFunc f)
 
bool DetectOS (OSResults *)
 
void GetBlockTextOrientations (int **block_orientation, bool **vertical_writing)
 
void SetFillLatticeFunc (FillLatticeFunc f)
 
BLOCK_LIST * FindLinesCreateBlockList ()
 
void GetFeaturesForBlob (TBLOB *blob, INT_FEATURE_STRUCT *int_features, int *num_features, int *feature_outline_index)
 
void RunAdaptiveClassifier (TBLOB *blob, 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
 
Tesseracttesseract () const
 
OcrEngineMode oem () const
 
void InitTruthCallback (TruthCallback *cb)
 
void set_min_orientation_margin (double margin)
 

Static Public Member Functions

static const char * Version ()
 
static size_t getOpenCLDevice (void **device)
 
static void CatchSignals ()
 
static void ClearPersistentCache ()
 
static void DeleteBlockList (BLOCK_LIST *block_list)
 
static ROWMakeTessOCRRow (float baseline, float xheight, float descender, float ascender)
 
static TBLOBMakeTBLOB (Pix *pix)
 
static void NormalizeTBLOB (TBLOB *tblob, ROW *row, bool numeric_mode)
 
static ROWFindRowForBox (BLOCK_LIST *blocks, int left, int top, int right, int bottom)
 

Protected Member Functions

TESS_LOCAL bool InternalSetImage ()
 
virtual TESS_LOCAL bool Threshold (Pix **pix)
 
TESS_LOCAL int FindLines ()
 
void ClearResults ()
 
TESS_LOCAL LTRResultIteratorGetLTRIterator ()
 
TESS_LOCAL int TextLength (int *blob_count)
 
TESS_LOCAL void DetectParagraphs (bool after_text_recognition)
 
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 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...
 
FileReader reader_
 Reads files from any filesystem. 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 91 of file baseapi.h.

Constructor & Destructor Documentation

◆ TessBaseAPI()

tesseract::TessBaseAPI::TessBaseAPI ( )

Definition at line 189 of file baseapi.cpp.

190  : tesseract_(nullptr),
191  osd_tesseract_(nullptr),
192  equ_detect_(nullptr),
193  reader_(nullptr),
194  // Thresholder is initialized to nullptr here, but will be set before use by:
195  // A constructor of a derived API, SetThresholder(), or
196  // created implicitly when used in InternalSetImage.
197  thresholder_(nullptr),
198  paragraph_models_(nullptr),
199  block_list_(nullptr),
200  page_res_(nullptr),
201  input_file_(nullptr),
202  output_file_(nullptr),
203  datapath_(nullptr),
204  language_(nullptr),
206  recognition_done_(false),
207  truth_cb_(nullptr),
208  rect_left_(0),
209  rect_top_(0),
210  rect_width_(0),
211  rect_height_(0),
212  image_width_(0),
213  image_height_(0) {
214 #if defined(DEBUG)
215  // The Tesseract executables would use the "C" locale by default,
216  // but other software which is linked against the Tesseract library
217  // typically uses the locale from the user's environment.
218  // Here the default is overridden to allow debugging of potential
219  // problems caused by the locale settings.
220 
221  // Use the current locale if building debug code.
222  std::locale::global(std::locale(""));
223 #endif
224 }
STRING * language_
Last initialized language.
Definition: baseapi.h:899
Tesseract * osd_tesseract_
For orientation & script detection.
Definition: baseapi.h:889
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
ImageThresholder * thresholder_
Image thresholding module.
Definition: baseapi.h:892
STRING * datapath_
Current location of tessdata.
Definition: baseapi.h:898
BLOCK_LIST * block_list_
The page layout.
Definition: baseapi.h:894
GenericVector< ParagraphModel * > * paragraph_models_
Definition: baseapi.h:893
STRING * input_file_
Name used by training code.
Definition: baseapi.h:896
PAGE_RES * page_res_
The page-level data.
Definition: baseapi.h:895
TruthCallback * truth_cb_
Definition: baseapi.h:902
STRING * output_file_
Name used by debug code.
Definition: baseapi.h:897
FileReader reader_
Reads files from any filesystem.
Definition: baseapi.h:891
OcrEngineMode last_oem_requested_
Last ocr language mode requested.
Definition: baseapi.h:900
EquationDetect * equ_detect_
The equation detector.
Definition: baseapi.h:890
bool recognition_done_
page_res_ contains recognition data.
Definition: baseapi.h:901

◆ ~TessBaseAPI()

tesseract::TessBaseAPI::~TessBaseAPI ( )
virtual

Definition at line 226 of file baseapi.cpp.

226  {
227  End();
228 }

Member Function Documentation

◆ CatchSignals()

void tesseract::TessBaseAPI::CatchSignals ( )
static

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

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

Definition at line 262 of file baseapi.cpp.

262  {
263  // Warn API users that an implementation is needed.
264  tprintf("Deprecated method CatchSignals has only a dummy implementation!\n");
265 }
DLLSYM void tprintf(const char *format,...)
Definition: tprintf.cpp:35

◆ ClearAdaptiveClassifier()

void tesseract::TessBaseAPI::ClearAdaptiveClassifier ( )

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

Definition at line 565 of file baseapi.cpp.

565  {
566  if (tesseract_ == nullptr)
567  return;
570 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888

◆ ClearResults()

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 2144 of file baseapi.cpp.

2144  {
2145  if (tesseract_ != nullptr) {
2146  tesseract_->Clear();
2147  }
2148  delete page_res_;
2149  page_res_ = nullptr;
2150  recognition_done_ = false;
2151  if (block_list_ == nullptr)
2152  block_list_ = new BLOCK_LIST;
2153  else
2154  block_list_->clear();
2155  if (paragraph_models_ != nullptr) {
2157  delete paragraph_models_;
2158  paragraph_models_ = nullptr;
2159  }
2160 }
void delete_data_pointers()
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
BLOCK_LIST * block_list_
The page layout.
Definition: baseapi.h:894
GenericVector< ParagraphModel * > * paragraph_models_
Definition: baseapi.h:893
PAGE_RES * page_res_
The page-level data.
Definition: baseapi.h:895
bool recognition_done_
page_res_ contains recognition data.
Definition: baseapi.h:901

◆ DetectParagraphs()

void tesseract::TessBaseAPI::DetectParagraphs ( bool  after_text_recognition)
protected

Definition at line 2278 of file baseapi.cpp.

2278  {
2279  int debug_level = 0;
2280  GetIntVariable("paragraph_debug_level", &debug_level);
2281  if (paragraph_models_ == nullptr)
2283  MutableIterator *result_it = GetMutableIterator();
2284  do { // Detect paragraphs for this block
2286  ::tesseract::DetectParagraphs(debug_level, after_text_recognition,
2287  result_it, &models);
2288  *paragraph_models_ += models;
2289  } while (result_it->Next(RIL_BLOCK));
2290  delete result_it;
2291 }
void DetectParagraphs(int debug_level, GenericVector< RowInfo > *row_infos, GenericVector< PARA *> *row_owners, PARA_LIST *paragraphs, GenericVector< ParagraphModel *> *models)
MutableIterator * GetMutableIterator()
Definition: baseapi.cpp:1341
bool GetIntVariable(const char *name, int *value) const
Definition: baseapi.cpp:298
GenericVector< ParagraphModel * > * paragraph_models_
Definition: baseapi.h:893

◆ FindLines()

int tesseract::TessBaseAPI::FindLines ( )
protected

Find lines from the image making the BLOCK_LIST.

Returns
0 on success.

Find lines from the image making the BLOCK_LIST.

Definition at line 2068 of file baseapi.cpp.

2068  {
2069  if (thresholder_ == nullptr || thresholder_->IsEmpty()) {
2070  tprintf("Please call SetImage before attempting recognition.\n");
2071  return -1;
2072  }
2073  if (recognition_done_)
2074  ClearResults();
2075  if (!block_list_->empty()) {
2076  return 0;
2077  }
2078  if (tesseract_ == nullptr) {
2079  tesseract_ = new Tesseract;
2080  #ifndef DISABLED_LEGACY_ENGINE
2082  #endif
2083  }
2084  if (tesseract_->pix_binary() == nullptr &&
2086  return -1;
2087  }
2088 
2090 
2091 #ifndef DISABLED_LEGACY_ENGINE
2093  if (equ_detect_ == nullptr && datapath_ != nullptr) {
2094  equ_detect_ = new EquationDetect(datapath_->string(), nullptr);
2095  }
2096  if (equ_detect_ == nullptr) {
2097  tprintf("Warning: Could not set equation detector\n");
2098  } else {
2100  }
2101  }
2102 #endif // ndef DISABLED_LEGACY_ENGINE
2103 
2104  Tesseract* osd_tess = osd_tesseract_;
2105  OSResults osr;
2107  osd_tess == nullptr) {
2108  if (strcmp(language_->string(), "osd") == 0) {
2109  osd_tess = tesseract_;
2110  } else {
2111  osd_tesseract_ = new Tesseract;
2112  TessdataManager mgr(reader_);
2113  if (datapath_ == nullptr) {
2114  tprintf("Warning: Auto orientation and script detection requested,"
2115  " but data path is undefined\n");
2116  delete osd_tesseract_;
2117  osd_tesseract_ = nullptr;
2118  } else if (osd_tesseract_->init_tesseract(datapath_->string(), nullptr,
2119  "osd", OEM_TESSERACT_ONLY,
2120  nullptr, 0, nullptr, nullptr,
2121  false, &mgr) == 0) {
2122  osd_tess = osd_tesseract_;
2125  } else {
2126  tprintf("Warning: Auto orientation and script detection requested,"
2127  " but osd language failed to load\n");
2128  delete osd_tesseract_;
2129  osd_tesseract_ = nullptr;
2130  }
2131  }
2132  }
2133 
2134  if (tesseract_->SegmentPage(input_file_, block_list_, osd_tess, &osr) < 0)
2135  return -1;
2136 
2137  // If Devanagari is being recognized, we use different images for page seg
2138  // and for OCR.
2139  tesseract_->PrepareForTessOCR(block_list_, osd_tess, &osr);
2140  return 0;
2141 }
DLLSYM void tprintf(const char *format,...)
Definition: tprintf.cpp:35
void set_source_resolution(int ppi)
STRING * language_
Last initialized language.
Definition: baseapi.h:899
Pix * pix_binary() const
int init_tesseract(const char *arg0, const char *textbase, const char *language, OcrEngineMode oem, char **configs, int configs_size, const GenericVector< STRING > *vars_vec, const GenericVector< STRING > *vars_values, bool set_only_init_params, TessdataManager *mgr)
Definition: tessedit.cpp:286
Tesseract * osd_tesseract_
For orientation & script detection.
Definition: baseapi.h:889
virtual TESS_LOCAL bool Threshold(Pix **pix)
Definition: baseapi.cpp:2014
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
const char * string() const
Definition: strngs.cpp:194
void PrepareForTessOCR(BLOCK_LIST *block_list, Tesseract *osd_tess, OSResults *osr)
ImageThresholder * thresholder_
Image thresholding module.
Definition: baseapi.h:892
int SegmentPage(const STRING *input_file, BLOCK_LIST *blocks, Tesseract *osd_tess, OSResults *osr)
Definition: pagesegmain.cpp:99
void InitAdaptiveClassifier(TessdataManager *mgr)
Definition: adaptmatch.cpp:527
STRING * datapath_
Current location of tessdata.
Definition: baseapi.h:898
BLOCK_LIST * block_list_
The page layout.
Definition: baseapi.h:894
STRING * input_file_
Name used by training code.
Definition: baseapi.h:896
FileReader reader_
Reads files from any filesystem.
Definition: baseapi.h:891
bool IsEmpty() const
Return true if no image has been set.
Definition: thresholder.cpp:53
int GetSourceYResolution() const
Definition: thresholder.h:89
EquationDetect * equ_detect_
The equation detector.
Definition: baseapi.h:890
bool recognition_done_
page_res_ contains recognition data.
Definition: baseapi.h:901
bool PSM_OSD_ENABLED(int pageseg_mode)
Definition: publictypes.h:191
void SetEquationDetect(EquationDetect *detector)

◆ GetAvailableLanguagesAsVector()

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

Returns the available languages in the sorted vector of STRINGs.

Definition at line 456 of file baseapi.cpp.

457  {
458  langs->clear();
459  if (tesseract_ != nullptr) {
460  addAvailableLanguages(tesseract_->datadir, "", langs);
461  langs->sort(CompareSTRING);
462  }
463 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
STRING datadir
Definition: ccutil.h:69

◆ GetBoolVariable()

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

Definition at line 306 of file baseapi.cpp.

306  {
307  auto *p = ParamUtils::FindParam<BoolParam>(
309  if (p == nullptr) return false;
310  *value = bool(*p);
311  return true;
312 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
GenericVector< BoolParam * > bool_params
Definition: params.h:44
tesseract::ParamsVectors * GlobalParams()
Definition: params.cpp:32
ParamsVectors * params()
Definition: ccutil.h:67

◆ GetDatapath()

const char * tesseract::TessBaseAPI::GetDatapath ( )

Definition at line 966 of file baseapi.cpp.

966  {
967  return tesseract_->datadir.c_str();
968 }
const char * c_str() const
Definition: strngs.cpp:205
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
STRING datadir
Definition: ccutil.h:69

◆ GetDoubleVariable()

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

Definition at line 320 of file baseapi.cpp.

320  {
321  auto *p = ParamUtils::FindParam<DoubleParam>(
323  if (p == nullptr) return false;
324  *value = (double)(*p);
325  return true;
326 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
tesseract::ParamsVectors * GlobalParams()
Definition: params.cpp:32
GenericVector< DoubleParam * > double_params
Definition: params.h:46
ParamsVectors * params()
Definition: ccutil.h:67

◆ GetInitLanguagesAsString()

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 432 of file baseapi.cpp.

432  {
433  return (language_ == nullptr || language_->string() == nullptr) ?
434  "" : language_->string();
435 }
STRING * language_
Last initialized language.
Definition: baseapi.h:899
const char * string() const
Definition: strngs.cpp:194

◆ GetInputImage()

Pix * tesseract::TessBaseAPI::GetInputImage ( )

Definition at line 958 of file baseapi.cpp.

958 { return tesseract_->pix_original(); }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
Pix * pix_original() const

◆ GetInputName()

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

Definition at line 960 of file baseapi.cpp.

960  {
961  if (input_file_)
962  return input_file_->c_str();
963  return nullptr;
964 }
const char * c_str() const
Definition: strngs.cpp:205
STRING * input_file_
Name used by training code.
Definition: baseapi.h:896

◆ GetIntVariable()

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 298 of file baseapi.cpp.

298  {
299  auto *p = ParamUtils::FindParam<IntParam>(
301  if (p == nullptr) return false;
302  *value = (int32_t)(*p);
303  return true;
304 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
tesseract::ParamsVectors * GlobalParams()
Definition: params.cpp:32
GenericVector< IntParam * > int_params
Definition: params.h:43
ParamsVectors * params()
Definition: ccutil.h:67

◆ GetLoadedLanguagesAsVector()

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 442 of file baseapi.cpp.

443  {
444  langs->clear();
445  if (tesseract_ != nullptr) {
446  langs->push_back(tesseract_->lang);
447  int num_subs = tesseract_->num_sub_langs();
448  for (int i = 0; i < num_subs; ++i)
449  langs->push_back(tesseract_->get_sub_lang(i)->lang);
450  }
451 }
Tesseract * get_sub_lang(int index) const
STRING lang
Definition: ccutil.h:71
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
int num_sub_langs() const
int push_back(T object)

◆ GetLTRIterator()

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 1307 of file baseapi.cpp.

1307  {
1308  if (tesseract_ == nullptr || page_res_ == nullptr)
1309  return nullptr;
1310  return new LTRResultIterator(
1314 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
ImageThresholder * thresholder_
Image thresholding module.
Definition: baseapi.h:892
int GetScaledYResolution() const
Definition: thresholder.h:92
PAGE_RES * page_res_
The page-level data.
Definition: baseapi.h:895

◆ getOpenCLDevice()

size_t tesseract::TessBaseAPI::getOpenCLDevice ( void **  data)
static

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=nullptr and returns 0.

Definition at line 244 of file baseapi.cpp.

244  {
245 #ifdef USE_OPENCL
246  ds_device device = OpenclDevice::getDeviceSelection();
247  if (device.type == DS_DEVICE_OPENCL_DEVICE) {
248  *data = new cl_device_id;
249  memcpy(*data, &device.oclDeviceID, sizeof(cl_device_id));
250  return sizeof(cl_device_id);
251  }
252 #endif
253 
254  *data = nullptr;
255  return 0;
256 }

◆ GetPageSegMode()

PageSegMode tesseract::TessBaseAPI::GetPageSegMode ( ) const

Return the current page segmentation mode.

Definition at line 522 of file baseapi.cpp.

522  {
523  if (tesseract_ == nullptr)
524  return PSM_SINGLE_BLOCK;
525  return static_cast<PageSegMode>(
526  static_cast<int>(tesseract_->tessedit_pageseg_mode));
527 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
Assume a single uniform block of text. (Default.)
Definition: publictypes.h:172

◆ GetSourceYResolution()

int tesseract::TessBaseAPI::GetSourceYResolution ( )

Definition at line 970 of file baseapi.cpp.

970  {
972 }
ImageThresholder * thresholder_
Image thresholding module.
Definition: baseapi.h:892
int GetSourceYResolution() const
Definition: thresholder.h:89

◆ GetStringVariable()

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 314 of file baseapi.cpp.

314  {
315  auto *p = ParamUtils::FindParam<StringParam>(
317  return (p != nullptr) ? p->string() : nullptr;
318 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
tesseract::ParamsVectors * GlobalParams()
Definition: params.cpp:32
ParamsVectors * params()
Definition: ccutil.h:67
GenericVector< StringParam * > string_params
Definition: params.h:45

◆ GetVariableAsString()

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

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

Definition at line 329 of file baseapi.cpp.

329  {
330  return ParamUtils::GetParamAsString(name, tesseract_->params(), val);
331 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
ParamsVectors * params()
Definition: ccutil.h:67
static bool GetParamAsString(const char *name, const ParamsVectors *member_params, STRING *value)
Definition: params.cpp:129

◆ Init() [1/4]

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 tessdata directory. The language is (usually) an ISO 639-3 string or nullptr 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 or some other file in which the data directory resides (for instance argv[0].) The language is (usually) an ISO 639-3 string or nullptr 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 346 of file baseapi.cpp.

350  {
351  return Init(datapath, 0, language, oem, configs, configs_size, vars_vec,
352  vars_values, set_only_non_debug_params, nullptr);
353 }
OcrEngineMode oem() const
Definition: baseapi.h:803
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)
Definition: baseapi.cpp:346

◆ Init() [2/4]

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

Definition at line 220 of file baseapi.h.

220  {
221  return Init(datapath, language, oem, nullptr, 0, nullptr, nullptr, false);
222  }
OcrEngineMode oem() const
Definition: baseapi.h:803
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)
Definition: baseapi.cpp:346

◆ Init() [3/4]

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

Definition at line 223 of file baseapi.h.

223  {
224  return Init(datapath, language, OEM_DEFAULT, nullptr, 0, nullptr, nullptr, false);
225  }
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)
Definition: baseapi.cpp:346

◆ Init() [4/4]

int tesseract::TessBaseAPI::Init ( const char *  data,
int  data_size,
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,
FileReader  reader 
)

Definition at line 358 of file baseapi.cpp.

362  {
363  // Default language is "eng".
364  if (language == nullptr) language = "eng";
365  STRING datapath = data_size == 0 ? data : language;
366  // If the datapath, OcrEngineMode or the language have changed - start again.
367  // Note that the language_ field stores the last requested language that was
368  // initialized successfully, while tesseract_->lang stores the language
369  // actually used. They differ only if the requested language was nullptr, in
370  // which case tesseract_->lang is set to the Tesseract default ("eng").
371  if (tesseract_ != nullptr &&
372  (datapath_ == nullptr || language_ == nullptr || *datapath_ != datapath ||
374  (*language_ != language && tesseract_->lang != language))) {
375  delete tesseract_;
376  tesseract_ = nullptr;
377  }
378 #ifdef USE_OPENCL
379  OpenclDevice od;
380  od.InitEnv();
381 #endif
382  bool reset_classifier = true;
383  if (tesseract_ == nullptr) {
384  reset_classifier = false;
385  tesseract_ = new Tesseract;
386  if (reader != nullptr) reader_ = reader;
387  TessdataManager mgr(reader_);
388  if (data_size != 0) {
389  mgr.LoadMemBuffer(language, data, data_size);
390  }
392  datapath.string(),
393  output_file_ != nullptr ? output_file_->string() : nullptr,
394  language, oem, configs, configs_size, vars_vec, vars_values,
395  set_only_non_debug_params, &mgr) != 0) {
396  return -1;
397  }
398  }
399 
400  // Update datapath and language requested for the last valid initialization.
401  if (datapath_ == nullptr)
402  datapath_ = new STRING(datapath);
403  else
404  *datapath_ = datapath;
405  if ((strcmp(datapath_->string(), "") == 0) &&
406  (strcmp(tesseract_->datadir.string(), "") != 0))
408 
409  if (language_ == nullptr)
410  language_ = new STRING(language);
411  else
412  *language_ = language;
414 
415 #ifndef DISABLED_LEGACY_ENGINE
416  // For same language and datapath, just reset the adaptive classifier.
417  if (reset_classifier) {
419  }
420 #endif // ndef DISABLED_LEGACY_ENGINE
421  return 0;
422 }
STRING * language_
Last initialized language.
Definition: baseapi.h:899
int init_tesseract(const char *arg0, const char *textbase, const char *language, OcrEngineMode oem, char **configs, int configs_size, const GenericVector< STRING > *vars_vec, const GenericVector< STRING > *vars_values, bool set_only_init_params, TessdataManager *mgr)
Definition: tessedit.cpp:286
OcrEngineMode oem() const
Definition: baseapi.h:803
STRING lang
Definition: ccutil.h:71
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
const char * string() const
Definition: strngs.cpp:194
STRING * datapath_
Current location of tessdata.
Definition: baseapi.h:898
Definition: strngs.h:45
STRING * output_file_
Name used by debug code.
Definition: baseapi.h:897
FileReader reader_
Reads files from any filesystem.
Definition: baseapi.h:891
OcrEngineMode last_oem_requested_
Last ocr language mode requested.
Definition: baseapi.h:900
STRING datadir
Definition: ccutil.h:69

◆ InitForAnalysePage()

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 487 of file baseapi.cpp.

487  {
488  if (tesseract_ == nullptr) {
489  tesseract_ = new Tesseract;
490  #ifndef DISABLED_LEGACY_ENGINE
492  #endif
493  }
494 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
void InitAdaptiveClassifier(TessdataManager *mgr)
Definition: adaptmatch.cpp:527

◆ InitLangMod()

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 473 of file baseapi.cpp.

473  {
474  if (tesseract_ == nullptr)
475  tesseract_ = new Tesseract;
476  else
478  TessdataManager mgr;
479  return tesseract_->init_tesseract_lm(datapath, nullptr, language, &mgr);
480 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
static void ResetToDefaults(ParamsVectors *member_params)
Definition: params.cpp:199
int init_tesseract_lm(const char *arg0, const char *textbase, const char *language, TessdataManager *mgr)
Definition: tessedit.cpp:452
ParamsVectors * params()
Definition: ccutil.h:67

◆ InternalSetImage()

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 1997 of file baseapi.cpp.

1997  {
1998  if (tesseract_ == nullptr) {
1999  tprintf("Please call Init before attempting to set an image.\n");
2000  return false;
2001  }
2002  if (thresholder_ == nullptr)
2003  thresholder_ = new ImageThresholder;
2004  ClearResults();
2005  return true;
2006 }
DLLSYM void tprintf(const char *format,...)
Definition: tprintf.cpp:35
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
ImageThresholder * thresholder_
Image thresholding module.
Definition: baseapi.h:892

◆ PrintVariables()

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

Print Tesseract parameters to the given file.

Definition at line 334 of file baseapi.cpp.

334  {
336 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
ParamsVectors * params()
Definition: ccutil.h:67
static void PrintParams(FILE *fp, const ParamsVectors *member_params)
Definition: params.cpp:168

◆ ReadConfigFile()

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 501 of file baseapi.cpp.

501  {
503 }
void read_config_file(const char *filename, SetParamConstraint constraint)
Definition: tessedit.cpp:48
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888

◆ ReadDebugConfigFile()

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

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

Definition at line 506 of file baseapi.cpp.

506  {
508 }
void read_config_file(const char *filename, SetParamConstraint constraint)
Definition: tessedit.cpp:48
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888

◆ SetDebugVariable()

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

Definition at line 292 of file baseapi.cpp.

292  {
293  if (tesseract_ == nullptr) tesseract_ = new Tesseract;
295  tesseract_->params());
296 }
static bool SetParam(const char *name, const char *value, SetParamConstraint constraint, ParamsVectors *member_params)
Definition: params.cpp:79
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
ParamsVectors * params()
Definition: ccutil.h:67

◆ SetInputImage()

void tesseract::TessBaseAPI::SetInputImage ( Pix *  pix)

Definition at line 956 of file baseapi.cpp.

956 { tesseract_->set_pix_original(pix); }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
void set_pix_original(Pix *original_pix)

◆ SetInputName()

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

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

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

Definition at line 271 of file baseapi.cpp.

271  {
272  if (input_file_ == nullptr)
273  input_file_ = new STRING(name);
274  else
275  *input_file_ = name;
276 }
STRING * input_file_
Name used by training code.
Definition: baseapi.h:896
Definition: strngs.h:45

◆ SetOutputName()

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 279 of file baseapi.cpp.

279  {
280  if (output_file_ == nullptr)
281  output_file_ = new STRING(name);
282  else
283  *output_file_ = name;
284 }
Definition: strngs.h:45
STRING * output_file_
Name used by debug code.
Definition: baseapi.h:897

◆ SetPageSegMode()

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 515 of file baseapi.cpp.

515  {
516  if (tesseract_ == nullptr)
517  tesseract_ = new Tesseract;
518  tesseract_->tessedit_pageseg_mode.set_value(mode);
519 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888

◆ SetVariable()

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

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

Definition at line 286 of file baseapi.cpp.

286  {
287  if (tesseract_ == nullptr) tesseract_ = new Tesseract;
289  tesseract_->params());
290 }
static bool SetParam(const char *name, const char *value, SetParamConstraint constraint, ParamsVectors *member_params)
Definition: params.cpp:79
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
ParamsVectors * params()
Definition: ccutil.h:67

◆ TesseractRect()

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 542 of file baseapi.cpp.

546  {
547  if (tesseract_ == nullptr || width < kMinRectSize || height < kMinRectSize)
548  return nullptr; // Nothing worth doing.
549 
550  // Since this original api didn't give the exact size of the image,
551  // we have to invent a reasonable value.
552  int bits_per_pixel = bytes_per_pixel == 0 ? 1 : bytes_per_pixel * 8;
553  SetImage(imagedata, bytes_per_line * 8 / bits_per_pixel, height + top,
554  bytes_per_pixel, bytes_per_line);
555  SetRectangle(left, top, width, height);
556 
557  return GetUTF8Text();
558 }
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
const int kMinRectSize
Definition: baseapi.cpp:104
void SetImage(const unsigned char *imagedata, int width, int height, int bytes_per_pixel, int bytes_per_line)
Definition: baseapi.cpp:580
void SetRectangle(int left, int top, int width, int height)
Definition: baseapi.cpp:624

◆ TextLength()

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 2169 of file baseapi.cpp.

2169  {
2170  if (tesseract_ == nullptr || page_res_ == nullptr)
2171  return 0;
2172 
2173  PAGE_RES_IT page_res_it(page_res_);
2174  int total_length = 2;
2175  int total_blobs = 0;
2176  // Iterate over the data structures to extract the recognition result.
2177  for (page_res_it.restart_page(); page_res_it.word () != nullptr;
2178  page_res_it.forward()) {
2179  WERD_RES *word = page_res_it.word();
2180  WERD_CHOICE* choice = word->best_choice;
2181  if (choice != nullptr) {
2182  total_blobs += choice->length() + 2;
2183  total_length += choice->unichar_string().length() + 2;
2184  for (int i = 0; i < word->reject_map.length(); ++i) {
2185  if (word->reject_map[i].rejected())
2186  ++total_length;
2187  }
2188  }
2189  }
2190  if (blob_count != nullptr)
2191  *blob_count = total_blobs;
2192  return total_length;
2193 }
int length() const
Definition: ratngs.h:293
REJMAP reject_map
Definition: pageres.h:294
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
int32_t length() const
Definition: strngs.cpp:189
int32_t length() const
Definition: rejctmap.h:223
const STRING & unichar_string() const
Definition: ratngs.h:531
PAGE_RES * page_res_
The page-level data.
Definition: baseapi.h:895
WERD * word
Definition: pageres.h:186
WERD_CHOICE * best_choice
Definition: pageres.h:241

◆ Threshold()

bool tesseract::TessBaseAPI::Threshold ( Pix **  pix)
protectedvirtual

Run the thresholder to make the thresholded image. If pix is not nullptr, the source is thresholded to pix instead of the internal IMAGE.

Run the thresholder to make the thresholded image, returned in pix, which must not be nullptr. *pix must be initialized to nullptr, or point to an existing pixDestroyable Pix. The usual argument to Threshold is Tesseract::mutable_pix_binary().

Definition at line 2014 of file baseapi.cpp.

2014  {
2015  ASSERT_HOST(pix != nullptr);
2016  if (*pix != nullptr)
2017  pixDestroy(pix);
2018  // Zero resolution messes up the algorithms, so make sure it is credible.
2019  int user_dpi = 0;
2020  GetIntVariable("user_defined_dpi", &user_dpi);
2021  int y_res = thresholder_->GetScaledYResolution();
2022  if (user_dpi && (user_dpi < kMinCredibleResolution ||
2023  user_dpi > kMaxCredibleResolution)) {
2024  tprintf("Warning: User defined image dpi is outside of expected range "
2025  "(%d - %d)!\n",
2027  }
2028  // Always use user defined dpi
2029  if (user_dpi) {
2031  } else if (y_res < kMinCredibleResolution ||
2032  y_res > kMaxCredibleResolution) {
2033  tprintf("Warning: Invalid resolution %d dpi. Using %d instead.\n",
2034  y_res, kMinCredibleResolution);
2036  }
2037  auto pageseg_mode =
2038  static_cast<PageSegMode>(
2039  static_cast<int>(tesseract_->tessedit_pageseg_mode));
2040  if (!thresholder_->ThresholdToPix(pageseg_mode, pix)) return false;
2044  if (!thresholder_->IsBinary()) {
2047  } else {
2048  tesseract_->set_pix_thresholds(nullptr);
2049  tesseract_->set_pix_grey(nullptr);
2050  }
2051  // Set the internal resolution that is used for layout parameters from the
2052  // estimated resolution, rather than the image resolution, which may be
2053  // fabricated, but we will use the image resolution, if there is one, to
2054  // report output point sizes.
2055  int estimated_res = ClipToRange(thresholder_->GetScaledEstimatedResolution(),
2058  if (estimated_res != thresholder_->GetScaledEstimatedResolution()) {
2059  tprintf("Estimated internal resolution %d out of range! "
2060  "Corrected to %d.\n",
2061  thresholder_->GetScaledEstimatedResolution(), estimated_res);
2062  }
2063  tesseract_->set_source_resolution(estimated_res);
2064  return true;
2065 }
virtual bool ThresholdToPix(PageSegMode pageseg_mode, Pix **pix)
Returns false on error.
DLLSYM void tprintf(const char *format,...)
Definition: tprintf.cpp:35
void set_source_resolution(int ppi)
constexpr int kMinCredibleResolution
Definition: publictypes.h:38
void SetSourceYResolution(int ppi)
Definition: thresholder.h:85
bool IsBinary() const
Returns true if the source image is binary.
Definition: thresholder.h:74
Tesseract * tesseract_
The underlying data object.
Definition: baseapi.h:888
T ClipToRange(const T &x, const T &lower_bound, const T &upper_bound)
Definition: helpers.h:108
ImageThresholder * thresholder_
Image thresholding module.
Definition: baseapi.h:892
int GetScaledEstimatedResolution() const
Definition: thresholder.h:105
bool GetIntVariable(const char *name, int *value) const
Definition: baseapi.cpp:298
virtual Pix * GetPixRectGrey()
int GetScaledYResolution() const
Definition: thresholder.h:92
virtual void GetImageSizes(int *left, int *top, int *width, int *height, int *imagewidth, int *imageheight)
virtual Pix * GetPixRectThresholds()
void set_pix_grey(Pix *grey_pix)
constexpr int kMaxCredibleResolution
Definition: publictypes.h:40
#define ASSERT_HOST(x)
Definition: errcode.h:88
void set_pix_thresholds(Pix *thresholds)

◆ Version()

const char * tesseract::TessBaseAPI::Version ( )
static

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

Definition at line 233 of file baseapi.cpp.

233  {
234  return PACKAGE_VERSION;
235 }

Member Data Documentation

◆ block_list_

BLOCK_LIST* tesseract::TessBaseAPI::block_list_
protected

The page layout.

Definition at line 894 of file baseapi.h.

◆ datapath_

STRING* tesseract::TessBaseAPI::datapath_
protected

Current location of tessdata.

Definition at line 898 of file baseapi.h.

◆ equ_detect_

EquationDetect* tesseract::TessBaseAPI::equ_detect_
protected

The equation detector.

Definition at line 890 of file baseapi.h.

◆ input_file_

STRING* tesseract::TessBaseAPI::input_file_
protected

Name used by training code.

Definition at line 896 of file baseapi.h.

◆ language_

STRING* tesseract::TessBaseAPI::language_
protected

Last initialized language.

Definition at line 899 of file baseapi.h.

◆ last_oem_requested_

OcrEngineMode tesseract::TessBaseAPI::last_oem_requested_
protected

Last ocr language mode requested.

Definition at line 900 of file baseapi.h.

◆ osd_tesseract_

Tesseract* tesseract::TessBaseAPI::osd_tesseract_
protected

For orientation & script detection.

Definition at line 889 of file baseapi.h.

◆ output_file_

STRING* tesseract::TessBaseAPI::output_file_
protected

Name used by debug code.

Definition at line 897 of file baseapi.h.

◆ page_res_

PAGE_RES* tesseract::TessBaseAPI::page_res_
protected

The page-level data.

Definition at line 895 of file baseapi.h.

◆ paragraph_models_

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

Definition at line 893 of file baseapi.h.

◆ reader_

FileReader tesseract::TessBaseAPI::reader_
protected

Reads files from any filesystem.

Definition at line 891 of file baseapi.h.

◆ recognition_done_

bool tesseract::TessBaseAPI::recognition_done_
protected

page_res_ contains recognition data.

Definition at line 901 of file baseapi.h.

◆ tesseract_

Tesseract* tesseract::TessBaseAPI::tesseract_
protected

The underlying data object.

Definition at line 888 of file baseapi.h.

◆ thresholder_

ImageThresholder* tesseract::TessBaseAPI::thresholder_
protected

Image thresholding module.

Definition at line 892 of file baseapi.h.

◆ truth_cb_

TruthCallback* tesseract::TessBaseAPI::truth_cb_
protected

Definition at line 902 of file baseapi.h.


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