tesseract  4.1.1
ETEXT_DESC Class Reference

#include <ocrclass.h>

Public Member Functions

 ETEXT_DESC ()
 character data More...
 
void set_deadline_msecs (int32_t deadline_msecs)
 
bool deadline_exceeded () const
 

Public Attributes

int16_t count {0}
 
int16_t progress {0}
 chars in this buffer(0) More...
 
int8_t more_to_come {0}
 percent complete increasing (0-100) More...
 
volatile int8_t ocr_alive {0}
 true if not last More...
 
int8_t err_code {0}
 ocr sets to 1, HP 0 More...
 
CANCEL_FUNC cancel {nullptr}
 for errcode use More...
 
PROGRESS_FUNC progress_callback
 returns true to cancel More...
 
PROGRESS_FUNC2 progress_callback2
 called whenever progress increases More...
 
void * cancel_this {nullptr}
 monitor-aware progress callback More...
 
struct timeval end_time
 this or other data for cancel More...
 
EANYCODE_CHAR text [1] {}
 

Detailed Description

Definition at line 102 of file ocrclass.h.

Constructor & Destructor Documentation

◆ ETEXT_DESC()

ETEXT_DESC::ETEXT_DESC ( )
inline

character data

Definition at line 122 of file ocrclass.h.

122  : progress_callback2(&default_progress_func) {
123  auto chrono_end_time = std::chrono::time_point<std::chrono::steady_clock,
124  std::chrono::milliseconds>();
125  timePointToTimeval(chrono_end_time, &end_time);
126  }
struct timeval end_time
this or other data for cancel
Definition: ocrclass.h:117
PROGRESS_FUNC2 progress_callback2
called whenever progress increases
Definition: ocrclass.h:115

Member Function Documentation

◆ deadline_exceeded()

bool ETEXT_DESC::deadline_exceeded ( ) const
inline

Definition at line 138 of file ocrclass.h.

138  {
139  if (end_time.tv_sec == 0 && end_time.tv_usec == 0)
140  return false;
141  auto chrono_now = std::chrono::steady_clock::now();
142  struct timeval now;
143  timePointToTimeval(chrono_now, &now);
144  return (now.tv_sec > end_time.tv_sec ||
145  (now.tv_sec == end_time.tv_sec && now.tv_usec > end_time.tv_usec));
146  }

◆ set_deadline_msecs()

void ETEXT_DESC::set_deadline_msecs ( int32_t  deadline_msecs)
inline

Definition at line 129 of file ocrclass.h.

129  {
130  if (deadline_msecs > 0) {
131  auto chrono_end_time = std::chrono::steady_clock::now() +
132  std::chrono::milliseconds(deadline_msecs);
133  timePointToTimeval(chrono_end_time, &end_time);
134  }
135  }

Member Data Documentation

◆ cancel

CANCEL_FUNC ETEXT_DESC::cancel {nullptr}

for errcode use

Definition at line 112 of file ocrclass.h.

◆ cancel_this

void* ETEXT_DESC::cancel_this {nullptr}

monitor-aware progress callback

Definition at line 116 of file ocrclass.h.

◆ count

int16_t ETEXT_DESC::count {0}

Definition at line 104 of file ocrclass.h.

◆ end_time

struct timeval ETEXT_DESC::end_time

this or other data for cancel

Definition at line 116 of file ocrclass.h.

◆ err_code

int8_t ETEXT_DESC::err_code {0}

ocr sets to 1, HP 0

Definition at line 111 of file ocrclass.h.

◆ more_to_come

int8_t ETEXT_DESC::more_to_come {0}

percent complete increasing (0-100)

Progress monitor covers word recognition and it does not cover layout analysis. See Ray comment in https://github.com/tesseract-ocr/tesseract/pull/27

Definition at line 109 of file ocrclass.h.

◆ ocr_alive

volatile int8_t ETEXT_DESC::ocr_alive {0}

true if not last

Definition at line 110 of file ocrclass.h.

◆ progress

int16_t ETEXT_DESC::progress {0}

chars in this buffer(0)

Definition at line 105 of file ocrclass.h.

◆ progress_callback

PROGRESS_FUNC ETEXT_DESC::progress_callback
Initial value:
{
nullptr}

returns true to cancel

Definition at line 113 of file ocrclass.h.

◆ progress_callback2

PROGRESS_FUNC2 ETEXT_DESC::progress_callback2

called whenever progress increases

Definition at line 115 of file ocrclass.h.

◆ text

EANYCODE_CHAR ETEXT_DESC::text[1] {}

Time to stop. Expected to be set only by call to set_deadline_msecs().

Definition at line 120 of file ocrclass.h.


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