tesseract  3.04.00
tesseract::LTRResultIterator Class Reference

#include <ltrresultiterator.h>

Inheritance diagram for tesseract::LTRResultIterator:
tesseract::PageIterator tesseract::ResultIterator tesseract::MutableIterator

Public Member Functions

 LTRResultIterator (PAGE_RES *page_res, Tesseract *tesseract, int scale, int scaled_yres, int rect_left, int rect_top, int rect_width, int rect_height)
 
virtual ~LTRResultIterator ()
 
char * GetUTF8Text (PageIteratorLevel level) const
 
void SetLineSeparator (const char *new_line)
 
void SetParagraphSeparator (const char *new_para)
 
float Confidence (PageIteratorLevel level) const
 
const char * WordFontAttributes (bool *is_bold, bool *is_italic, bool *is_underlined, bool *is_monospace, bool *is_serif, bool *is_smallcaps, int *pointsize, int *font_id) const
 
const char * WordRecognitionLanguage () const
 
StrongScriptDirection WordDirection () const
 
bool WordIsFromDictionary () const
 
bool WordIsNumeric () const
 
bool HasBlamerInfo () const
 
const void * GetParamsTrainingBundle () const
 
const char * GetBlamerDebug () const
 
const char * GetBlamerMisadaptionDebug () const
 
bool HasTruthString () const
 
bool EquivalentToTruth (const char *str) const
 
char * WordTruthUTF8Text () const
 
char * WordNormedUTF8Text () const
 
const char * WordLattice (int *lattice_size) const
 
bool SymbolIsSuperscript () const
 
bool SymbolIsSubscript () const
 
bool SymbolIsDropcap () const
 
- Public Member Functions inherited from tesseract::PageIterator
 PageIterator (PAGE_RES *page_res, Tesseract *tesseract, int scale, int scaled_yres, int rect_left, int rect_top, int rect_width, int rect_height)
 
virtual ~PageIterator ()
 
 PageIterator (const PageIterator &src)
 
const PageIteratoroperator= (const PageIterator &src)
 
bool PositionedAtSameWord (const PAGE_RES_IT *other) const
 
virtual void Begin ()
 
virtual void RestartParagraph ()
 
bool IsWithinFirstTextlineOfParagraph () const
 
virtual void RestartRow ()
 
virtual bool Next (PageIteratorLevel level)
 
virtual bool IsAtBeginningOf (PageIteratorLevel level) const
 
virtual bool IsAtFinalElement (PageIteratorLevel level, PageIteratorLevel element) const
 
int Cmp (const PageIterator &other) const
 
void SetBoundingBoxComponents (bool include_upper_dots, bool include_lower_dots)
 
bool BoundingBox (PageIteratorLevel level, int *left, int *top, int *right, int *bottom) const
 
bool BoundingBox (PageIteratorLevel level, const int padding, int *left, int *top, int *right, int *bottom) const
 
bool BoundingBoxInternal (PageIteratorLevel level, int *left, int *top, int *right, int *bottom) const
 
bool Empty (PageIteratorLevel level) const
 
PolyBlockType BlockType () const
 
Pta * BlockPolygon () const
 
Pix * GetBinaryImage (PageIteratorLevel level) const
 
Pix * GetImage (PageIteratorLevel level, int padding, Pix *original_img, int *left, int *top) const
 
bool Baseline (PageIteratorLevel level, int *x1, int *y1, int *x2, int *y2) const
 
void Orientation (tesseract::Orientation *orientation, tesseract::WritingDirection *writing_direction, tesseract::TextlineOrder *textline_order, float *deskew_angle) const
 
void ParagraphInfo (tesseract::ParagraphJustification *justification, bool *is_list_item, bool *is_crown, int *first_line_indent) const
 
bool SetWordBlamerBundle (BlamerBundle *blamer_bundle)
 

Protected Attributes

const char * line_separator_
 
const char * paragraph_separator_
 
