tesseract  5.0.0
capi.h File Reference
#include "export.h"
#include <stdbool.h>
#include <stdio.h>

Go to the source code of this file.

Macros

#define BOOL   int
 
#define TRUE   1
 
#define FALSE   0
 

Typedefs

typedef struct TessResultRenderer TessResultRenderer
 
typedef struct TessBaseAPI TessBaseAPI
 
typedef struct TessPageIterator TessPageIterator
 
typedef struct TessResultIterator TessResultIterator
 
typedef struct TessMutableIterator TessMutableIterator
 
typedef struct TessChoiceIterator TessChoiceIterator
 
typedef enum TessOcrEngineMode TessOcrEngineMode
 
typedef enum TessPageSegMode TessPageSegMode
 
typedef enum TessPageIteratorLevel TessPageIteratorLevel
 
typedef enum TessPolyBlockType TessPolyBlockType
 
typedef enum TessOrientation TessOrientation
 
typedef enum TessParagraphJustification TessParagraphJustification
 
typedef enum TessWritingDirection TessWritingDirection
 
typedef enum TessTextlineOrder TessTextlineOrder
 
typedef struct ETEXT_DESC ETEXT_DESC
 
typedef bool(* TessCancelFunc) (void *cancel_this, int words)
 
typedef bool(* TessProgressFunc) (ETEXT_DESC *ths, int left, int right, int top, int bottom)
 

Enumerations

enum  TessOcrEngineMode { OEM_TESSERACT_ONLY , OEM_LSTM_ONLY , OEM_TESSERACT_LSTM_COMBINED , OEM_DEFAULT }
 
enum  TessPageSegMode {
  PSM_OSD_ONLY , PSM_AUTO_OSD , PSM_AUTO_ONLY , PSM_AUTO ,
  PSM_SINGLE_COLUMN , PSM_SINGLE_BLOCK_VERT_TEXT , PSM_SINGLE_BLOCK , PSM_SINGLE_LINE ,
  PSM_SINGLE_WORD , PSM_CIRCLE_WORD , PSM_SINGLE_CHAR , PSM_SPARSE_TEXT ,
  PSM_SPARSE_TEXT_OSD , PSM_RAW_LINE , PSM_COUNT
}
 
enum  TessPageIteratorLevel {
  RIL_BLOCK , RIL_PARA , RIL_TEXTLINE , RIL_WORD ,
  RIL_SYMBOL
}
 
enum  TessPolyBlockType {
  PT_UNKNOWN , PT_FLOWING_TEXT , PT_HEADING_TEXT , PT_PULLOUT_TEXT ,
  PT_EQUATION , PT_INLINE_EQUATION , PT_TABLE , PT_VERTICAL_TEXT ,
  PT_CAPTION_TEXT , PT_FLOWING_IMAGE , PT_HEADING_IMAGE , PT_PULLOUT_IMAGE ,
  PT_HORZ_LINE , PT_VERT_LINE , PT_NOISE , PT_COUNT
}
 
enum  TessOrientation { ORIENTATION_PAGE_UP , ORIENTATION_PAGE_RIGHT , ORIENTATION_PAGE_DOWN , ORIENTATION_PAGE_LEFT }
 
enum  TessParagraphJustification { JUSTIFICATION_UNKNOWN , JUSTIFICATION_LEFT , JUSTIFICATION_CENTER , JUSTIFICATION_RIGHT }
 
enum  TessWritingDirection { WRITING_DIRECTION_LEFT_TO_RIGHT , WRITING_DIRECTION_RIGHT_TO_LEFT , WRITING_DIRECTION_TOP_TO_BOTTOM }
 
enum  TessTextlineOrder { TEXTLINE_ORDER_LEFT_TO_RIGHT , TEXTLINE_ORDER_RIGHT_TO_LEFT , TEXTLINE_ORDER_TOP_TO_BOTTOM }
 

Functions

TESS_API const char * TessVersion ()
 
TESS_API void TessDeleteText (const char *text)
 
TESS_API void TessDeleteTextArray (char **arr)
 
TESS_API void TessDeleteIntArray (const int *arr)
 
TESS_API TessResultRendererTessTextRendererCreate (const char *outputbase)
 
TESS_API TessResultRendererTessHOcrRendererCreate (const char *outputbase)
 
TESS_API TessResultRendererTessHOcrRendererCreate2 (const char *outputbase, BOOL font_info)
 
TESS_API TessResultRendererTessAltoRendererCreate (const char *outputbase)
 
TESS_API TessResultRendererTessTsvRendererCreate (const char *outputbase)
 
TESS_API TessResultRendererTessPDFRendererCreate (const char *outputbase, const char *datadir, BOOL textonly)
 
TESS_API TessResultRendererTessUnlvRendererCreate (const char *outputbase)
 
TESS_API TessResultRendererTessBoxTextRendererCreate (const char *outputbase)
 
TESS_API TessResultRendererTessLSTMBoxRendererCreate (const char *outputbase)
 
TESS_API TessResultRendererTessWordStrBoxRendererCreate (const char *outputbase)
 
TESS_API void TessDeleteResultRenderer (TessResultRenderer *renderer)
 
TESS_API void TessResultRendererInsert (TessResultRenderer *renderer, TessResultRenderer *next)
 
TESS_API TessResultRendererTessResultRendererNext (TessResultRenderer *renderer)
 
TESS_API BOOL TessResultRendererBeginDocument (TessResultRenderer *renderer, const char *title)
 
TESS_API BOOL TessResultRendererAddImage (TessResultRenderer *renderer, TessBaseAPI *api)
 
TESS_API BOOL TessResultRendererEndDocument (TessResultRenderer *renderer)
 
TESS_API const char * TessResultRendererExtention (TessResultRenderer *renderer)
 
TESS_API const char * TessResultRendererTitle (TessResultRenderer *renderer)
 
TESS_API int TessResultRendererImageNum (TessResultRenderer *renderer)
 
TESS_API TessBaseAPITessBaseAPICreate ()
 
TESS_API void TessBaseAPIDelete (TessBaseAPI *handle)
 
TESS_API size_t TessBaseAPIGetOpenCLDevice (TessBaseAPI *handle, void **device)
 
TESS_API void TessBaseAPISetInputName (TessBaseAPI *handle, const char *name)
 
TESS_API const char * TessBaseAPIGetInputName (TessBaseAPI *handle)
 
TESS_API void TessBaseAPISetInputImage (TessBaseAPI *handle, struct Pix *pix)
 
TESS_API struct Pix * TessBaseAPIGetInputImage (TessBaseAPI *handle)
 
TESS_API int TessBaseAPIGetSourceYResolution (TessBaseAPI *handle)
 
TESS_API const char * TessBaseAPIGetDatapath (TessBaseAPI *handle)
 
TESS_API void TessBaseAPISetOutputName (TessBaseAPI *handle, const char *name)
 
TESS_API BOOL TessBaseAPISetVariable (TessBaseAPI *handle, const char *name, const char *value)
 
TESS_API BOOL TessBaseAPISetDebugVariable (TessBaseAPI *handle, const char *name, const char *value)
 
TESS_API BOOL TessBaseAPIGetIntVariable (const TessBaseAPI *handle, const char *name, int *value)
 
TESS_API BOOL TessBaseAPIGetBoolVariable (const TessBaseAPI *handle, const char *name, BOOL *value)
 
TESS_API BOOL TessBaseAPIGetDoubleVariable (const TessBaseAPI *handle, const char *name, double *value)
 
TESS_API const char * TessBaseAPIGetStringVariable (const TessBaseAPI *handle, const char *name)
 
TESS_API void TessBaseAPIPrintVariables (const TessBaseAPI *handle, FILE *fp)
 
TESS_API BOOL TessBaseAPIPrintVariablesToFile (const TessBaseAPI *handle, const char *filename)
 
TESS_API int TessBaseAPIInit1 (TessBaseAPI *handle, const char *datapath, const char *language, TessOcrEngineMode oem, char **configs, int configs_size)
 
TESS_API int TessBaseAPIInit2 (TessBaseAPI *handle, const char *datapath, const char *language, TessOcrEngineMode oem)
 
TESS_API int TessBaseAPIInit3 (TessBaseAPI *handle, const char *datapath, const char *language)
 
TESS_API int TessBaseAPIInit4 (TessBaseAPI *handle, const char *datapath, const char *language, TessOcrEngineMode mode, char **configs, int configs_size, char **vars_vec, char **vars_values, size_t vars_vec_size, BOOL set_only_non_debug_params)
 
TESS_API const char * TessBaseAPIGetInitLanguagesAsString (const TessBaseAPI *handle)
 
TESS_API char ** TessBaseAPIGetLoadedLanguagesAsVector (const TessBaseAPI *handle)
 
TESS_API char ** TessBaseAPIGetAvailableLanguagesAsVector (const TessBaseAPI *handle)
 