- Protected Attributes inherited from tesseract::PageIterator
PAGE_RESpage_res_
 
Tesseracttesseract_
 
PAGE_RES_ITit_
 
WERDword_
 
int word_length_
 
int blob_index_
 
C_BLOB_IT * cblob_it_
 
bool include_upper_dots_
 
bool include_lower_dots_
 
int scale_
 
int scaled_yres_
 
int rect_left_
 
int rect_top_
 
int rect_width_
 
int rect_height_
 

Friends

class ChoiceIterator
 

Additional Inherited Members

- Protected Member Functions inherited from tesseract::PageIterator
TESS_LOCAL void BeginWord (int offset)
 

Detailed Description

Definition at line 46 of file ltrresultiterator.h.

Constructor & Destructor Documentation

tesseract::LTRResultIterator::LTRResultIterator ( PAGE_RES page_res,
Tesseract tesseract,
int  scale,
int  scaled_yres,
int  rect_left,
int  rect_top,
int  rect_width,
int  rect_height 
)

Definition at line 30 of file ltrresultiterator.cpp.

34  : PageIterator(page_res, tesseract, scale, scaled_yres,
35  rect_left, rect_top, rect_width, rect_height),
36  line_separator_("\n"),
37  paragraph_separator_("\n") {
38 }
PageIterator(PAGE_RES *page_res, Tesseract *tesseract, int scale, int scaled_yres, int rect_left, int rect_top, int rect_width, int rect_height)
tesseract::LTRResultIterator::~LTRResultIterator ( )
virtual

Definition at line 40 of file ltrresultiterator.cpp.

40  {
41 }

Member Function Documentation

float tesseract::LTRResultIterator::Confidence ( PageIteratorLevel  level) const

Definition at line 94 of file ltrresultiterator.cpp.

94  {
95  if (it_->word() == NULL) return 0.0f; // Already at the end!
96  float mean_certainty = 0.0f;
97  int certainty_count = 0;
98  PAGE_RES_IT res_it(*it_);
99  WERD_CHOICE* best_choice = res_it.word()->best_choice;
100  ASSERT_HOST(best_choice != NULL);
101  switch (level) {
102  case RIL_BLOCK:
103  do {
104  best_choice = res_it.word()->best_choice;
105  ASSERT_HOST(best_choice != NULL);
106  mean_certainty += best_choice->certainty();
107  ++certainty_count;
108  res_it.forward();
109  } while (res_it.block() == res_it.prev_block());
110  break;
111  case RIL_PARA:
112  do {
113  best_choice = res_it.word()->best_choice;
114  ASSERT_HOST(best_choice != NULL);
115  mean_certainty += best_choice->certainty();
116  ++certainty_count;
117  res_it.forward();
118  } while (res_it.block() == res_it.prev_block() &&
119  res_it.row()->row->para() == res_it.prev_row()->row->para());
120  break;
121  case RIL_TEXTLINE:
122  do {
123  best_choice = res_it.word()->best_choice;
124  ASSERT_HOST(best_choice != NULL);
125  mean_certainty += best_choice->certainty();
126  ++certainty_count;
127  res_it.forward();
128  } while (res_it.row() == res_it.prev_row());
129  break;
130  case RIL_WORD:
131  mean_certainty += best_choice->certainty();
132  ++certainty_count;
133  break;
134  case RIL_SYMBOL:
135  mean_certainty += best_choice->certainty(blob_index_);
136  ++certainty_count;
137  }
138  if (certainty_count > 0) {
139  mean_certainty /= certainty_count;
140  float confidence = 100 + 5 * mean_certainty;
141  if (confidence < 0.0f) confidence = 0.0f;
142  if (confidence > 100.0f) confidence = 100.0f;
143  return confidence;
144  }
145  return 0.0f;
146 }
#define NULL
Definition: host.h:144
float certainty() const
Definition: ratngs.h:327
WERD_RES * word() const
Definition: pageres.h:733
#define ASSERT_HOST(x)
Definition: errcode.h:84
bool tesseract::LTRResultIterator::EquivalentToTruth ( const char *  str) const