TESS_API void TessBaseAPIInitForAnalysePage (TessBaseAPI *handle)
 
TESS_API void TessBaseAPIReadConfigFile (TessBaseAPI *handle, const char *filename)
 
TESS_API void TessBaseAPIReadDebugConfigFile (TessBaseAPI *handle, const char *filename)
 
TESS_API void TessBaseAPISetPageSegMode (TessBaseAPI *handle, TessPageSegMode mode)
 
TESS_API TessPageSegMode TessBaseAPIGetPageSegMode (const TessBaseAPI *handle)
 
TESS_API char * TessBaseAPIRect (TessBaseAPI *handle, const unsigned char *imagedata, int bytes_per_pixel, int bytes_per_line, int left, int top, int width, int height)
 
TESS_API void TessBaseAPIClearAdaptiveClassifier (TessBaseAPI *handle)
 
TESS_API void TessBaseAPISetImage (TessBaseAPI *handle, const unsigned char *imagedata, int width, int height, int bytes_per_pixel, int bytes_per_line)
 
TESS_API void TessBaseAPISetImage2 (TessBaseAPI *handle, struct Pix *pix)
 
TESS_API void TessBaseAPISetSourceResolution (TessBaseAPI *handle, int ppi)
 
TESS_API void TessBaseAPISetRectangle (TessBaseAPI *handle, int left, int top, int width, int height)
 
TESS_API struct Pix * TessBaseAPIGetThresholdedImage (TessBaseAPI *handle)
 
TESS_API struct Boxa * TessBaseAPIGetRegions (TessBaseAPI *handle, struct Pixa **pixa)
 
TESS_API struct Boxa * TessBaseAPIGetTextlines (TessBaseAPI *handle, struct Pixa **pixa, int **blockids)
 
TESS_API struct Boxa * TessBaseAPIGetTextlines1 (TessBaseAPI *handle, BOOL raw_image, int raw_padding, struct Pixa **pixa, int **blockids, int **paraids)
 
TESS_API struct Boxa * TessBaseAPIGetStrips (TessBaseAPI *handle, struct Pixa **pixa, int **blockids)
 
TESS_API struct Boxa * TessBaseAPIGetWords (TessBaseAPI *handle, struct Pixa **pixa)
 
TESS_API struct Boxa * TessBaseAPIGetConnectedComponents (TessBaseAPI *handle, struct Pixa **cc)
 
TESS_API struct Boxa * TessBaseAPIGetComponentImages (TessBaseAPI *handle, TessPageIteratorLevel level, BOOL text_only, struct Pixa **pixa, int **blockids)
 
TESS_API struct Boxa * TessBaseAPIGetComponentImages1 (TessBaseAPI *handle, TessPageIteratorLevel level, BOOL text_only, BOOL raw_image, int raw_padding, struct Pixa **pixa, int **blockids, int **paraids)
 
TESS_API int TessBaseAPIGetThresholdedImageScaleFactor (const TessBaseAPI *handle)
 
TESS_API TessPageIteratorTessBaseAPIAnalyseLayout (TessBaseAPI *handle)
 
TESS_API int TessBaseAPIRecognize (TessBaseAPI *handle, ETEXT_DESC *monitor)
 
TESS_API BOOL TessBaseAPIProcessPages (TessBaseAPI *handle, const char *filename, const char *retry_config, int timeout_millisec, TessResultRenderer *renderer)
 
TESS_API BOOL TessBaseAPIProcessPage (TessBaseAPI *handle, struct Pix *pix, int page_index, const char *filename, const char *retry_config, int timeout_millisec, TessResultRenderer *renderer)
 
TESS_API TessResultIteratorTessBaseAPIGetIterator (TessBaseAPI *handle)
 
TESS_API TessMutableIteratorTessBaseAPIGetMutableIterator (TessBaseAPI *handle)
 
TESS_API char * TessBaseAPIGetUTF8Text (TessBaseAPI *handle)
 
TESS_API char * TessBaseAPIGetHOCRText (TessBaseAPI *handle, int page_number)
 
TESS_API char * TessBaseAPIGetAltoText (TessBaseAPI *handle, int page_number)
 
TESS_API char * TessBaseAPIGetTsvText (TessBaseAPI *handle, int page_number)
 
TESS_API char * TessBaseAPIGetBoxText (TessBaseAPI *handle, int page_number)
 
TESS_API char * TessBaseAPIGetLSTMBoxText (TessBaseAPI *handle, int page_number)
 
TESS_API char * TessBaseAPIGetWordStrBoxText (TessBaseAPI *handle, int page_number)
 
TESS_API char * TessBaseAPIGetUNLVText (TessBaseAPI *handle)
 
TESS_API int TessBaseAPIMeanTextConf (TessBaseAPI *handle)
 
TESS_API int * TessBaseAPIAllWordConfidences (TessBaseAPI *handle)
 
TESS_API BOOL TessBaseAPIAdaptToWordStr (TessBaseAPI *handle, TessPageSegMode mode, const char *wordstr)
 
TESS_API void TessBaseAPIClear (TessBaseAPI *handle)
 
TESS_API void TessBaseAPIEnd (TessBaseAPI *handle)
 
TESS_API int TessBaseAPIIsValidWord (TessBaseAPI *handle, const char *word)
 
TESS_API BOOL TessBaseAPIGetTextDirection (TessBaseAPI *handle, int *out_offset, float *out_slope)
 
TESS_API const char * TessBaseAPIGetUnichar (TessBaseAPI *handle, int unichar_id)
 
TESS_API void TessBaseAPIClearPersistentCache (TessBaseAPI *handle)
 
TESS_API BOOL TessBaseAPIDetectOrientationScript (TessBaseAPI *handle, int *orient_deg, float *orient_conf, const char **script_name, float *script_conf)
 
TESS_API void TessBaseAPISetMinOrientationMargin (TessBaseAPI *handle, double margin)
 
TESS_API int TessBaseAPINumDawgs (const TessBaseAPI *handle)
 
TESS_API TessOcrEngineMode TessBaseAPIOem (const TessBaseAPI *handle)
 
TESS_API void TessBaseGetBlockTextOrientations (TessBaseAPI *handle, int **block_orientation, bool **vertical_writing)
 
TESS_API void TessPageIteratorDelete (TessPageIterator *handle)
 
TESS_API TessPageIteratorTessPageIteratorCopy (const TessPageIterator *handle)
 
TESS_API void TessPageIteratorBegin (TessPageIterator *handle)
 
TESS_API BOOL TessPageIteratorNext (TessPageIterator *handle, TessPageIteratorLevel level)
 
TESS_API BOOL TessPageIteratorIsAtBeginningOf (const TessPageIterator *handle, TessPageIteratorLevel level)
 
TESS_API BOOL TessPageIteratorIsAtFinalElement (const TessPageIterator *handle, TessPageIteratorLevel level, TessPageIteratorLevel element)
 
TESS_API BOOL TessPageIteratorBoundingBox (const TessPageIterator *handle, TessPageIteratorLevel level, int *left, int *top, int *right, int *bottom)
 
TESS_API TessPolyBlockType TessPageIteratorBlockType (const TessPageIterator *handle)
 
TESS_API struct Pix * TessPageIteratorGetBinaryImage (const TessPageIterator *handle, TessPageIteratorLevel level)
 
TESS_API struct Pix * TessPageIteratorGetImage (const TessPageIterator *handle, TessPageIteratorLevel level, int padding, struct Pix *original_image, int *left, int *top)
 
TESS_API BOOL TessPageIteratorBaseline (const TessPageIterator *handle, TessPageIteratorLevel level, int *x1, int *y1, int *x2, int *y2)
 
TESS_API void TessPageIteratorOrientation (TessPageIterator *handle, TessOrientation *orientation, TessWritingDirection *writing_direction, TessTextlineOrder *textline_order, float *deskew_angle)
 
TESS_API void TessPageIteratorParagraphInfo (TessPageIterator *handle, TessParagraphJustification *justification, BOOL *is_list_item, BOOL *is_crown, int *first_line_indent)
 
TESS_API void TessResultIteratorDelete (TessResultIterator *handle)
 
TESS_API TessResultIteratorTessResultIteratorCopy (const TessResultIterator *handle)
 
TESS_API TessPageIteratorTessResultIteratorGetPageIterator (TessResultIterator *handle)
 
TESS_API const TessPageIteratorTessResultIteratorGetPageIteratorConst (const TessResultIterator *handle)
 
TESS_API TessChoiceIteratorTessResultIteratorGetChoiceIterator (const TessResultIterator *handle)
 
TESS_API BOOL TessResultIteratorNext (TessResultIterator *handle, TessPageIteratorLevel level)
 
TESS_API char * TessResultIteratorGetUTF8Text (const TessResultIterator *handle, TessPageIteratorLevel level)
 
TESS_API float TessResultIteratorConfidence (const TessResultIterator *handle, TessPageIteratorLevel level)
 
TESS_API const char * TessResultIteratorWordRecognitionLanguage (const TessResultIterator *handle)
 
TESS_API const char * TessResultIteratorWordFontAttributes (const TessResultIterator *handle, BOOL *is_bold, BOOL *is_italic, BOOL *is_underlined, BOOL *is_monospace, BOOL *is_serif, BOOL *is_smallcaps, int *pointsize, int *font_id)
 
TESS_API BOOL TessResultIteratorWordIsFromDictionary (const TessResultIterator *handle)
 
TESS_API BOOL TessResultIteratorWordIsNumeric (const TessResultIterator *handle)
 
TESS_API BOOL TessResultIteratorSymbolIsSuperscript (const TessResultIterator *handle)
 
TESS_API BOOL TessResultIteratorSymbolIsSubscript (const TessResultIterator *handle)
 
TESS_API BOOL TessResultIteratorSymbolIsDropcap (const TessResultIterator *handle)
 
TESS_API void TessChoiceIteratorDelete (TessChoiceIterator *handle)
 
TESS_API BOOL TessChoiceIteratorNext (TessChoiceIterator *handle)
 
TESS_API const char * TessChoiceIteratorGetUTF8Text (const TessChoiceIterator *handle)
 
TESS_API float TessChoiceIteratorConfidence (const TessChoiceIterator *handle)
 
TESS_API ETEXT_DESCTessMonitorCreate ()
 
TESS_API void TessMonitorDelete (ETEXT_DESC *monitor)
 
TESS_API void TessMonitorSetCancelFunc (ETEXT_DESC *monitor, TessCancelFunc cancelFunc)
 
TESS_API void TessMonitorSetCancelThis (ETEXT_DESC *monitor, void *cancelThis)
 
TESS_API void * TessMonitorGetCancelThis (ETEXT_DESC *monitor)
 
TESS_API void TessMonitorSetProgressFunc (ETEXT_DESC *monitor, TessProgressFunc progressFunc)
 
TESS_API int TessMonitorGetProgress (ETEXT_DESC *monitor)
 
TESS_API void TessMonitorSetDeadlineMSecs (ETEXT_DESC *monitor, int deadline)
 

Macro Definition Documentation

◆ BOOL

#define BOOL   int

Definition at line 39 of file capi.h.

◆ FALSE

#define FALSE   0

Definition at line 41 of file capi.h.

◆ TRUE

#define TRUE   1

Definition at line 40 of file capi.h.

Typedef Documentation

◆ ETEXT_DESC

typedef struct ETEXT_DESC ETEXT_DESC

Definition at line 1 of file capi.h.

◆ TessBaseAPI

typedef struct TessBaseAPI TessBaseAPI

Definition at line 1 of file capi.h.

◆ TessCancelFunc

typedef bool(* TessCancelFunc) (void *cancel_this, int words)

Definition at line 140 of file capi.h.

◆ TessChoiceIterator

Definition at line 1 of file capi.h.

◆ TessMutableIterator

Definition at line 1 of file capi.h.

◆ TessOcrEngineMode

◆ TessOrientation

◆ TessPageIterator

Definition at line 1 of file capi.h.

◆ TessPageIteratorLevel

◆ TessPageSegMode

◆ TessParagraphJustification

◆ TessPolyBlockType

◆ TessProgressFunc

typedef bool(* TessProgressFunc) (ETEXT_DESC *ths, int left, int right, int top, int bottom)

Definition at line 141 of file capi.h.

◆ TessResultIterator

Definition at line 1 of file capi.h.

◆ TessResultRenderer

Definition at line 1 of file capi.h.

◆ TessTextlineOrder

◆ TessWritingDirection

Enumeration Type Documentation

◆ TessOcrEngineMode

Enumerator
OEM_TESSERACT_ONLY 
OEM_LSTM_ONLY 
OEM_TESSERACT_LSTM_COMBINED 
OEM_DEFAULT 

Definition at line 67 of file capi.h.