Definition at line 259 of file ltrresultiterator.cpp.

259  {
260  if (!HasTruthString()) return false;
261  ASSERT_HOST(it_->word()->uch_set != NULL);
262  WERD_CHOICE str_wd(str, *(it_->word()->uch_set));
263  return it_->word()->blamer_bundle->ChoiceIsCorrect(&str_wd);
264 }
bool ChoiceIsCorrect(const WERD_CHOICE *word_choice) const
Definition: blamer.cpp:111
BlamerBundle * blamer_bundle
Definition: pageres.h:230
#define NULL
Definition: host.h:144
const UNICHARSET * uch_set
Definition: pageres.h:192
WERD_RES * word() const
Definition: pageres.h:733
#define ASSERT_HOST(x)
Definition: errcode.h:84
const char * tesseract::LTRResultIterator::GetBlamerDebug ( ) const

Definition at line 237 of file ltrresultiterator.cpp.

237  {
238  return it_->word()->blamer_bundle->debug().string();
239 }
BlamerBundle * blamer_bundle
Definition: pageres.h:230
WERD_RES * word() const
Definition: pageres.h:733
const char * string() const
Definition: strngs.cpp:193
const STRING & debug() const
Definition: blamer.h:116
const char * tesseract::LTRResultIterator::GetBlamerMisadaptionDebug ( ) const

Definition at line 243 of file ltrresultiterator.cpp.

243  {
245 }
BlamerBundle * blamer_bundle
Definition: pageres.h:230
const STRING & misadaption_debug() const
Definition: blamer.h:119
WERD_RES * word() const
Definition: pageres.h:733
const char * string() const
Definition: strngs.cpp:193
const void * tesseract::LTRResultIterator::GetParamsTrainingBundle ( ) const

Definition at line 230 of file ltrresultiterator.cpp.

230  {
231  return (it_->word() != NULL && it_->word()->blamer_bundle != NULL) ?
233 }
BlamerBundle * blamer_bundle
Definition: pageres.h:230
#define NULL
Definition: host.h:144
WERD_RES * word() const
Definition: pageres.h:733
const tesseract::ParamsTrainingBundle & params_training_bundle() const
Definition: blamer.h:150
char * tesseract::LTRResultIterator::GetUTF8Text ( PageIteratorLevel  level) const

Definition at line 45 of file ltrresultiterator.cpp.

45  {
46  if (it_->word() == NULL) return NULL; // Already at the end!
47  STRING text;
48  PAGE_RES_IT res_it(*it_);
49  WERD_CHOICE* best_choice = res_it.word()->best_choice;
50  ASSERT_HOST(best_choice != NULL);
51  if (level == RIL_SYMBOL) {
52  text = res_it.word()->BestUTF8(blob_index_, false);
53  } else if (level == RIL_WORD) {
54  text = best_choice->unichar_string();
55  } else {
56  bool eol = false; // end of line?
57  bool eop = false; // end of paragraph?
58  do { // for each paragraph in a block
59  do { // for each text line in a paragraph
60  do { // for each word in a text line
61  best_choice = res_it.word()->best_choice;
62  ASSERT_HOST(best_choice != NULL);
63  text += best_choice->unichar_string();
64  text += " ";
65  res_it.forward();
66  eol = res_it.row() != res_it.prev_row();
67  } while (!eol);
68  text.truncate_at(text.length() - 1);
69  text += line_separator_;
70  eop = res_it.block() != res_it.prev_block() ||
71  res_it.row()->row->para() != res_it.prev_row()->row->para();
72  } while (level != RIL_TEXTLINE && !eop);
73  if (eop) text += paragraph_separator_;
74  } while (level == RIL_BLOCK && res_it.block() == res_it.prev_block());
75  }
76  int length = text.length() + 1;
77  char* result = new char[length];
78  strncpy(result, text.string(), length);
79  return result;
80 }
inT32 length() const
Definition: strngs.cpp:188
#define NULL
Definition: host.h:144
WERD_RES * word() const
Definition: pageres.h:733
const char * string() const
Definition: strngs.cpp:193
const STRING & unichar_string() const
Definition: ratngs.h:524
Definition: strngs.h:44
void truncate_at(inT32 index)
Definition: strngs.cpp:264
#define ASSERT_HOST(x)
Definition: errcode.h:84
bool tesseract::LTRResultIterator::HasBlamerInfo ( ) const