67  {
TessOcrEngineMode
Definition: capi.h:67
@ OEM_DEFAULT
Definition: capi.h:71
@ OEM_TESSERACT_ONLY
Definition: capi.h:68
@ OEM_LSTM_ONLY
Definition: capi.h:69
@ OEM_TESSERACT_LSTM_COMBINED
Definition: capi.h:70

◆ TessOrientation

Enumerator
ORIENTATION_PAGE_UP 
ORIENTATION_PAGE_RIGHT 
ORIENTATION_PAGE_DOWN 
ORIENTATION_PAGE_LEFT 

Definition at line 115 of file capi.h.

115  {
TessOrientation
Definition: capi.h:115
@ ORIENTATION_PAGE_DOWN
Definition: capi.h:118
@ ORIENTATION_PAGE_RIGHT
Definition: capi.h:117
@ ORIENTATION_PAGE_UP
Definition: capi.h:116
@ ORIENTATION_PAGE_LEFT
Definition: capi.h:119

◆ TessPageIteratorLevel

Enumerator
RIL_BLOCK 
RIL_PARA 
RIL_TEXTLINE 
RIL_WORD 
RIL_SYMBOL 

Definition at line 90 of file capi.h.

90  {
91  RIL_BLOCK,
92  RIL_PARA,
94  RIL_WORD,
TessPageIteratorLevel
Definition: capi.h:90
@ RIL_TEXTLINE
Definition: capi.h:93
@ RIL_PARA
Definition: capi.h:92
@ RIL_BLOCK
Definition: capi.h:91
@ RIL_WORD
Definition: capi.h:94
@ RIL_SYMBOL
Definition: capi.h:95

◆ TessPageSegMode

Enumerator
PSM_OSD_ONLY 
PSM_AUTO_OSD 
PSM_AUTO_ONLY 
PSM_AUTO 
PSM_SINGLE_COLUMN 
PSM_SINGLE_BLOCK_VERT_TEXT 
PSM_SINGLE_BLOCK 
PSM_SINGLE_LINE 
PSM_SINGLE_WORD 
PSM_CIRCLE_WORD 
PSM_SINGLE_CHAR 
PSM_SPARSE_TEXT 
PSM_SPARSE_TEXT_OSD 
PSM_RAW_LINE 
PSM_COUNT 

Definition at line 73 of file capi.h.

73  {
77  PSM_AUTO,
88  PSM_COUNT
TessPageSegMode
Definition: capi.h:73
@ PSM_AUTO
Definition: capi.h:77
@ PSM_OSD_ONLY
Definition: capi.h:74
@ PSM_SINGLE_CHAR
Definition: capi.h:84
@ PSM_AUTO_OSD
Definition: capi.h:75
@ PSM_CIRCLE_WORD
Definition: capi.h:83
@ PSM_SINGLE_BLOCK_VERT_TEXT
Definition: capi.h:79
@ PSM_SINGLE_COLUMN
Definition: capi.h:78
@ PSM_SPARSE_TEXT
Definition: capi.h:85
@ PSM_COUNT
Definition: capi.h:88
@ PSM_SINGLE_LINE
Definition: capi.h:81
@ PSM_SINGLE_BLOCK
Definition: capi.h:80
@ PSM_RAW_LINE
Definition: capi.h:87
@ PSM_AUTO_ONLY
Definition: capi.h:76
@ PSM_SINGLE_WORD
Definition: capi.h:82
@ PSM_SPARSE_TEXT_OSD
Definition: capi.h:86

◆ TessParagraphJustification

Enumerator
JUSTIFICATION_UNKNOWN 
JUSTIFICATION_LEFT 
JUSTIFICATION_CENTER 
JUSTIFICATION_RIGHT 

Definition at line 121 of file capi.h.

121  {
TessParagraphJustification
Definition: capi.h:121
@ JUSTIFICATION_LEFT
Definition: capi.h:123
@ JUSTIFICATION_RIGHT
Definition: capi.h:125
@ JUSTIFICATION_CENTER
Definition: capi.h:124
@ JUSTIFICATION_UNKNOWN
Definition: capi.h:122

◆ TessPolyBlockType

Enumerator
PT_UNKNOWN 
PT_FLOWING_TEXT 
PT_HEADING_TEXT 
PT_PULLOUT_TEXT 
PT_EQUATION 
PT_INLINE_EQUATION 
PT_TABLE 
PT_VERTICAL_TEXT 
PT_CAPTION_TEXT 
PT_FLOWING_IMAGE 
PT_HEADING_IMAGE 
PT_PULLOUT_IMAGE 
PT_HORZ_LINE 
PT_VERT_LINE 
PT_NOISE 
PT_COUNT 

Definition at line 97 of file capi.h.

97  {
98  PT_UNKNOWN,
102  PT_EQUATION,
104  PT_TABLE,
110  PT_HORZ_LINE,
111  PT_VERT_LINE,
112  PT_NOISE,
113  PT_COUNT
TessPolyBlockType
Definition: capi.h:97
@ PT_VERT_LINE
Definition: capi.h:111
@ PT_PULLOUT_TEXT
Definition: capi.h:101
@ PT_COUNT
Definition: capi.h:113
@ PT_HEADING_TEXT
Definition: capi.h:100
@ PT_TABLE
Definition: capi.h:104
@ PT_NOISE
Definition: capi.h:112
@ PT_PULLOUT_IMAGE
Definition: capi.h:109
@ PT_HEADING_IMAGE
Definition: capi.h:108
@ PT_INLINE_EQUATION
Definition: capi.h:103
@ PT_FLOWING_TEXT
Definition: capi.h:99
@ PT_UNKNOWN
Definition: capi.h:98
@ PT_HORZ_LINE
Definition: capi.h:110
@ PT_VERTICAL_TEXT
Definition: capi.h:105
@ PT_EQUATION
Definition: capi.h:102
@ PT_FLOWING_IMAGE
Definition: capi.h:107
@ PT_CAPTION_TEXT
Definition: capi.h:106

◆ TessTextlineOrder

Enumerator
TEXTLINE_ORDER_LEFT_TO_RIGHT 
TEXTLINE_ORDER_RIGHT_TO_LEFT 
TEXTLINE_ORDER_TOP_TO_BOTTOM 

Definition at line 132 of file capi.h.

132  {
TessTextlineOrder
Definition: capi.h:132
@ TEXTLINE_ORDER_TOP_TO_BOTTOM
Definition: capi.h:135
@ TEXTLINE_ORDER_RIGHT_TO_LEFT
Definition: capi.h:134
@ TEXTLINE_ORDER_LEFT_TO_RIGHT
Definition: capi.h:133

◆ TessWritingDirection

Enumerator
WRITING_DIRECTION_LEFT_TO_RIGHT 
WRITING_DIRECTION_RIGHT_TO_LEFT 
WRITING_DIRECTION_TOP_TO_BOTTOM 

Definition at line 127 of file capi.h.

127  {
TessWritingDirection
Definition: capi.h:127
@ WRITING_DIRECTION_RIGHT_TO_LEFT
Definition: capi.h:129
@ WRITING_DIRECTION_TOP_TO_BOTTOM
Definition: capi.h:130
@ WRITING_DIRECTION_LEFT_TO_RIGHT
Definition: capi.h:128

Function Documentation

◆ TessAltoRendererCreate()

TESS_API TessResultRenderer* TessAltoRendererCreate ( const char *  outputbase)

Definition at line 53 of file capi.cpp.

53  {
54  return new tesseract::TessAltoRenderer(outputbase);
55 }

◆ TessBaseAPIAdaptToWordStr()

TESS_API BOOL TessBaseAPIAdaptToWordStr ( TessBaseAPI handle,
TessPageSegMode  mode,
const char *  wordstr 
)

Definition at line 436 of file capi.cpp.

436  {
437  return static_cast<int>(handle->AdaptToWordStr(mode, wordstr));
438 }

◆ TessBaseAPIAllWordConfidences()

TESS_API int* TessBaseAPIAllWordConfidences ( TessBaseAPI handle)

Definition at line 431 of file capi.cpp.

431  {
432  return handle->AllWordConfidences();
433 }

◆ TessBaseAPIAnalyseLayout()

TESS_API TessPageIterator* TessBaseAPIAnalyseLayout ( TessBaseAPI handle)

Definition at line 367 of file capi.cpp.

367  {
368  return handle->AnalyseLayout();
369 }

◆ TessBaseAPIClear()

TESS_API void TessBaseAPIClear ( TessBaseAPI handle)

Definition at line 441 of file capi.cpp.

441  {
442  handle->Clear();
443 }

◆ TessBaseAPIClearAdaptiveClassifier()

TESS_API void TessBaseAPIClearAdaptiveClassifier ( TessBaseAPI handle)

Definition at line 284 of file capi.cpp.

284  {
285  handle->ClearAdaptiveClassifier();
286 }

◆ TessBaseAPIClearPersistentCache()

TESS_API void TessBaseAPIClearPersistentCache ( TessBaseAPI handle)

Definition at line 310 of file capi.cpp.

310  {
311  TessBaseAPI::ClearPersistentCache();
312 }

◆ TessBaseAPICreate()

TESS_API TessBaseAPI* TessBaseAPICreate ( )

Definition at line 118 of file capi.cpp.

118  {
119  return new TessBaseAPI;
120 }
struct TessBaseAPI TessBaseAPI
Definition: capi.h:62

◆ TessBaseAPIDelete()

TESS_API void TessBaseAPIDelete ( TessBaseAPI handle)

Definition at line 122 of file capi.cpp.

122  {
123  delete handle;
124 }

◆ TessBaseAPIDetectOrientationScript()

TESS_API BOOL TessBaseAPIDetectOrientationScript ( TessBaseAPI handle,
int *  orient_deg,
float *  orient_conf,
const char **  script_name,
float *  script_conf 
)

Definition at line 316 of file capi.cpp.

317  {
318  auto success = handle->DetectOrientationScript(orient_deg, orient_conf, script_name, script_conf);
319  return static_cast<BOOL>(success);
320 }
#define BOOL
Definition: capi.h:39

◆ TessBaseAPIEnd()

TESS_API void TessBaseAPIEnd ( TessBaseAPI handle)

Definition at line 445 of file capi.cpp.

445  {
446  handle->End();
447 }

◆ TessBaseAPIGetAltoText()

TESS_API char* TessBaseAPIGetAltoText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 403 of file capi.cpp.

403  {
404  return handle->GetAltoText(page_number);
405 }

◆ TessBaseAPIGetAvailableLanguagesAsVector()

TESS_API char** TessBaseAPIGetAvailableLanguagesAsVector ( const TessBaseAPI handle)

Definition at line 246 of file capi.cpp.

246  {
247  std::vector<std::string> languages;
248  handle->GetAvailableLanguagesAsVector(&languages);
249  char **arr = new char *[languages.size() + 1];
250  for (auto &language : languages) {
251  arr[&language - &languages[0]] = strdup(language.c_str());
252  }
253  arr[languages.size()] = nullptr;
254  return arr;
255 }

◆ TessBaseAPIGetBoolVariable()

TESS_API BOOL TessBaseAPIGetBoolVariable ( const TessBaseAPI handle,
const char *  name,
BOOL value 
)

Definition at line 170 of file capi.cpp.

170  {
171  bool boolValue;
172  bool result = handle->GetBoolVariable(name, &boolValue);
173  if (result) {
174  *value = static_cast<int>(boolValue);
175  }
176  return static_cast<int>(result);
177 }

◆ TessBaseAPIGetBoxText()

TESS_API char* TessBaseAPIGetBoxText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 411 of file capi.cpp.

411  {
412  return handle->GetBoxText(page_number);
413 }

◆ TessBaseAPIGetComponentImages()

TESS_API struct Boxa* TessBaseAPIGetComponentImages ( TessBaseAPI handle,
TessPageIteratorLevel  level,
BOOL  text_only,
struct Pixa **  pixa,
int **  blockids 
)

Definition at line 350 of file capi.cpp.

351  {
352  return handle->GetComponentImages(level, static_cast<bool>(text_only), pixa, blockids);
353 }

◆ TessBaseAPIGetComponentImages1()

TESS_API struct Boxa* TessBaseAPIGetComponentImages1 ( TessBaseAPI handle,
TessPageIteratorLevel  level,
BOOL  text_only,
BOOL  raw_image,
int  raw_padding,
struct Pixa **  pixa,
int **  blockids,
int **  paraids 
)

Definition at line 355 of file capi.cpp.

358  {
359  return handle->GetComponentImages(level, static_cast<bool>(text_only), raw_image != 0,
360  raw_padding, pixa, blockids, paraids);
361 }

◆ TessBaseAPIGetConnectedComponents()

TESS_API struct Boxa* TessBaseAPIGetConnectedComponents ( TessBaseAPI handle,
struct Pixa **  cc 
)

Definition at line 346 of file capi.cpp.

346  {
347  return handle->GetConnectedComponents(cc);
348 }

◆ TessBaseAPIGetDatapath()

TESS_API const char* TessBaseAPIGetDatapath ( TessBaseAPI handle)

Definition at line 150 of file capi.cpp.

150  {
151  return handle->GetDatapath();
152 }

◆ TessBaseAPIGetDoubleVariable()

TESS_API BOOL TessBaseAPIGetDoubleVariable ( const TessBaseAPI handle,
const char *  name,
double *  value 
)

Definition at line 179 of file capi.cpp.

179  {
180  return static_cast<int>(handle->GetDoubleVariable(name, value));
181 }

◆ TessBaseAPIGetHOCRText()

TESS_API char* TessBaseAPIGetHOCRText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 399 of file capi.cpp.

399  {
400  return handle->GetHOCRText(nullptr, page_number);
401 }

◆ TessBaseAPIGetInitLanguagesAsString()

TESS_API const char* TessBaseAPIGetInitLanguagesAsString ( const TessBaseAPI handle)

Definition at line 231 of file capi.cpp.

231  {
232  return handle->GetInitLanguagesAsString();
233 }

◆ TessBaseAPIGetInputImage()

TESS_API struct Pix* TessBaseAPIGetInputImage ( TessBaseAPI handle)

Definition at line 142 of file capi.cpp.

142  {
143  return handle->GetInputImage();
144 }

◆ TessBaseAPIGetInputName()

TESS_API const char* TessBaseAPIGetInputName ( TessBaseAPI handle)

Definition at line 134 of file capi.cpp.

134  {
135  return handle->GetInputName();
136 }

◆ TessBaseAPIGetIntVariable()

TESS_API BOOL TessBaseAPIGetIntVariable ( const TessBaseAPI handle,
const char *  name,
int *  value 
)

Definition at line 166 of file capi.cpp.

166  {
167  return static_cast<int>(handle->GetIntVariable(name, value));
168 }

◆ TessBaseAPIGetIterator()

TESS_API TessResultIterator* TessBaseAPIGetIterator ( TessBaseAPI handle)

Definition at line 387 of file capi.cpp.

387  {
388  return handle->GetIterator();
389 }

◆ TessBaseAPIGetLoadedLanguagesAsVector()

TESS_API char** TessBaseAPIGetLoadedLanguagesAsVector ( const TessBaseAPI handle)

Definition at line 235 of file capi.cpp.

235  {
236  std::vector<std::string> languages;
237  handle->GetLoadedLanguagesAsVector(&languages);
238  char **arr = new char *[languages.size() + 1];
239  for (auto &language : languages) {
240  arr[&language - &languages[0]] = strdup(language.c_str());
241  }
242  arr[languages.size()] = nullptr;
243  return arr;
244 }

◆ TessBaseAPIGetLSTMBoxText()

TESS_API char* TessBaseAPIGetLSTMBoxText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 419 of file capi.cpp.

419  {
420  return handle->GetLSTMBoxText(page_number);
421 }

◆ TessBaseAPIGetMutableIterator()

TESS_API TessMutableIterator* TessBaseAPIGetMutableIterator ( TessBaseAPI handle)

Definition at line 391 of file capi.cpp.

391  {
392  return handle->GetMutableIterator();
393 }

◆ TessBaseAPIGetOpenCLDevice()

TESS_API size_t TessBaseAPIGetOpenCLDevice ( TessBaseAPI handle,
void **  device 
)

Definition at line 126 of file capi.cpp.

126  {
127  return TessBaseAPI::getOpenCLDevice(device);
128 }

◆ TessBaseAPIGetPageSegMode()

TESS_API TessPageSegMode TessBaseAPIGetPageSegMode ( const TessBaseAPI handle)

Definition at line 273 of file capi.cpp.

273  {
274  return handle->GetPageSegMode();
275 }

◆ TessBaseAPIGetRegions()

TESS_API struct Boxa* TessBaseAPIGetRegions ( TessBaseAPI handle,
struct Pixa **  pixa 
)

Definition at line 324 of file capi.cpp.

324  {
325  return handle->GetRegions(pixa);
326 }

◆ TessBaseAPIGetSourceYResolution()

TESS_API int TessBaseAPIGetSourceYResolution ( TessBaseAPI handle)

Definition at line 146 of file capi.cpp.

146  {
147  return handle->GetSourceYResolution();
148 }

◆ TessBaseAPIGetStringVariable()

TESS_API const char* TessBaseAPIGetStringVariable ( const TessBaseAPI handle,
const char *  name 
)

Definition at line 183 of file capi.cpp.

183  {
184  return handle->GetStringVariable(name);
185 }

◆ TessBaseAPIGetStrips()

TESS_API struct Boxa* TessBaseAPIGetStrips ( TessBaseAPI handle,
struct Pixa **  pixa,
int **  blockids 
)

Definition at line 338 of file capi.cpp.

338  {
339  return handle->GetStrips(pixa, blockids);
340 }

◆ TessBaseAPIGetTextDirection()

TESS_API BOOL TessBaseAPIGetTextDirection ( TessBaseAPI handle,
int *  out_offset,
float *  out_slope 
)

Definition at line 453 of file capi.cpp.

453  {
454  return static_cast<int>(handle->GetTextDirection(out_offset, out_slope));
455 }

◆ TessBaseAPIGetTextlines()

TESS_API struct Boxa* TessBaseAPIGetTextlines ( TessBaseAPI handle,
struct Pixa **  pixa,
int **  blockids 
)

Definition at line 328 of file capi.cpp.

328  {
329  return handle->GetTextlines(pixa, blockids);
330 }

◆ TessBaseAPIGetTextlines1()

TESS_API struct Boxa* TessBaseAPIGetTextlines1 ( TessBaseAPI handle,
BOOL  raw_image,
int  raw_padding,
struct Pixa **  pixa,
int **  blockids,
int **  paraids 
)

Definition at line 332 of file capi.cpp.

334  {
335  return handle->GetTextlines(raw_image != 0, raw_padding, pixa, blockids, paraids);
336 }

◆ TessBaseAPIGetThresholdedImage()

TESS_API struct Pix* TessBaseAPIGetThresholdedImage ( TessBaseAPI handle)

Definition at line 306 of file capi.cpp.

306  {
307  return handle->GetThresholdedImage();
308 }

◆ TessBaseAPIGetThresholdedImageScaleFactor()

TESS_API int TessBaseAPIGetThresholdedImageScaleFactor ( const TessBaseAPI handle)

Definition at line 363 of file capi.cpp.

363  {
364  return handle->GetThresholdedImageScaleFactor();
365 }

◆ TessBaseAPIGetTsvText()

TESS_API char* TessBaseAPIGetTsvText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 407 of file capi.cpp.

407  {
408  return handle->GetTSVText(page_number);
409 }

◆ TessBaseAPIGetUnichar()

TESS_API const char* TessBaseAPIGetUnichar ( TessBaseAPI handle,
int  unichar_id 
)

Definition at line 457 of file capi.cpp.

457  {
458  return handle->GetUnichar(unichar_id);
459 }

◆ TessBaseAPIGetUNLVText()

TESS_API char* TessBaseAPIGetUNLVText ( TessBaseAPI handle)

Definition at line 423 of file capi.cpp.

423  {
424  return handle->GetUNLVText();
425 }

◆ TessBaseAPIGetUTF8Text()

TESS_API char* TessBaseAPIGetUTF8Text ( TessBaseAPI handle)

Definition at line 395 of file capi.cpp.

395  {
396  return handle->GetUTF8Text();
397 }

◆ TessBaseAPIGetWords()

TESS_API struct Boxa* TessBaseAPIGetWords ( TessBaseAPI handle,
struct Pixa **  pixa 
)

Definition at line 342 of file capi.cpp.

342  {
343  return handle->GetWords(pixa);
344 }

◆ TessBaseAPIGetWordStrBoxText()

TESS_API char* TessBaseAPIGetWordStrBoxText ( TessBaseAPI handle,
int  page_number 
)

Definition at line 415 of file capi.cpp.

415  {
416  return handle->GetWordStrBoxText(page_number);
417 }

◆ TessBaseAPIInit1()

TESS_API int TessBaseAPIInit1 ( TessBaseAPI handle,
const char *  datapath,
const char *  language,
TessOcrEngineMode  oem,
char **  configs,
int  configs_size 
)

Definition at line 217 of file capi.cpp.

218  {
219  return handle->Init(datapath, language, oem, configs, configs_size, nullptr, nullptr, false);
220 }

◆ TessBaseAPIInit2()

TESS_API int TessBaseAPIInit2 ( TessBaseAPI handle,
const char *  datapath,
const char *  language,
TessOcrEngineMode  oem 
)

Definition at line 222 of file capi.cpp.

223  {
224  return handle->Init(datapath, language, oem);
225 }

◆ TessBaseAPIInit3()

TESS_API int TessBaseAPIInit3 ( TessBaseAPI handle,
const char *  datapath,
const char *  language 
)

Definition at line 227 of file capi.cpp.

227  {
228  return handle->Init(datapath, language);
229 }

◆ TessBaseAPIInit4()

TESS_API int TessBaseAPIInit4 ( TessBaseAPI handle,
const char *  datapath,
const char *  language,
TessOcrEngineMode  mode,
char **  configs,
int  configs_size,
char **  vars_vec,
char **  vars_values,
size_t  vars_vec_size,
BOOL  set_only_non_debug_params 
)

Definition at line 201 of file capi.cpp.

203  {
204  std::vector<std::string> varNames;
205  std::vector<std::string> varValues;
206  if (vars_vec != nullptr && vars_values != nullptr) {
207  for (size_t i = 0; i < vars_vec_size; i++) {
208  varNames.emplace_back(vars_vec[i]);
209  varValues.emplace_back(vars_values[i]);
210  }
211  }
212 
213  return handle->Init(datapath, language, mode, configs, configs_size, &varNames, &varValues,
214  set_only_non_debug_params != 0);
215 }

◆ TessBaseAPIInitForAnalysePage()

TESS_API void TessBaseAPIInitForAnalysePage ( TessBaseAPI handle)

Definition at line 257 of file capi.cpp.

257  {
258  handle->InitForAnalysePage();
259 }

◆ TessBaseAPIIsValidWord()

TESS_API int TessBaseAPIIsValidWord ( TessBaseAPI handle,
const char *  word 
)

Definition at line 449 of file capi.cpp.

449  {
450  return handle->IsValidWord(word);
451 }

◆ TessBaseAPIMeanTextConf()

TESS_API int TessBaseAPIMeanTextConf ( TessBaseAPI handle)

Definition at line 427 of file capi.cpp.

427  {
428  return handle->MeanTextConf();
429 }

◆ TessBaseAPINumDawgs()

TESS_API int TessBaseAPINumDawgs ( const TessBaseAPI handle)

Definition at line 465 of file capi.cpp.

465  {
466  return handle->NumDawgs();
467 }

◆ TessBaseAPIOem()

TESS_API TessOcrEngineMode TessBaseAPIOem ( const TessBaseAPI handle)

Definition at line 469 of file capi.cpp.

469  {
470  return handle->oem();
471 }

◆ TessBaseAPIPrintVariables()

TESS_API void TessBaseAPIPrintVariables ( const TessBaseAPI handle,
FILE *  fp 
)

Definition at line 187 of file capi.cpp.

187  {
188  handle->PrintVariables(fp);
189 }

◆ TessBaseAPIPrintVariablesToFile()

TESS_API BOOL TessBaseAPIPrintVariablesToFile ( const TessBaseAPI handle,
const char *  filename 
)

Definition at line 191 of file capi.cpp.

191  {
192  FILE *fp = fopen(filename, "w");
193  if (fp != nullptr) {
194  handle->PrintVariables(fp);
195  fclose(fp);
196  return TRUE;
197  }
198  return FALSE;
199 }
#define TRUE
Definition: capi.h:40
#define FALSE
Definition: capi.h:41

◆ TessBaseAPIProcessPage()

TESS_API BOOL TessBaseAPIProcessPage ( TessBaseAPI handle,
struct Pix *  pix,
int  page_index,
const char *  filename,
const char *  retry_config,
int  timeout_millisec,
TessResultRenderer renderer 
)

Definition at line 380 of file capi.cpp.

382  {
383  return static_cast<int>(
384  handle->ProcessPage(pix, page_index, filename, retry_config, timeout_millisec, renderer));
385 }

◆ TessBaseAPIProcessPages()

TESS_API BOOL TessBaseAPIProcessPages ( TessBaseAPI handle,
const char *  filename,
const char *  retry_config,
int  timeout_millisec,
TessResultRenderer renderer 
)

Definition at line 375 of file capi.cpp.

376  {
377  return static_cast<int>(handle->ProcessPages(filename, retry_config, timeout_millisec, renderer));
378 }

◆ TessBaseAPIReadConfigFile()

TESS_API void TessBaseAPIReadConfigFile ( TessBaseAPI handle,
const char *  filename 
)

Definition at line 261 of file capi.cpp.

261  {
262  handle->ReadConfigFile(filename);
263 }

◆ TessBaseAPIReadDebugConfigFile()

TESS_API void TessBaseAPIReadDebugConfigFile ( TessBaseAPI handle,
const char *  filename 
)

Definition at line 265 of file capi.cpp.

265  {
266  handle->ReadDebugConfigFile(filename);
267 }

◆ TessBaseAPIRecognize()

TESS_API int TessBaseAPIRecognize ( TessBaseAPI handle,
ETEXT_DESC monitor 
)

Definition at line 371 of file capi.cpp.

371  {
372  return handle->Recognize(monitor);
373 }

◆ TessBaseAPIRect()

TESS_API char* TessBaseAPIRect ( TessBaseAPI handle,
const unsigned char *  imagedata,
int  bytes_per_pixel,
int  bytes_per_line,
int  left,
int  top,
int  width,
int  height 
)

Definition at line 277 of file capi.cpp.

278  {
279  return handle->TesseractRect(imagedata, bytes_per_pixel, bytes_per_line, left, top, width,
280  height);
281 }

◆ TessBaseAPISetDebugVariable()

TESS_API BOOL TessBaseAPISetDebugVariable ( TessBaseAPI handle,
const char *  name,
const char *  value 
)

Definition at line 162 of file capi.cpp.

162  {
163  return static_cast<int>(handle->SetDebugVariable(name, value));
164 }

◆ TessBaseAPISetImage()

TESS_API void TessBaseAPISetImage ( TessBaseAPI handle,
const unsigned char *  imagedata,
int  width,
int  height,
int  bytes_per_pixel,
int  bytes_per_line 
)

Definition at line 289 of file capi.cpp.

290  {
291  handle->SetImage(imagedata, width, height, bytes_per_pixel, bytes_per_line);
292 }

◆ TessBaseAPISetImage2()

TESS_API void TessBaseAPISetImage2 ( TessBaseAPI handle,
struct Pix *  pix 
)

Definition at line 294 of file capi.cpp.

294  {
295  return handle->SetImage(pix);
296 }

◆ TessBaseAPISetInputImage()

TESS_API void TessBaseAPISetInputImage ( TessBaseAPI handle,
struct Pix *  pix 
)

Definition at line 138 of file capi.cpp.

138  {
139  handle->SetInputImage(pix);
140 }

◆ TessBaseAPISetInputName()

TESS_API void TessBaseAPISetInputName ( TessBaseAPI handle,
const char *  name 
)

Definition at line 130 of file capi.cpp.

130  {
131  handle->SetInputName(name);
132 }

◆ TessBaseAPISetMinOrientationMargin()

TESS_API void TessBaseAPISetMinOrientationMargin ( TessBaseAPI handle,
double  margin 
)

Definition at line 461 of file capi.cpp.

461  {
462  handle->set_min_orientation_margin(margin);
463 }

◆ TessBaseAPISetOutputName()

TESS_API void TessBaseAPISetOutputName ( TessBaseAPI handle,
const char *  name 
)

Definition at line 154 of file capi.cpp.

154  {
155  handle->SetOutputName(name);
156 }

◆ TessBaseAPISetPageSegMode()

TESS_API void TessBaseAPISetPageSegMode ( TessBaseAPI handle,
TessPageSegMode  mode 
)

Definition at line 269 of file capi.cpp.

269  {
270  handle->SetPageSegMode(mode);
271 }

◆ TessBaseAPISetRectangle()

TESS_API void TessBaseAPISetRectangle ( TessBaseAPI handle,
int  left,
int  top,
int  width,
int  height 
)

Definition at line 302 of file capi.cpp.

302  {
303  handle->SetRectangle(left, top, width, height);
304 }

◆ TessBaseAPISetSourceResolution()

TESS_API void TessBaseAPISetSourceResolution ( TessBaseAPI handle,
int  ppi 
)

Definition at line 298 of file capi.cpp.

298  {
299  handle->SetSourceResolution(ppi);
300 }

◆ TessBaseAPISetVariable()

TESS_API BOOL TessBaseAPISetVariable ( TessBaseAPI handle,
const char *  name,
const char *  value 
)

Definition at line 158 of file capi.cpp.

158  {
159  return static_cast<int>(handle->SetVariable(name, value));
160 }

◆ TessBaseGetBlockTextOrientations()

TESS_API void TessBaseGetBlockTextOrientations ( TessBaseAPI handle,
int **  block_orientation,
bool **  vertical_writing 
)

Definition at line 473 of file capi.cpp.

474  {
475  handle->GetBlockTextOrientations(block_orientation, vertical_writing);
476 }

◆ TessBoxTextRendererCreate()

TESS_API TessResultRenderer* TessBoxTextRendererCreate ( const char *  outputbase)

Definition at line 70 of file capi.cpp.

70  {
71  return new tesseract::TessBoxTextRenderer(outputbase);
72 }

◆ TessChoiceIteratorConfidence()

TESS_API float TessChoiceIteratorConfidence ( const TessChoiceIterator handle)

Definition at line 649 of file capi.cpp.

649  {
650  return handle->Confidence();
651 }

◆ TessChoiceIteratorDelete()

TESS_API void TessChoiceIteratorDelete ( TessChoiceIterator handle)

Definition at line 637 of file capi.cpp.

637  {
638  delete handle;
639 }

◆ TessChoiceIteratorGetUTF8Text()

TESS_API const char* TessChoiceIteratorGetUTF8Text ( const TessChoiceIterator handle)

Definition at line 645 of file capi.cpp.

645  {
646  return handle->GetUTF8Text();
647 }

◆ TessChoiceIteratorNext()

TESS_API BOOL TessChoiceIteratorNext ( TessChoiceIterator handle)

Definition at line 641 of file capi.cpp.

641  {
642  return static_cast<int>(handle->Next());
643 }

◆ TessDeleteIntArray()

TESS_API void TessDeleteIntArray ( const int *  arr)

Definition at line 37 of file capi.cpp.

37  {
38  delete[] arr;
39 }

◆ TessDeleteResultRenderer()

TESS_API void TessDeleteResultRenderer ( TessResultRenderer renderer)

Definition at line 82 of file capi.cpp.

82  {
83  delete renderer;
84 }

◆ TessDeleteText()

TESS_API void TessDeleteText ( const char *  text)

Definition at line 26 of file capi.cpp.

26  {
27  delete[] text;
28 }

◆ TessDeleteTextArray()

TESS_API void TessDeleteTextArray ( char **  arr)

Definition at line 30 of file capi.cpp.

30  {
31  for (char **pos = arr; *pos != nullptr; ++pos) {
32  delete[] * pos;
33  }
34  delete[] arr;
35 }

◆ TessHOcrRendererCreate()

TESS_API TessResultRenderer* TessHOcrRendererCreate ( const char *  outputbase)

Definition at line 45 of file capi.cpp.

45  {
46  return new tesseract::TessHOcrRenderer(outputbase);
47 }

◆ TessHOcrRendererCreate2()

TESS_API TessResultRenderer* TessHOcrRendererCreate2 ( const char *  outputbase,
BOOL  font_info 
)

Definition at line 49 of file capi.cpp.

49  {
50  return new tesseract::TessHOcrRenderer(outputbase, font_info != 0);
51 }

◆ TessLSTMBoxRendererCreate()

TESS_API TessResultRenderer* TessLSTMBoxRendererCreate ( const char *  outputbase)

Definition at line 78 of file capi.cpp.

78  {
79  return new tesseract::TessLSTMBoxRenderer(outputbase);
80 }

◆ TessMonitorCreate()

TESS_API ETEXT_DESC* TessMonitorCreate ( )

Definition at line 653 of file capi.cpp.

653  {
654  return new ETEXT_DESC();
655 }
struct ETEXT_DESC ETEXT_DESC
Definition: capi.h:137

◆ TessMonitorDelete()

TESS_API void TessMonitorDelete ( ETEXT_DESC monitor)

Definition at line 657 of file capi.cpp.

657  {
658  delete monitor;
659 }

◆ TessMonitorGetCancelThis()

TESS_API void* TessMonitorGetCancelThis ( ETEXT_DESC monitor)

Definition at line 669 of file capi.cpp.

669  {
670  return monitor->cancel_this;
671 }

◆ TessMonitorGetProgress()

TESS_API int TessMonitorGetProgress ( ETEXT_DESC monitor)

Definition at line 677 of file capi.cpp.

677  {
678  return monitor->progress;
679 }

◆ TessMonitorSetCancelFunc()

TESS_API void TessMonitorSetCancelFunc ( ETEXT_DESC monitor,
TessCancelFunc  cancelFunc 
)

Definition at line 661 of file capi.cpp.

661  {
662  monitor->cancel = cancelFunc;
663 }

◆ TessMonitorSetCancelThis()

TESS_API void TessMonitorSetCancelThis ( ETEXT_DESC monitor,
void *  cancelThis 
)

Definition at line 665 of file capi.cpp.

665  {
666  monitor->cancel_this = cancelThis;
667 }

◆ TessMonitorSetDeadlineMSecs()

TESS_API void TessMonitorSetDeadlineMSecs ( ETEXT_DESC monitor,
int  deadline 
)

Definition at line 681 of file capi.cpp.

681  {
682  monitor->set_deadline_msecs(deadline);
683 }

◆ TessMonitorSetProgressFunc()

TESS_API void TessMonitorSetProgressFunc ( ETEXT_DESC monitor,
TessProgressFunc  progressFunc 
)

Definition at line 673 of file capi.cpp.

673  {
674  monitor->progress_callback2 = progressFunc;
675 }

◆ TessPageIteratorBaseline()

TESS_API BOOL TessPageIteratorBaseline ( const TessPageIterator handle,
TessPageIteratorLevel  level,
int *  x1,
int *  y1,
int *  x2,
int *  y2 
)

Definition at line 522 of file capi.cpp.

523  {
524  return static_cast<int>(handle->Baseline(level, x1, y1, x2, y2));
525 }

◆ TessPageIteratorBegin()

TESS_API void TessPageIteratorBegin ( TessPageIterator handle)

Definition at line 486 of file capi.cpp.

486  {
487  handle->Begin();
488 }

◆ TessPageIteratorBlockType()

TESS_API TessPolyBlockType TessPageIteratorBlockType ( const TessPageIterator handle)

Definition at line 508 of file capi.cpp.

508  {
509  return handle->BlockType();
510 }

◆ TessPageIteratorBoundingBox()

TESS_API BOOL TessPageIteratorBoundingBox ( const TessPageIterator handle,
TessPageIteratorLevel  level,
int *  left,
int *  top,
int *  right,
int *  bottom 
)

Definition at line 503 of file capi.cpp.

504  {
505  return static_cast<int>(handle->BoundingBox(level, left, top, right, bottom));
506 }

◆ TessPageIteratorCopy()

TESS_API TessPageIterator* TessPageIteratorCopy ( const TessPageIterator handle)

Definition at line 482 of file capi.cpp.

482  {
483  return new TessPageIterator(*handle);
484 }
struct TessPageIterator TessPageIterator
Definition: capi.h:63

◆ TessPageIteratorDelete()

TESS_API void TessPageIteratorDelete ( TessPageIterator handle)

Definition at line 478 of file capi.cpp.

478  {
479  delete handle;
480 }

◆ TessPageIteratorGetBinaryImage()

TESS_API struct Pix* TessPageIteratorGetBinaryImage ( const TessPageIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 512 of file capi.cpp.

513  {
514  return handle->GetBinaryImage(level);
515 }

◆ TessPageIteratorGetImage()

TESS_API struct Pix* TessPageIteratorGetImage ( const TessPageIterator handle,
TessPageIteratorLevel  level,
int  padding,
struct Pix *  original_image,
int *  left,
int *  top 
)

Definition at line 517 of file capi.cpp.

518  {
519  return handle->GetImage(level, padding, original_image, left, top);
520 }

◆ TessPageIteratorIsAtBeginningOf()

TESS_API BOOL TessPageIteratorIsAtBeginningOf ( const TessPageIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 494 of file capi.cpp.

494  {
495  return static_cast<int>(handle->IsAtBeginningOf(level));
496 }

◆ TessPageIteratorIsAtFinalElement()

TESS_API BOOL TessPageIteratorIsAtFinalElement ( const TessPageIterator handle,
TessPageIteratorLevel  level,
TessPageIteratorLevel  element 
)

Definition at line 498 of file capi.cpp.

499  {
500  return static_cast<int>(handle->IsAtFinalElement(level, element));
501 }

◆ TessPageIteratorNext()

TESS_API BOOL TessPageIteratorNext ( TessPageIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 490 of file capi.cpp.

490  {
491  return static_cast<int>(handle->Next(level));
492 }

◆ TessPageIteratorOrientation()

TESS_API void TessPageIteratorOrientation ( TessPageIterator handle,
TessOrientation orientation,
TessWritingDirection writing_direction,
TessTextlineOrder textline_order,
float *  deskew_angle 
)

Definition at line 527 of file capi.cpp.

529  {
530  handle->Orientation(orientation, writing_direction, textline_order, deskew_angle);
531 }

◆ TessPageIteratorParagraphInfo()

TESS_API void TessPageIteratorParagraphInfo ( TessPageIterator handle,
TessParagraphJustification justification,
BOOL is_list_item,
BOOL is_crown,
int *  first_line_indent 
)

Definition at line 533 of file capi.cpp.

535  {
536  bool bool_is_list_item;
537  bool bool_is_crown;
538  handle->ParagraphInfo(justification, &bool_is_list_item, &bool_is_crown, first_line_indent);
539  if (is_list_item != nullptr) {
540  *is_list_item = static_cast<int>(bool_is_list_item);
541  }
542  if (is_crown != nullptr) {
543  *is_crown = static_cast<int>(bool_is_crown);
544  }
545 }

◆ TessPDFRendererCreate()

TESS_API TessResultRenderer* TessPDFRendererCreate ( const char *  outputbase,
const char *  datadir,
BOOL  textonly 
)

Definition at line 61 of file capi.cpp.

62  {
63  return new tesseract::TessPDFRenderer(outputbase, datadir, textonly != 0);
64 }

◆ TessResultIteratorConfidence()

TESS_API float TessResultIteratorConfidence ( const TessResultIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 575 of file capi.cpp.

575  {
576  return handle->Confidence(level);
577 }

◆ TessResultIteratorCopy()

TESS_API TessResultIterator* TessResultIteratorCopy ( const TessResultIterator handle)

Definition at line 551 of file capi.cpp.

551  {
552  return new TessResultIterator(*handle);
553 }
struct TessResultIterator TessResultIterator
Definition: capi.h:64

◆ TessResultIteratorDelete()

TESS_API void TessResultIteratorDelete ( TessResultIterator handle)

Definition at line 547 of file capi.cpp.

547  {
548  delete handle;
549 }

◆ TessResultIteratorGetChoiceIterator()

TESS_API TessChoiceIterator* TessResultIteratorGetChoiceIterator ( const TessResultIterator handle)

Definition at line 563 of file capi.cpp.

563  {
564  return new TessChoiceIterator(*handle);
565 }
struct TessChoiceIterator TessChoiceIterator
Definition: capi.h:66

◆ TessResultIteratorGetPageIterator()

TESS_API TessPageIterator* TessResultIteratorGetPageIterator ( TessResultIterator handle)

Definition at line 555 of file capi.cpp.

555  {
556  return handle;
557 }

◆ TessResultIteratorGetPageIteratorConst()

TESS_API const TessPageIterator* TessResultIteratorGetPageIteratorConst ( const TessResultIterator handle)

Definition at line 559 of file capi.cpp.

559  {
560  return handle;
561 }

◆ TessResultIteratorGetUTF8Text()

TESS_API char* TessResultIteratorGetUTF8Text ( const TessResultIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 571 of file capi.cpp.

571  {
572  return handle->GetUTF8Text(level);
573 }

◆ TessResultIteratorNext()

TESS_API BOOL TessResultIteratorNext ( TessResultIterator handle,
TessPageIteratorLevel  level 
)

Definition at line 567 of file capi.cpp.

567  {
568  return static_cast<int>(handle->Next(level));
569 }

◆ TessResultIteratorSymbolIsDropcap()

TESS_API BOOL TessResultIteratorSymbolIsDropcap ( const TessResultIterator handle)

Definition at line 633 of file capi.cpp.

633  {
634  return static_cast<int>(handle->SymbolIsDropcap());
635 }

◆ TessResultIteratorSymbolIsSubscript()

TESS_API BOOL TessResultIteratorSymbolIsSubscript ( const TessResultIterator handle)

Definition at line 629 of file capi.cpp.

629  {
630  return static_cast<int>(handle->SymbolIsSubscript());
631 }

◆ TessResultIteratorSymbolIsSuperscript()

TESS_API BOOL TessResultIteratorSymbolIsSuperscript ( const TessResultIterator handle)

Definition at line 625 of file capi.cpp.

625  {
626  return static_cast<int>(handle->SymbolIsSuperscript());
627 }

◆ TessResultIteratorWordFontAttributes()

TESS_API const char* TessResultIteratorWordFontAttributes ( const TessResultIterator handle,
BOOL is_bold,
BOOL is_italic,
BOOL is_underlined,
BOOL is_monospace,
BOOL is_serif,
BOOL is_smallcaps,
int *  pointsize,
int *  font_id 
)

Definition at line 583 of file capi.cpp.

586  {
587  bool bool_is_bold;
588  bool bool_is_italic;
589  bool bool_is_underlined;
590  bool bool_is_monospace;
591  bool bool_is_serif;
592  bool bool_is_smallcaps;
593  const char *ret = handle->WordFontAttributes(&bool_is_bold, &bool_is_italic, &bool_is_underlined,
594  &bool_is_monospace, &bool_is_serif,
595  &bool_is_smallcaps, pointsize, font_id);
596  if (is_bold != nullptr) {
597  *is_bold = static_cast<int>(bool_is_bold);
598  }
599  if (is_italic != nullptr) {
600  *is_italic = static_cast<int>(bool_is_italic);
601  }
602  if (is_underlined != nullptr) {
603  *is_underlined = static_cast<int>(bool_is_underlined);
604  }
605  if (is_monospace != nullptr) {
606  *is_monospace = static_cast<int>(bool_is_monospace);
607  }
608  if (is_serif != nullptr) {
609  *is_serif = static_cast<int>(bool_is_serif);
610  }
611  if (is_smallcaps != nullptr) {
612  *is_smallcaps = static_cast<int>(bool_is_smallcaps);
613  }
614  return ret;
615 }

◆ TessResultIteratorWordIsFromDictionary()

TESS_API BOOL TessResultIteratorWordIsFromDictionary ( const TessResultIterator handle)

Definition at line 617 of file capi.cpp.

617  {
618  return static_cast<int>(handle->WordIsFromDictionary());
619 }

◆ TessResultIteratorWordIsNumeric()

TESS_API BOOL TessResultIteratorWordIsNumeric ( const TessResultIterator handle)

Definition at line 621 of file capi.cpp.

621  {
622  return static_cast<int>(handle->WordIsNumeric());
623 }

◆ TessResultIteratorWordRecognitionLanguage()

TESS_API const char* TessResultIteratorWordRecognitionLanguage ( const TessResultIterator handle)

Definition at line 579 of file capi.cpp.

579  {
580  return handle->WordRecognitionLanguage();
581 }

◆ TessResultRendererAddImage()

TESS_API BOOL TessResultRendererAddImage ( TessResultRenderer renderer,
TessBaseAPI api 
)

Definition at line 98 of file capi.cpp.

98  {
99  return static_cast<int>(renderer->AddImage(api));
100 }

◆ TessResultRendererBeginDocument()

TESS_API BOOL TessResultRendererBeginDocument ( TessResultRenderer renderer,
const char *  title 
)

Definition at line 94 of file capi.cpp.

94  {
95  return static_cast<int>(renderer->BeginDocument(title));
96 }

◆ TessResultRendererEndDocument()

TESS_API BOOL TessResultRendererEndDocument ( TessResultRenderer renderer)

Definition at line 102 of file capi.cpp.

102  {
103  return static_cast<int>(renderer->EndDocument());
104 }

◆ TessResultRendererExtention()

TESS_API const char* TessResultRendererExtention ( TessResultRenderer renderer)

Definition at line 106 of file capi.cpp.

106  {
107  return renderer->file_extension();
108 }

◆ TessResultRendererImageNum()

TESS_API int TessResultRendererImageNum ( TessResultRenderer renderer)

Definition at line 114 of file capi.cpp.

114  {
115  return renderer->imagenum();
116 }

◆ TessResultRendererInsert()

TESS_API void TessResultRendererInsert ( TessResultRenderer renderer,
TessResultRenderer next 
)

Definition at line 86 of file capi.cpp.

86  {
87  renderer->insert(next);
88 }

◆ TessResultRendererNext()

TESS_API TessResultRenderer* TessResultRendererNext ( TessResultRenderer renderer)

Definition at line 90 of file capi.cpp.

90  {
91  return renderer->next();
92 }

◆ TessResultRendererTitle()

TESS_API const char* TessResultRendererTitle ( TessResultRenderer renderer)

Definition at line 110 of file capi.cpp.

110  {
111  return renderer->title();
112 }

◆ TessTextRendererCreate()

TESS_API TessResultRenderer* TessTextRendererCreate ( const char *  outputbase)

Definition at line 41 of file capi.cpp.

41  {
42  return new tesseract::TessTextRenderer(outputbase);
43 }

◆ TessTsvRendererCreate()

TESS_API TessResultRenderer* TessTsvRendererCreate ( const char *  outputbase)

Definition at line 57 of file capi.cpp.

57  {
58  return new tesseract::TessTsvRenderer(outputbase);
59 }

◆ TessUnlvRendererCreate()

TESS_API TessResultRenderer* TessUnlvRendererCreate ( const char *  outputbase)

Definition at line 66 of file capi.cpp.

66  {
67  return new tesseract::TessUnlvRenderer(outputbase);
68 }

◆ TessVersion()

TESS_API const char* TessVersion ( )

Definition at line 22 of file capi.cpp.

22  {
23  return TessBaseAPI::Version();
24 }

◆ TessWordStrBoxRendererCreate()

TESS_API TessResultRenderer* TessWordStrBoxRendererCreate ( const char *  outputbase)

Definition at line 74 of file capi.cpp.

74  {
75  return new tesseract::TessWordStrBoxRenderer(outputbase);
76 }