Definition at line 223 of file ltrresultiterator.cpp.

223  {
224  return it_->word() != NULL && it_->word()->blamer_bundle != NULL &&
226 }
BlamerBundle * blamer_bundle
Definition: pageres.h:230
#define NULL
Definition: host.h:144
bool HasDebugInfo() const
Definition: blamer.h:113
WERD_RES * word() const
Definition: pageres.h:733
bool tesseract::LTRResultIterator::HasTruthString ( ) const

Definition at line 248 of file ltrresultiterator.cpp.

248  {
249  if (it_->word() == NULL) return false; // Already at the end!
250  if (it_->word()->blamer_bundle == NULL ||
251  it_->word()->blamer_bundle->NoTruth()) {
252  return false; // no truth information for this word
253  }
254  return true;
255 }
BlamerBundle * blamer_bundle
Definition: pageres.h:230
#define NULL
Definition: host.h:144
bool NoTruth() const
Definition: blamer.h:109
WERD_RES * word() const
Definition: pageres.h:733
void tesseract::LTRResultIterator::SetLineSeparator ( const char *  new_line)

Definition at line 83 of file ltrresultiterator.cpp.

83  {
85 }
#define new_line()
Definition: cutil.h:83
void tesseract::LTRResultIterator::SetParagraphSeparator ( const char *  new_para)

Definition at line 88 of file ltrresultiterator.cpp.

88  {
89  paragraph_separator_ = new_para;
90 }
bool tesseract::LTRResultIterator::SymbolIsDropcap ( ) const

Definition at line 325 of file ltrresultiterator.cpp.

325  {
326  if (cblob_it_ == NULL && it_->word() != NULL)
328  return false;
329 }
tesseract::ScriptPos BlobPosition(int index) const
Definition: ratngs.h:319
#define NULL
Definition: host.h:144
WERD_RES * word() const
Definition: pageres.h:733
WERD_CHOICE * best_choice
Definition: pageres.h:219
bool tesseract::LTRResultIterator::SymbolIsSubscript ( ) const

Definition at line 316 of file ltrresultiterator.cpp.

316  {
317  if (cblob_it_ == NULL && it_->word() != NULL)
319  return false;
320 }
tesseract::ScriptPos BlobPosition(int index) const
Definition: ratngs.h:319
#define NULL
Definition: host.h:144
WERD_RES * word() const
Definition: pageres.h:733
WERD_CHOICE * best_choice
Definition: pageres.h:219
bool tesseract::LTRResultIterator::SymbolIsSuperscript ( ) const

Definition at line 306 of file ltrresultiterator.cpp.

306  {
307  if (cblob_it_ == NULL && it_->word() != NULL)
310  return false;
311 }
tesseract::ScriptPos BlobPosition(int index) const
Definition: ratngs.h:319
#define NULL
Definition: host.h:144
WERD_RES * word() const
Definition: pageres.h:733
WERD_CHOICE * best_choice
Definition: pageres.h:219
StrongScriptDirection tesseract::LTRResultIterator::WordDirection ( ) const

Definition at line 194 of file ltrresultiterator.cpp.

194  {
195  if (it_->word() == NULL) return DIR_NEUTRAL;
196  bool has_rtl = it_->word()->AnyRtlCharsInWord();
197  bool has_ltr = it_->word()->AnyLtrCharsInWord();
198  if (has_rtl && !has_ltr)
199  return DIR_RIGHT_TO_LEFT;
200  if (has_ltr && !has_rtl)
201  return DIR_LEFT_TO_RIGHT;
202  if (!has_ltr && !has_rtl)
203  return DIR_NEUTRAL;
204  return DIR_MIX;
205 }
#define NULL
Definition: host.h:144
bool AnyRtlCharsInWord() const
Definition: pageres.h:372
WERD_RES * word() const
Definition: pageres.h:733
bool AnyLtrCharsInWord() const
Definition: pageres.h:389
const char * tesseract::LTRResultIterator::WordFontAttributes ( bool *  is_bold,
bool *  is_italic,
bool *  is_underlined,
bool *  is_monospace,
bool *  is_serif,
bool *  is_smallcaps,
int *  pointsize,
int *  font_id 
) const

Definition at line 156 of file ltrresultiterator.cpp.

163  {
164  if (it_->word() == NULL) return NULL; // Already at the end!
165  if (it_->word()->fontinfo == NULL) {
166  *font_id = -1;
167  return NULL; // No font information.
168  }
169  const FontInfo& font_info = *it_->word()->fontinfo;
170  *font_id = font_info.universal_id;
171  *is_bold = font_info.is_bold();
172  *is_italic = font_info.is_italic();
173  *is_underlined = false; // TODO(rays) fix this!
174  *is_monospace = font_info.is_fixed_pitch();
175  *is_serif = font_info.is_serif();
176  *is_smallcaps = it_->word()->small_caps;
177  float row_height = it_->row()->row->x_height() +
178  it_->row()->row->ascenders() - it_->row()->row->descenders();
179  // Convert from pixels to printers points.
180  *pointsize = scaled_yres_ > 0
181  ? static_cast<int>(row_height * kPointsPerInch / scaled_yres_ + 0.5)
182  : 0;
183 
184  return font_info.name;
185 }
bool is_italic() const
Definition: fontinfo.h:111
const int kPointsPerInch
Definition: publictypes.h:33
bool is_bold() const
Definition: fontinfo.h:112
#define NULL
Definition: host.h:144
ROW * row
Definition: pageres.h:127
ROW_RES * row() const
Definition: pageres.h:736
const FontInfo * fontinfo
Definition: pageres.h:288
float ascenders() const
Definition: ocrrow.h:79
WERD_RES * word() const
Definition: pageres.h:733
bool is_fixed_pitch() const
Definition: fontinfo.h:113
float x_height() const
Definition: ocrrow.h:61
float descenders() const
Definition: ocrrow.h:82
bool small_caps
Definition: pageres.h:283
bool is_serif() const
Definition: fontinfo.h:114
bool tesseract::LTRResultIterator::WordIsFromDictionary ( ) const

Definition at line 208 of file ltrresultiterator.cpp.

208  {
209  if (it_->word() == NULL) return false; // Already at the end!
210  int permuter = it_->word()->best_choice->permuter();
211  return permuter == SYSTEM_DAWG_PERM || permuter == FREQ_DAWG_PERM ||
212  permuter == USER_DAWG_PERM;
213 }
#define NULL
Definition: host.h:144
WERD_RES * word() const
Definition: pageres.h:733
uinT8 permuter() const
Definition: ratngs.h:343
WERD_CHOICE * best_choice
Definition: pageres.h:219
bool tesseract::LTRResultIterator::WordIsNumeric ( ) const

Definition at line 216 of file ltrresultiterator.cpp.

216  {
217  if (it_->word() == NULL) return false; // Already at the end!
218  int permuter = it_->word()->best_choice->permuter();
219  return permuter == NUMBER_PERM;
220 }
#define NULL
Definition: host.h:144
WERD_RES * word() const
Definition: pageres.h:733
uinT8 permuter() const
Definition: ratngs.h:343
WERD_CHOICE * best_choice
Definition: pageres.h:219
const char * tesseract::LTRResultIterator::WordLattice ( int *  lattice_size) const

Definition at line 296 of file ltrresultiterator.cpp.

296  {
297  if (it_->word() == NULL) return NULL; // Already at the end!
298  if (it_->word()->blamer_bundle == NULL) return NULL;
299  *lattice_size = it_->word()->blamer_bundle->lattice_size();
300  return it_->word()->blamer_bundle->lattice_data();
301 }
BlamerBundle * blamer_bundle
Definition: pageres.h:230
int lattice_size() const
Definition: blamer.h:141
#define NULL
Definition: host.h:144
WERD_RES * word() const
Definition: pageres.h:733
const char * lattice_data() const
Definition: blamer.h:138
char * tesseract::LTRResultIterator::WordNormedUTF8Text ( ) const

Definition at line 279 of file ltrresultiterator.cpp.

279  {
280  if (it_->word() == NULL) return NULL; // Already at the end!
281  STRING ocr_text;
282  WERD_CHOICE* best_choice = it_->word()->best_choice;
283  const UNICHARSET *unicharset = it_->word()->uch_set;
284  ASSERT_HOST(best_choice != NULL);
285  for (int i = 0; i < best_choice->length(); ++i) {
286  ocr_text += unicharset->get_normed_unichar(best_choice->unichar_id(i));
287  }
288  int length = ocr_text.length() + 1;
289  char* result = new char[length];
290  strncpy(result, ocr_text.string(), length);
291  return result;
292 }
inT32 length() const
Definition: strngs.cpp:188
#define NULL
Definition: host.h:144
const UNICHARSET * uch_set
Definition: pageres.h:192
const UNICHAR_ID unichar_id(int index) const
Definition: ratngs.h:312
WERD_RES * word() const
Definition: pageres.h:733
const char * string() const
Definition: strngs.cpp:193
const char * get_normed_unichar(UNICHAR_ID unichar_id) const
Definition: unicharset.h:776
Definition: strngs.h:44
int length() const
Definition: ratngs.h:300
WERD_CHOICE * best_choice
Definition: pageres.h:219
#define ASSERT_HOST(x)
Definition: errcode.h:84
const char * tesseract::LTRResultIterator::WordRecognitionLanguage ( ) const

Definition at line 188 of file ltrresultiterator.cpp.

188  {
189  if (it_->word() == NULL || it_->word()->tesseract == NULL) return NULL;
190  return it_->word()->tesseract->lang.string();
191 }
STRING lang
Definition: ccutil.h:69
#define NULL
Definition: host.h:144
tesseract::Tesseract * tesseract
Definition: pageres.h:266
WERD_RES * word() const
Definition: pageres.h:733
const char * string() const
Definition: strngs.cpp:193
char * tesseract::LTRResultIterator::WordTruthUTF8Text ( ) const

Definition at line 268 of file ltrresultiterator.cpp.

268  {
269  if (!HasTruthString()) return NULL;
270  STRING truth_text = it_->word()->blamer_bundle->TruthString();
271  int length = truth_text.length() + 1;
272  char* result = new char[length];
273  strncpy(result, truth_text.string(), length);
274  return result;
275 }
BlamerBundle * blamer_bundle
Definition: pageres.h:230
inT32 length() const
Definition: strngs.cpp:188
#define NULL
Definition: host.h:144
WERD_RES * word() const
Definition: pageres.h:733
const char * string() const
Definition: strngs.cpp:193
Definition: strngs.h:44
STRING TruthString() const
Definition: blamer.h:100

Friends And Related Function Documentation

friend class ChoiceIterator
friend

Definition at line 47 of file ltrresultiterator.h.

Member Data Documentation

const char* tesseract::LTRResultIterator::line_separator_
protected

Definition at line 176 of file ltrresultiterator.h.

const char* tesseract::LTRResultIterator::paragraph_separator_
protected

Definition at line 177 of file ltrresultiterator.h.


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