tesseract  4.00.00dev
Macros | Typedefs | Enumerations | Functions
capi.h File Reference
#include "baseapi.h"
#include "pageiterator.h"
#include "resultiterator.h"
#include "renderer.h"
#include "platform.h"
#include <stdio.h>

Go to the source code of this file.

Macros

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

Typedefs

typedef struct TessResultRenderer TessResultRenderer
 
typedef struct TessTextRenderer TessTextRenderer
 
typedef struct TessHOcrRenderer TessHOcrRenderer
 
typedef struct TessPDFRenderer TessPDFRenderer
 
typedef struct TessUnlvRenderer TessUnlvRenderer
 
typedef struct TessBoxTextRenderer TessBoxTextRenderer
 
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
 

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_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 *TESS_CALL TessVersion ()
 
TESS_API void TESS_CALL TessDeleteText (char *text)
 
TESS_API void TESS_CALL TessDeleteTextArray (char **arr)
 
TESS_API void TESS_CALL TessDeleteIntArray (int *arr)
 
TESS_API TessResultRenderer *TESS_CALL TessTextRendererCreate (const char *outputbase)
 
TESS_API TessResultRenderer *TESS_CALL TessHOcrRendererCreate (const char *outputbase)
 
TESS_API TessResultRenderer *TESS_CALL TessHOcrRendererCreate2 (const char *outputbase, BOOL font_info)
 
TESS_API TessResultRenderer *TESS_CALL TessPDFRendererCreate (const char *outputbase, const char *datadir, BOOL textonly)
 
TESS_API TessResultRenderer *TESS_CALL TessUnlvRendererCreate (const char *outputbase)
 
TESS_API TessResultRenderer *TESS_CALL TessBoxTextRendererCreate (const char *outputbase)
 
TESS_API void TESS_CALL TessDeleteResultRenderer (TessResultRenderer *renderer)
 
TESS_API void TESS_CALL TessResultRendererInsert (TessResultRenderer *renderer, TessResultRenderer *next)
 
TESS_API TessResultRenderer *TESS_CALL TessResultRendererNext (TessResultRenderer *renderer)
 
TESS_API BOOL TESS_CALL TessResultRendererBeginDocument (TessResultRenderer *renderer, const char *title)
 
TESS_API BOOL TESS_CALL TessResultRendererAddImage (TessResultRenderer *renderer, TessBaseAPI *api)
 
TESS_API BOOL TESS_CALL TessResultRendererEndDocument (TessResultRenderer *renderer)
 
TESS_API const char *TESS_CALL TessResultRendererExtention (TessResultRenderer *renderer)
 
TESS_API const char *TESS_CALL TessResultRendererTitle (TessResultRenderer *renderer)
 
TESS_API int TESS_CALL TessResultRendererImageNum (TessResultRenderer *renderer)
 
TESS_API TessBaseAPI *TESS_CALL TessBaseAPICreate ()
 
TESS_API void TESS_CALL TessBaseAPIDelete (TessBaseAPI *handle)
 
TESS_API size_t TESS_CALL TessBaseAPIGetOpenCLDevice (TessBaseAPI *handle, void **device)
 
TESS_API void TESS_CALL TessBaseAPISetInputName (TessBaseAPI *handle, const char *name)
 
TESS_API const char *TESS_CALL TessBaseAPIGetInputName (TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPISetInputImage (TessBaseAPI *handle, struct Pix *pix)
 
TESS_API struct Pix *TESS_CALL TessBaseAPIGetInputImage (TessBaseAPI *handle)
 
TESS_API int TESS_CALL TessBaseAPIGetSourceYResolution (TessBaseAPI *handle)
 
TESS_API const char *TESS_CALL TessBaseAPIGetDatapath (TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPISetOutputName (TessBaseAPI *handle, const char *name)
 
TESS_API BOOL TESS_CALL TessBaseAPISetVariable (TessBaseAPI *handle, const char *name, const char *value)
 
TESS_API BOOL TESS_CALL TessBaseAPISetDebugVariable (TessBaseAPI *handle, const char *name, const char *value)
 
TESS_API BOOL TESS_CALL TessBaseAPIGetIntVariable (const TessBaseAPI *handle, const char *name, int *value)
 
TESS_API BOOL TESS_CALL TessBaseAPIGetBoolVariable (const TessBaseAPI *handle, const char *name, BOOL *value)
 
TESS_API BOOL TESS_CALL TessBaseAPIGetDoubleVariable (const TessBaseAPI *handle, const char *name, double *value)
 
TESS_API const char *TESS_CALL TessBaseAPIGetStringVariable (const TessBaseAPI *handle, const char *name)
 
TESS_API void TESS_CALL TessBaseAPIPrintVariables (const TessBaseAPI *handle, FILE *fp)
 
TESS_API BOOL TESS_CALL TessBaseAPIPrintVariablesToFile (const TessBaseAPI *handle, const char *filename)
 
TESS_API int TESS_CALL TessBaseAPIInit1 (TessBaseAPI *handle, const char *datapath, const char *language, TessOcrEngineMode oem, char **configs, int configs_size)
 
TESS_API int TESS_CALL TessBaseAPIInit2 (TessBaseAPI *handle, const char *datapath, const char *language, TessOcrEngineMode oem)
 
TESS_API int TESS_CALL TessBaseAPIInit3 (TessBaseAPI *handle, const char *datapath, const char *language)
 
TESS_API int TESS_CALL 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 *TESS_CALL TessBaseAPIGetInitLanguagesAsString (const TessBaseAPI *handle)
 
TESS_API char **TESS_CALL TessBaseAPIGetLoadedLanguagesAsVector (const TessBaseAPI *handle)
 
TESS_API char **TESS_CALL TessBaseAPIGetAvailableLanguagesAsVector (const TessBaseAPI *handle)
 
TESS_API int TESS_CALL TessBaseAPIInitLangMod (TessBaseAPI *handle, const char *datapath, const char *language)
 
TESS_API void TESS_CALL TessBaseAPIInitForAnalysePage (TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPIReadConfigFile (TessBaseAPI *handle, const char *filename)
 
TESS_API void TESS_CALL TessBaseAPIReadDebugConfigFile (TessBaseAPI *handle, const char *filename)
 
TESS_API void TESS_CALL TessBaseAPISetPageSegMode (TessBaseAPI *handle, TessPageSegMode mode)
 
TESS_API TessPageSegMode TESS_CALL TessBaseAPIGetPageSegMode (const TessBaseAPI *handle)
 
TESS_API char *TESS_CALL 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 TESS_CALL TessBaseAPIClearAdaptiveClassifier (TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPISetImage (TessBaseAPI *handle, const unsigned char *imagedata, int width, int height, int bytes_per_pixel, int bytes_per_line)
 
TESS_API void TESS_CALL TessBaseAPISetImage2 (TessBaseAPI *handle, struct Pix *pix)
 
TESS_API void TESS_CALL TessBaseAPISetSourceResolution (TessBaseAPI *handle, int ppi)
 
TESS_API void TESS_CALL TessBaseAPISetRectangle (TessBaseAPI *handle, int left, int top, int width, int height)
 
TESS_API struct Pix *TESS_CALL TessBaseAPIGetThresholdedImage (TessBaseAPI *handle)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetRegions (TessBaseAPI *handle, struct Pixa **pixa)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetTextlines (TessBaseAPI *handle, struct Pixa **pixa, int **blockids)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetTextlines1 (TessBaseAPI *handle, const BOOL raw_image, const int raw_padding, struct Pixa **pixa, int **blockids, int **paraids)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetStrips (TessBaseAPI *handle, struct Pixa **pixa, int **blockids)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetWords (TessBaseAPI *handle, struct Pixa **pixa)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetConnectedComponents (TessBaseAPI *handle, struct Pixa **cc)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetComponentImages (TessBaseAPI *handle, const TessPageIteratorLevel level, const BOOL text_only, struct Pixa **pixa, int **blockids)
 
TESS_API struct Boxa *TESS_CALL TessBaseAPIGetComponentImages1 (TessBaseAPI *handle, const TessPageIteratorLevel level, const BOOL text_only, const BOOL raw_image, const int raw_padding, struct Pixa **pixa, int **blockids, int **paraids)
 
TESS_API int TESS_CALL TessBaseAPIGetThresholdedImageScaleFactor (const TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPIDumpPGM (TessBaseAPI *handle, const char *filename)
 
TESS_API TessPageIterator *TESS_CALL TessBaseAPIAnalyseLayout (TessBaseAPI *handle)
 
TESS_API int TESS_CALL TessBaseAPIRecognize (TessBaseAPI *handle, ETEXT_DESC *monitor)
 
TESS_API int TESS_CALL TessBaseAPIRecognizeForChopTest (TessBaseAPI *handle, ETEXT_DESC *monitor)
 
TESS_API BOOL TESS_CALL TessBaseAPIProcessPages (TessBaseAPI *handle, const char *filename, const char *retry_config, int timeout_millisec, TessResultRenderer *renderer)
 
TESS_API BOOL TESS_CALL TessBaseAPIProcessPage (TessBaseAPI *handle, struct Pix *pix, int page_index, const char *filename, const char *retry_config, int timeout_millisec, TessResultRenderer *renderer)
 
TESS_API TessResultIterator *TESS_CALL TessBaseAPIGetIterator (TessBaseAPI *handle)
 
TESS_API TessMutableIterator *TESS_CALL TessBaseAPIGetMutableIterator (TessBaseAPI *handle)
 
TESS_API char *TESS_CALL TessBaseAPIGetUTF8Text (TessBaseAPI *handle)
 
TESS_API char *TESS_CALL TessBaseAPIGetHOCRText (TessBaseAPI *handle, int page_number)
 
TESS_API char *TESS_CALL TessBaseAPIGetBoxText (TessBaseAPI *handle, int page_number)
 
TESS_API char *TESS_CALL TessBaseAPIGetUNLVText (TessBaseAPI *handle)
 
TESS_API int TESS_CALL TessBaseAPIMeanTextConf (TessBaseAPI *handle)
 
TESS_API int *TESS_CALL TessBaseAPIAllWordConfidences (TessBaseAPI *handle)
 
TESS_API BOOL TESS_CALL TessBaseAPIAdaptToWordStr (TessBaseAPI *handle, TessPageSegMode mode, const char *wordstr)
 
TESS_API void TESS_CALL TessBaseAPIClear (TessBaseAPI *handle)
 
TESS_API void TESS_CALL TessBaseAPIEnd (TessBaseAPI *handle)
 
TESS_API int TESS_CALL TessBaseAPIIsValidWord (TessBaseAPI *handle, const char *word)
 
TESS_API BOOL TESS_CALL TessBaseAPIGetTextDirection (TessBaseAPI *handle, int *out_offset, float *out_slope)
 
TESS_API const char *TESS_CALL TessBaseAPIGetUnichar (TessBaseAPI *handle, int unichar_id)
 
TESS_API void TESS_CALL TessBaseAPISetMinOrientationMargin (TessBaseAPI *handle, double margin)
 
TESS_API void TESS_CALL TessPageIteratorDelete (TessPageIterator *handle)
 
TESS_API TessPageIterator *TESS_CALL TessPageIteratorCopy (const TessPageIterator *handle)
 
TESS_API void TESS_CALL TessPageIteratorBegin (TessPageIterator *handle)
 
TESS_API BOOL TESS_CALL TessPageIteratorNext (TessPageIterator *handle, TessPageIteratorLevel level)
 
TESS_API BOOL TESS_CALL TessPageIteratorIsAtBeginningOf (const TessPageIterator *handle, TessPageIteratorLevel level)
 
TESS_API BOOL TESS_CALL TessPageIteratorIsAtFinalElement (const TessPageIterator *handle, TessPageIteratorLevel level, TessPageIteratorLevel element)
 
TESS_API BOOL TESS_CALL TessPageIteratorBoundingBox (const TessPageIterator *handle, TessPageIteratorLevel level, int *left, int *top, int *right, int *bottom)
 
TESS_API TessPolyBlockType TESS_CALL TessPageIteratorBlockType (const TessPageIterator *handle)
 
TESS_API struct Pix *TESS_CALL TessPageIteratorGetBinaryImage (const TessPageIterator *handle, TessPageIteratorLevel level)
 
TESS_API struct Pix *TESS_CALL TessPageIteratorGetImage (const TessPageIterator *handle, TessPageIteratorLevel level, int padding, struct Pix *original_image, int *left, int *top)
 
TESS_API BOOL TESS_CALL TessPageIteratorBaseline (const TessPageIterator *handle, TessPageIteratorLevel level, int *x1, int *y1, int *x2, int *y2)
 
TESS_API void TESS_CALL TessPageIteratorOrientation (TessPageIterator *handle, TessOrientation *orientation, TessWritingDirection *writing_direction, TessTextlineOrder *textline_order, float *deskew_angle)
 
TESS_API void TESS_CALL TessPageIteratorParagraphInfo (TessPageIterator *handle, TessParagraphJustification *justification, BOOL *is_list_item, BOOL *is_crown, int *first_line_indent)
 
TESS_API void TESS_CALL TessResultIteratorDelete (TessResultIterator *handle)
 
TESS_API TessResultIterator *TESS_CALL TessResultIteratorCopy (const TessResultIterator *handle)
 
TESS_API TessPageIterator *TESS_CALL TessResultIteratorGetPageIterator (TessResultIterator *handle)
 
TESS_API const TessPageIterator *TESS_CALL TessResultIteratorGetPageIteratorConst (const TessResultIterator *handle)
 
TESS_API TessChoiceIterator *TESS_CALL TessResultIteratorGetChoiceIterator (const TessResultIterator *handle)
 
TESS_API BOOL TESS_CALL TessResultIteratorNext (TessResultIterator *handle, TessPageIteratorLevel level)
 
TESS_API char *TESS_CALL TessResultIteratorGetUTF8Text (const TessResultIterator *handle, TessPageIteratorLevel level)
 
TESS_API float TESS_CALL TessResultIteratorConfidence (const TessResultIterator *handle, TessPageIteratorLevel level)
 
TESS_API const char *TESS_CALL TessResultIteratorWordRecognitionLanguage (const TessResultIterator *handle)
 
TESS_API const char *TESS_CALL 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 TESS_CALL TessResultIteratorWordIsFromDictionary (const TessResultIterator *handle)
 
TESS_API BOOL TESS_CALL TessResultIteratorWordIsNumeric (const TessResultIterator *handle)
 
TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsSuperscript (const TessResultIterator *handle)
 
TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsSubscript (const TessResultIterator *handle)
 
TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsDropcap (const TessResultIterator *handle)
 
TESS_API void TESS_CALL TessChoiceIteratorDelete (TessChoiceIterator *handle)
 
TESS_API BOOL TESS_CALL TessChoiceIteratorNext (TessChoiceIterator *handle)
 
TESS_API const char *TESS_CALL TessChoiceIteratorGetUTF8Text (const TessChoiceIterator *handle)
 
TESS_API float TESS_CALL TessChoiceIteratorConfidence (const TessChoiceIterator *handle)
 

Macro Definition Documentation

◆ BOOL

#define BOOL   int

Definition at line 44 of file capi.h.

◆ FALSE

#define FALSE   0

Definition at line 46 of file capi.h.

◆ TESS_CALL

#define TESS_CALL

Definition at line 39 of file capi.h.

◆ TRUE

#define TRUE   1

Definition at line 45 of file capi.h.

Typedef Documentation

◆ ETEXT_DESC

typedef struct ETEXT_DESC ETEXT_DESC

Definition at line 100 of file capi.h.

◆ TessBaseAPI

typedef struct TessBaseAPI TessBaseAPI

Definition at line 83 of file capi.h.

◆ TessBoxTextRenderer

typedef struct TessBoxTextRenderer TessBoxTextRenderer

Definition at line 82 of file capi.h.

◆ TessChoiceIterator

typedef struct TessChoiceIterator TessChoiceIterator

Definition at line 87 of file capi.h.

◆ TessHOcrRenderer

typedef struct TessHOcrRenderer TessHOcrRenderer

Definition at line 79 of file capi.h.

◆ TessMutableIterator

typedef struct TessMutableIterator TessMutableIterator

Definition at line 86 of file capi.h.

◆ TessOcrEngineMode

typedef enum TessOcrEngineMode TessOcrEngineMode

◆ TessOrientation

typedef enum TessOrientation TessOrientation

◆ TessPageIterator

typedef struct TessPageIterator TessPageIterator

Definition at line 84 of file capi.h.

◆ TessPageIteratorLevel

typedef enum TessPageIteratorLevel TessPageIteratorLevel

◆ TessPageSegMode

typedef enum TessPageSegMode TessPageSegMode

◆ TessParagraphJustification

typedef enum TessParagraphJustification TessParagraphJustification

◆ TessPDFRenderer

typedef struct TessPDFRenderer TessPDFRenderer

Definition at line 80 of file capi.h.

◆ TessPolyBlockType

typedef enum TessPolyBlockType TessPolyBlockType

◆ TessResultIterator

typedef struct TessResultIterator TessResultIterator

Definition at line 85 of file capi.h.

◆ TessResultRenderer

typedef struct TessResultRenderer TessResultRenderer

Definition at line 77 of file capi.h.

◆ TessTextlineOrder

typedef enum TessTextlineOrder TessTextlineOrder

◆ TessTextRenderer

typedef struct TessTextRenderer TessTextRenderer

Definition at line 78 of file capi.h.

◆ TessUnlvRenderer

typedef struct TessUnlvRenderer TessUnlvRenderer

Definition at line 81 of file capi.h.

◆ TessWritingDirection

typedef enum TessWritingDirection TessWritingDirection

Enumeration Type Documentation

◆ TessOcrEngineMode

enum TessOcrEngineMode
Enumerator
OEM_TESSERACT_ONLY 
OEM_LSTM_ONLY 
OEM_TESSERACT_LSTM_COMBINED 
OEM_DEFAULT 

Definition at line 88 of file capi.h.

88 { OEM_TESSERACT_ONLY, OEM_LSTM_ONLY, OEM_TESSERACT_LSTM_COMBINED, OEM_DEFAULT } TessOcrEngineMode;
TessOcrEngineMode
TessOcrEngineMode
Definition: capi.h:88

◆ TessOrientation

enum TessOrientation
Enumerator
ORIENTATION_PAGE_UP 
ORIENTATION_PAGE_RIGHT 
ORIENTATION_PAGE_DOWN 
ORIENTATION_PAGE_LEFT 

Definition at line 96 of file capi.h.

96 { ORIENTATION_PAGE_UP, ORIENTATION_PAGE_RIGHT, ORIENTATION_PAGE_DOWN, ORIENTATION_PAGE_LEFT } TessOrientation;
TessOrientation
TessOrientation
Definition: capi.h:96

◆ TessPageIteratorLevel

enum TessPageIteratorLevel
Enumerator
RIL_BLOCK 
RIL_PARA 
RIL_TEXTLINE 
RIL_WORD 
RIL_SYMBOL 

Definition at line 92 of file capi.h.

92 { RIL_BLOCK, RIL_PARA, RIL_TEXTLINE, RIL_WORD, RIL_SYMBOL} TessPageIteratorLevel;
TessPageIteratorLevel
TessPageIteratorLevel
Definition: capi.h:92
RIL_WORD
Definition: capi.h:92
RIL_PARA
Definition: capi.h:92
RIL_BLOCK
Definition: capi.h:92

◆ TessPageSegMode

enum 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_COUNT 

Definition at line 89 of file capi.h.

89  { PSM_OSD_ONLY, PSM_AUTO_OSD, PSM_AUTO_ONLY, PSM_AUTO, PSM_SINGLE_COLUMN, PSM_SINGLE_BLOCK_VERT_TEXT,
90  PSM_SINGLE_BLOCK, PSM_SINGLE_LINE, PSM_SINGLE_WORD, PSM_CIRCLE_WORD, PSM_SINGLE_CHAR, PSM_SPARSE_TEXT,
91  PSM_SPARSE_TEXT_OSD, PSM_COUNT } TessPageSegMode;
TessPageSegMode
TessPageSegMode
Definition: capi.h:89
PSM_AUTO
Definition: capi.h:89
PSM_COUNT
Definition: capi.h:91

◆ TessParagraphJustification

enum TessParagraphJustification
Enumerator
JUSTIFICATION_UNKNOWN 
JUSTIFICATION_LEFT 
JUSTIFICATION_CENTER 
JUSTIFICATION_RIGHT 

Definition at line 97 of file capi.h.

97 { JUSTIFICATION_UNKNOWN, JUSTIFICATION_LEFT, JUSTIFICATION_CENTER, JUSTIFICATION_RIGHT } TessParagraphJustification;
TessParagraphJustification
TessParagraphJustification
Definition: capi.h:97

◆ TessPolyBlockType

enum 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 93 of file capi.h.

93  { PT_UNKNOWN, PT_FLOWING_TEXT, PT_HEADING_TEXT, PT_PULLOUT_TEXT, PT_EQUATION, PT_INLINE_EQUATION,
94  PT_TABLE, PT_VERTICAL_TEXT, PT_CAPTION_TEXT, PT_FLOWING_IMAGE, PT_HEADING_IMAGE,
95  PT_PULLOUT_IMAGE, PT_HORZ_LINE, PT_VERT_LINE, PT_NOISE, PT_COUNT } TessPolyBlockType;
PT_NOISE
Definition: capi.h:95
TessPolyBlockType
TessPolyBlockType
Definition: capi.h:93
PT_TABLE
Definition: capi.h:94
PT_COUNT
Definition: capi.h:95

◆ TessTextlineOrder

enum TessTextlineOrder
Enumerator
TEXTLINE_ORDER_LEFT_TO_RIGHT 
TEXTLINE_ORDER_RIGHT_TO_LEFT 
TEXTLINE_ORDER_TOP_TO_BOTTOM 

Definition at line 99 of file capi.h.

99 { TEXTLINE_ORDER_LEFT_TO_RIGHT, TEXTLINE_ORDER_RIGHT_TO_LEFT, TEXTLINE_ORDER_TOP_TO_BOTTOM } TessTextlineOrder;
TessTextlineOrder
TessTextlineOrder
Definition: capi.h:99

◆ TessWritingDirection

enum TessWritingDirection
Enumerator
WRITING_DIRECTION_LEFT_TO_RIGHT 
WRITING_DIRECTION_RIGHT_TO_LEFT 
WRITING_DIRECTION_TOP_TO_BOTTOM 

Definition at line 98 of file capi.h.

98 { WRITING_DIRECTION_LEFT_TO_RIGHT, WRITING_DIRECTION_RIGHT_TO_LEFT, WRITING_DIRECTION_TOP_TO_BOTTOM } TessWritingDirection;
TessWritingDirection
TessWritingDirection
Definition: capi.h:98

Function Documentation

◆ TessBaseAPIAdaptToWordStr()

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

Definition at line 500 of file capi.cpp.

501 {
502  return handle->AdaptToWordStr(mode, wordstr) ? TRUE : FALSE;
503 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46
mode
const char int mode
Definition: ioapi.h:38

◆ TessBaseAPIAllWordConfidences()

TESS_API int* TESS_CALL TessBaseAPIAllWordConfidences ( TessBaseAPI *  handle)

Definition at line 495 of file capi.cpp.

496 {
497  return handle->AllWordConfidences();
498 }

◆ TessBaseAPIAnalyseLayout()

TESS_API TessPageIterator* TESS_CALL TessBaseAPIAnalyseLayout ( TessBaseAPI *  handle)

Definition at line 427 of file capi.cpp.

428 {
429  return handle->AnalyseLayout();
430 }

◆ TessBaseAPIClear()

TESS_API void TESS_CALL TessBaseAPIClear ( TessBaseAPI *  handle)

Definition at line 505 of file capi.cpp.

506 {
507  handle->Clear();
508 }

◆ TessBaseAPIClearAdaptiveClassifier()

TESS_API void TESS_CALL TessBaseAPIClearAdaptiveClassifier ( TessBaseAPI *  handle)

Definition at line 337 of file capi.cpp.

338 {
339  handle->ClearAdaptiveClassifier();
340 }

◆ TessBaseAPICreate()

TESS_API TessBaseAPI* TESS_CALL TessBaseAPICreate ( )

Definition at line 128 of file capi.cpp.

129 {
130  return new TessBaseAPI;
131 }
TessBaseAPI
struct TessBaseAPI TessBaseAPI
Definition: capi.h:83

◆ TessBaseAPIDelete()

TESS_API void TESS_CALL TessBaseAPIDelete ( TessBaseAPI *  handle)

Definition at line 133 of file capi.cpp.

134 {
135  delete handle;
136 }

◆ TessBaseAPIDumpPGM()

TESS_API void TESS_CALL TessBaseAPIDumpPGM ( TessBaseAPI *  handle,
const char *  filename 
)

Definition at line 422 of file capi.cpp.

423 {
424  handle->DumpPGM(filename);
425 }
filename
const char * filename
Definition: ioapi.h:38

◆ TessBaseAPIEnd()

TESS_API void TESS_CALL TessBaseAPIEnd ( TessBaseAPI *  handle)

Definition at line 510 of file capi.cpp.

511 {
512  handle->End();
513 }

◆ TessBaseAPIGetAvailableLanguagesAsVector()

TESS_API char** TESS_CALL TessBaseAPIGetAvailableLanguagesAsVector ( const TessBaseAPI *  handle)

Definition at line 289 of file capi.cpp.

290 {
291  GenericVector<STRING> languages;
292  handle->GetAvailableLanguagesAsVector(&languages);
293  char** arr = new char*[languages.size() + 1];
294  for (int index = 0; index < languages.size(); ++index)
295  arr[index] = languages[index].strdup();
296  arr[languages.size()] = NULL;
297  return arr;
298 }
GenericVector::size
int size() const
Definition: genericvector.h:72

◆ TessBaseAPIGetBoolVariable()

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

Definition at line 193 of file capi.cpp.

194 {
195  bool boolValue;
196  if (handle->GetBoolVariable(name, &boolValue))
197  {
198  *value = boolValue ? TRUE : FALSE;
199  return TRUE;
200  }
201  else
202  {
203  return FALSE;
204  }
205 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessBaseAPIGetBoxText()

TESS_API char* TESS_CALL TessBaseAPIGetBoxText ( TessBaseAPI *  handle,
int  page_number 
)

Definition at line 480 of file capi.cpp.

481 {
482  return handle->GetBoxText(page_number);
483 }

◆ TessBaseAPIGetComponentImages()

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

Definition at line 404 of file capi.cpp.

405 {
406  return handle->GetComponentImages(level, text_only != FALSE, pixa, blockids);
407 }
FALSE
#define FALSE
Definition: capi.h:46

◆ TessBaseAPIGetComponentImages1()

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

Definition at line 410 of file capi.cpp.

413 {
414  return handle->GetComponentImages(level, text_only != FALSE, raw_image, raw_padding, pixa, blockids, paraids);
415 }
FALSE
#define FALSE
Definition: capi.h:46

◆ TessBaseAPIGetConnectedComponents()

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

Definition at line 399 of file capi.cpp.

400 {
401  return handle->GetConnectedComponents(cc);
402 }

◆ TessBaseAPIGetDatapath()

TESS_API const char* TESS_CALL TessBaseAPIGetDatapath ( TessBaseAPI *  handle)

Definition at line 168 of file capi.cpp.

169 {
170  return handle->GetDatapath();
171 }

◆ TessBaseAPIGetDoubleVariable()

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

Definition at line 207 of file capi.cpp.

208 {
209  return handle->GetDoubleVariable(name, value) ? TRUE : FALSE;
210 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessBaseAPIGetHOCRText()

TESS_API char* TESS_CALL TessBaseAPIGetHOCRText ( TessBaseAPI *  handle,
int  page_number 
)

Definition at line 475 of file capi.cpp.

476 {
477  return handle->GetHOCRText(NULL, page_number);
478 }

◆ TessBaseAPIGetInitLanguagesAsString()

TESS_API const char* TESS_CALL TessBaseAPIGetInitLanguagesAsString ( const TessBaseAPI *  handle)

Definition at line 273 of file capi.cpp.

274 {
275  return handle->GetInitLanguagesAsString();
276 }

◆ TessBaseAPIGetInputImage()

TESS_API struct Pix* TESS_CALL TessBaseAPIGetInputImage ( TessBaseAPI *  handle)

Definition at line 158 of file capi.cpp.

159 {
160  return handle->GetInputImage();
161 }

◆ TessBaseAPIGetInputName()

TESS_API const char* TESS_CALL TessBaseAPIGetInputName ( TessBaseAPI *  handle)

Definition at line 148 of file capi.cpp.

149 {
150  return handle->GetInputName();
151 }

◆ TessBaseAPIGetIntVariable()

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

Definition at line 188 of file capi.cpp.

189 {
190  return handle->GetIntVariable(name, value) ? TRUE : FALSE;
191 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessBaseAPIGetIterator()

TESS_API TessResultIterator* TESS_CALL TessBaseAPIGetIterator ( TessBaseAPI *  handle)

Definition at line 460 of file capi.cpp.

461 {
462  return handle->GetIterator();
463 }

◆ TessBaseAPIGetLoadedLanguagesAsVector()

TESS_API char** TESS_CALL TessBaseAPIGetLoadedLanguagesAsVector ( const TessBaseAPI *  handle)

Definition at line 278 of file capi.cpp.

279 {
280  GenericVector<STRING> languages;
281  handle->GetLoadedLanguagesAsVector(&languages);
282  char** arr = new char*[languages.size() + 1];
283  for (int index = 0; index < languages.size(); ++index)
284  arr[index] = languages[index].strdup();
285  arr[languages.size()] = NULL;
286  return arr;
287 }
GenericVector::size
int size() const
Definition: genericvector.h:72

◆ TessBaseAPIGetMutableIterator()

TESS_API TessMutableIterator* TESS_CALL TessBaseAPIGetMutableIterator ( TessBaseAPI *  handle)

Definition at line 465 of file capi.cpp.

466 {
467  return handle->GetMutableIterator();
468 }

◆ TessBaseAPIGetOpenCLDevice()

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

Definition at line 138 of file capi.cpp.

139 {
140  return handle->getOpenCLDevice(device);
141 }

◆ TessBaseAPIGetPageSegMode()

TESS_API TessPageSegMode TESS_CALL TessBaseAPIGetPageSegMode ( const TessBaseAPI *  handle)

Definition at line 325 of file capi.cpp.

326 {
327  return handle->GetPageSegMode();
328 }

◆ TessBaseAPIGetRegions()

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

Definition at line 373 of file capi.cpp.

374 {
375  return handle->GetRegions(pixa);
376 }

◆ TessBaseAPIGetSourceYResolution()

TESS_API int TESS_CALL TessBaseAPIGetSourceYResolution ( TessBaseAPI *  handle)

Definition at line 163 of file capi.cpp.

164 {
165  return handle->GetSourceYResolution();
166 }

◆ TessBaseAPIGetStringVariable()

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

Definition at line 212 of file capi.cpp.

213 {
214  return handle->GetStringVariable(name);
215 }

◆ TessBaseAPIGetStrips()

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

Definition at line 389 of file capi.cpp.

390 {
391  return handle->GetStrips(pixa, blockids);
392 }

◆ TessBaseAPIGetTextDirection()

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

Definition at line 520 of file capi.cpp.

521 {
522  return handle->GetTextDirection(out_offset, out_slope) ? TRUE : FALSE;
523 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessBaseAPIGetTextlines()

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

Definition at line 378 of file capi.cpp.

379 {
380  return handle->GetTextlines(pixa, blockids);
381 }

◆ TessBaseAPIGetTextlines1()

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

Definition at line 383 of file capi.cpp.

385 {
386  return handle->GetTextlines(raw_image, raw_padding, pixa, blockids, paraids);
387 }

◆ TessBaseAPIGetThresholdedImage()

TESS_API struct Pix* TESS_CALL TessBaseAPIGetThresholdedImage ( TessBaseAPI *  handle)

Definition at line 368 of file capi.cpp.

369 {
370  return handle->GetThresholdedImage();
371 }

◆ TessBaseAPIGetThresholdedImageScaleFactor()

TESS_API int TESS_CALL TessBaseAPIGetThresholdedImageScaleFactor ( const TessBaseAPI *  handle)

Definition at line 417 of file capi.cpp.

418 {
419  return handle->GetThresholdedImageScaleFactor();
420 }

◆ TessBaseAPIGetUnichar()

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

Definition at line 571 of file capi.cpp.

572 {
573  return handle->GetUnichar(unichar_id);
574 }

◆ TessBaseAPIGetUNLVText()

TESS_API char* TESS_CALL TessBaseAPIGetUNLVText ( TessBaseAPI *  handle)

Definition at line 485 of file capi.cpp.

486 {
487  return handle->GetUNLVText();
488 }

◆ TessBaseAPIGetUTF8Text()

TESS_API char* TESS_CALL TessBaseAPIGetUTF8Text ( TessBaseAPI *  handle)

Definition at line 470 of file capi.cpp.

471 {
472  return handle->GetUTF8Text();
473 }

◆ TessBaseAPIGetWords()

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

Definition at line 394 of file capi.cpp.

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

◆ TessBaseAPIInit1()

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

Definition at line 257 of file capi.cpp.

259 {
260  return handle->Init(datapath, language, oem, configs, configs_size, NULL, NULL, false);
261 }

◆ TessBaseAPIInit2()

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

Definition at line 263 of file capi.cpp.

264 {
265  return handle->Init(datapath, language, oem);
266 }

◆ TessBaseAPIInit3()

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

Definition at line 268 of file capi.cpp.

269 {
270  return handle->Init(datapath, language);
271 }

◆ TessBaseAPIInit4()

TESS_API int TESS_CALL 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 239 of file capi.cpp.

243 {
244  GenericVector<STRING> varNames;
245  GenericVector<STRING> varValues;
246  if (vars_vec != NULL && vars_values != NULL) {
247  for (size_t i = 0; i < vars_vec_size; i++) {
248  varNames.push_back(STRING(vars_vec[i]));
249  varValues.push_back(STRING(vars_values[i]));
250  }
251  }
252 
253  return handle->Init(datapath, language, mode, configs, configs_size, &varNames, &varValues, set_only_non_debug_params);
254 }
GenericVector::push_back
int push_back(T object)
Definition: genericvector.h:787
STRING
Definition: strngs.h:45
mode
const char int mode
Definition: ioapi.h:38

◆ TessBaseAPIInitForAnalysePage()

TESS_API void TESS_CALL TessBaseAPIInitForAnalysePage ( TessBaseAPI *  handle)

Definition at line 305 of file capi.cpp.

306 {
307  handle->InitForAnalysePage();
308 }

◆ TessBaseAPIInitLangMod()

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

Definition at line 300 of file capi.cpp.

301 {
302  return handle->InitLangMod(datapath, language);
303 }

◆ TessBaseAPIIsValidWord()

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

Definition at line 515 of file capi.cpp.

516 {
517  return handle->IsValidWord(word);
518 }

◆ TessBaseAPIMeanTextConf()

TESS_API int TESS_CALL TessBaseAPIMeanTextConf ( TessBaseAPI *  handle)

Definition at line 490 of file capi.cpp.

491 {
492  return handle->MeanTextConf();
493 }

◆ TessBaseAPIPrintVariables()

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

Definition at line 217 of file capi.cpp.

218 {
219  handle->PrintVariables(fp);
220 }

◆ TessBaseAPIPrintVariablesToFile()

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

Definition at line 222 of file capi.cpp.

223 {
224  FILE* fp = fopen(filename, "w");
225  if (fp != NULL)
226  {
227  handle->PrintVariables(fp);
228  fclose(fp);
229  return TRUE;
230  }
231  return FALSE;
232 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46
filename
const char * filename
Definition: ioapi.h:38

◆ TessBaseAPIProcessPage()

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

Definition at line 451 of file capi.cpp.

453 {
454  if (handle->ProcessPage(pix, page_index, filename, retry_config, timeout_millisec, renderer))
455  return TRUE;
456  else
457  return FALSE;
458 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46
filename
const char * filename
Definition: ioapi.h:38

◆ TessBaseAPIProcessPages()

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

Definition at line 442 of file capi.cpp.

444 {
445  if (handle->ProcessPages(filename, retry_config, timeout_millisec, renderer))
446  return TRUE;
447  else
448  return FALSE;
449 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46
filename
const char * filename
Definition: ioapi.h:38

◆ TessBaseAPIReadConfigFile()

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

Definition at line 310 of file capi.cpp.

311 {
312  handle->ReadConfigFile(filename);
313 }
filename
const char * filename
Definition: ioapi.h:38

◆ TessBaseAPIReadDebugConfigFile()

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

Definition at line 315 of file capi.cpp.

316 {
317  handle->ReadDebugConfigFile(filename);
318 }
filename
const char * filename
Definition: ioapi.h:38

◆ TessBaseAPIRecognize()

TESS_API int TESS_CALL TessBaseAPIRecognize ( TessBaseAPI *  handle,
ETEXT_DESC *  monitor 
)

Definition at line 432 of file capi.cpp.

433 {
434  return handle->Recognize(monitor);
435 }

◆ TessBaseAPIRecognizeForChopTest()

TESS_API int TESS_CALL TessBaseAPIRecognizeForChopTest ( TessBaseAPI *  handle,
ETEXT_DESC *  monitor 
)

Definition at line 437 of file capi.cpp.

438 {
439  return handle->RecognizeForChopTest(monitor);
440 }

◆ TessBaseAPIRect()

TESS_API char* TESS_CALL 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 330 of file capi.cpp.

333 {
334  return handle->TesseractRect(imagedata, bytes_per_pixel, bytes_per_line, left, top, width, height);
335 }

◆ TessBaseAPISetDebugVariable()

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

Definition at line 183 of file capi.cpp.

184 {
185  return handle->SetVariable(name, value) ? TRUE : FALSE;
186 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessBaseAPISetImage()

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

Definition at line 342 of file capi.cpp.

344 {
345  handle->SetImage(imagedata, width, height, bytes_per_pixel, bytes_per_line);
346 }

◆ TessBaseAPISetImage2()

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

Definition at line 348 of file capi.cpp.

349 {
350  return handle->SetImage(pix);
351 }

◆ TessBaseAPISetInputImage()

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

Definition at line 153 of file capi.cpp.

154 {
155  handle->SetInputImage(pix);
156 }

◆ TessBaseAPISetInputName()

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

Definition at line 143 of file capi.cpp.

144 {
145  handle->SetInputName(name);
146 }

◆ TessBaseAPISetMinOrientationMargin()

TESS_API void TESS_CALL TessBaseAPISetMinOrientationMargin ( TessBaseAPI *  handle,
double  margin 
)

Definition at line 611 of file capi.cpp.

612 {
613  handle->set_min_orientation_margin(margin);
614 }

◆ TessBaseAPISetOutputName()

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

Definition at line 173 of file capi.cpp.

174 {
175  handle->SetOutputName(name);
176 }

◆ TessBaseAPISetPageSegMode()

TESS_API void TESS_CALL TessBaseAPISetPageSegMode ( TessBaseAPI *  handle,
TessPageSegMode  mode 
)

Definition at line 320 of file capi.cpp.

321 {
322  handle->SetPageSegMode(mode);
323 }
mode
const char int mode
Definition: ioapi.h:38

◆ TessBaseAPISetRectangle()

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

Definition at line 358 of file capi.cpp.

359 {
360  handle->SetRectangle(left, top, width, height);
361 }

◆ TessBaseAPISetSourceResolution()

TESS_API void TESS_CALL TessBaseAPISetSourceResolution ( TessBaseAPI *  handle,
int  ppi 
)

Definition at line 353 of file capi.cpp.

354 {
355  handle->SetSourceResolution(ppi);
356 }

◆ TessBaseAPISetVariable()

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

Definition at line 178 of file capi.cpp.

179 {
180  return handle->SetVariable(name, value) ? TRUE : FALSE;
181 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessBoxTextRendererCreate()

TESS_API TessResultRenderer* TESS_CALL TessBoxTextRendererCreate ( const char *  outputbase)

Definition at line 78 of file capi.cpp.

79 {
80  return new TessBoxTextRenderer(outputbase);
81 }
TessBoxTextRenderer
struct TessBoxTextRenderer TessBoxTextRenderer
Definition: capi.h:82

◆ TessChoiceIteratorConfidence()

TESS_API float TESS_CALL TessChoiceIteratorConfidence ( const TessChoiceIterator *  handle)

Definition at line 811 of file capi.cpp.

812 {
813  return handle->Confidence();
814 }

◆ TessChoiceIteratorDelete()

TESS_API void TESS_CALL TessChoiceIteratorDelete ( TessChoiceIterator *  handle)

Definition at line 796 of file capi.cpp.

797 {
798  delete handle;
799 }

◆ TessChoiceIteratorGetUTF8Text()

TESS_API const char* TESS_CALL TessChoiceIteratorGetUTF8Text ( const TessChoiceIterator *  handle)

Definition at line 806 of file capi.cpp.

807 {
808  return handle->GetUTF8Text();
809 }

◆ TessChoiceIteratorNext()

TESS_API BOOL TESS_CALL TessChoiceIteratorNext ( TessChoiceIterator *  handle)

Definition at line 801 of file capi.cpp.

802 {
803  return handle->Next();
804 }

◆ TessDeleteIntArray()

TESS_API void TESS_CALL TessDeleteIntArray ( int *  arr)

Definition at line 42 of file capi.cpp.

43 {
44  delete [] arr;
45 }

◆ TessDeleteResultRenderer()

TESS_API void TESS_CALL TessDeleteResultRenderer ( TessResultRenderer *  renderer)

Definition at line 83 of file capi.cpp.

84 {
85  delete renderer;
86 }

◆ TessDeleteText()

TESS_API void TESS_CALL TessDeleteText ( char *  text)

Definition at line 30 of file capi.cpp.

31 {
32  delete [] text;
33 }

◆ TessDeleteTextArray()

TESS_API void TESS_CALL TessDeleteTextArray ( char **  arr)

Definition at line 35 of file capi.cpp.

36 {
37  for (char** pos = arr; *pos != NULL; ++pos)
38  delete [] *pos;
39  delete [] arr;
40 }

◆ TessHOcrRendererCreate()

TESS_API TessResultRenderer* TESS_CALL TessHOcrRendererCreate ( const char *  outputbase)

Definition at line 57 of file capi.cpp.

58 {
59  return new TessHOcrRenderer(outputbase);
60 }
TessHOcrRenderer
struct TessHOcrRenderer TessHOcrRenderer
Definition: capi.h:79

◆ TessHOcrRendererCreate2()

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

Definition at line 62 of file capi.cpp.

63 {
64  return new TessHOcrRenderer(outputbase, font_info);
65 }
TessHOcrRenderer
struct TessHOcrRenderer TessHOcrRenderer
Definition: capi.h:79

◆ TessPageIteratorBaseline()

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

Definition at line 679 of file capi.cpp.

681 {
682  return handle->Baseline(level, x1, y1, x2, y2) ? TRUE : FALSE;
683 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessPageIteratorBegin()

TESS_API void TESS_CALL TessPageIteratorBegin ( TessPageIterator *  handle)

Definition at line 636 of file capi.cpp.

637 {
638  handle->Begin();
639 }

◆ TessPageIteratorBlockType()

TESS_API TessPolyBlockType TESS_CALL TessPageIteratorBlockType ( const TessPageIterator *  handle)

Definition at line 663 of file capi.cpp.

664 {
665  return handle->BlockType();
666 }

◆ TessPageIteratorBoundingBox()

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

Definition at line 657 of file capi.cpp.

659 {
660  return handle->BoundingBox(level, left, top, right, bottom) ? TRUE : FALSE;
661 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessPageIteratorCopy()

TESS_API TessPageIterator* TESS_CALL TessPageIteratorCopy ( const TessPageIterator *  handle)

Definition at line 631 of file capi.cpp.

632 {
633  return new TessPageIterator(*handle);
634 }
TessPageIterator
struct TessPageIterator TessPageIterator
Definition: capi.h:84

◆ TessPageIteratorDelete()

TESS_API void TESS_CALL TessPageIteratorDelete ( TessPageIterator *  handle)

Definition at line 626 of file capi.cpp.

627 {
628  delete handle;
629 }

◆ TessPageIteratorGetBinaryImage()

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

Definition at line 668 of file capi.cpp.

669 {
670  return handle->GetBinaryImage(level);
671 }

◆ TessPageIteratorGetImage()

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

Definition at line 673 of file capi.cpp.

675 {
676  return handle->GetImage(level, padding, original_image, left, top);
677 }

◆ TessPageIteratorIsAtBeginningOf()

TESS_API BOOL TESS_CALL TessPageIteratorIsAtBeginningOf ( const TessPageIterator *  handle,
TessPageIteratorLevel  level 
)

Definition at line 646 of file capi.cpp.

647 {
648  return handle->IsAtBeginningOf(level) ? TRUE : FALSE;
649 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessPageIteratorIsAtFinalElement()

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

Definition at line 651 of file capi.cpp.

653 {
654  return handle->IsAtFinalElement(level, element) ? TRUE : FALSE;
655 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessPageIteratorNext()

TESS_API BOOL TESS_CALL TessPageIteratorNext ( TessPageIterator *  handle,
TessPageIteratorLevel  level 
)

Definition at line 641 of file capi.cpp.

642 {
643  return handle->Next(level) ? TRUE : FALSE;
644 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessPageIteratorOrientation()

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

Definition at line 685 of file capi.cpp.

688 {
689  handle->Orientation(orientation, writing_direction, textline_order, deskew_angle);
690 }

◆ TessPageIteratorParagraphInfo()

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

Definition at line 692 of file capi.cpp.

694 {
695  bool bool_is_list_item, bool_is_crown;
696  handle->ParagraphInfo(justification, &bool_is_list_item, &bool_is_crown, first_line_indent);
697  if (is_list_item)
698  *is_list_item = bool_is_list_item ? TRUE : FALSE;
699  if (is_crown)
700  *is_crown = bool_is_crown ? TRUE : FALSE;
701 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessPDFRendererCreate()

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

Definition at line 67 of file capi.cpp.

69 {
70  return new TessPDFRenderer(outputbase, datadir, textonly);
71 }
TessPDFRenderer
struct TessPDFRenderer TessPDFRenderer
Definition: capi.h:80

◆ TessResultIteratorConfidence()

TESS_API float TESS_CALL TessResultIteratorConfidence ( const TessResultIterator *  handle,
TessPageIteratorLevel  level 
)

Definition at line 739 of file capi.cpp.

740 {
741  return handle->Confidence(level);
742 }

◆ TessResultIteratorCopy()

TESS_API TessResultIterator* TESS_CALL TessResultIteratorCopy ( const TessResultIterator *  handle)

Definition at line 709 of file capi.cpp.

710 {
711  return new TessResultIterator(*handle);
712 }
TessResultIterator
struct TessResultIterator TessResultIterator
Definition: capi.h:85

◆ TessResultIteratorDelete()

TESS_API void TESS_CALL TessResultIteratorDelete ( TessResultIterator *  handle)

Definition at line 704 of file capi.cpp.

705 {
706  delete handle;
707 }

◆ TessResultIteratorGetChoiceIterator()

TESS_API TessChoiceIterator* TESS_CALL TessResultIteratorGetChoiceIterator ( const TessResultIterator *  handle)

Definition at line 724 of file capi.cpp.

725 {
726  return new TessChoiceIterator(*handle);
727 }
TessChoiceIterator
struct TessChoiceIterator TessChoiceIterator
Definition: capi.h:87

◆ TessResultIteratorGetPageIterator()

TESS_API TessPageIterator* TESS_CALL TessResultIteratorGetPageIterator ( TessResultIterator *  handle)

Definition at line 714 of file capi.cpp.

715 {
716  return handle;
717 }

◆ TessResultIteratorGetPageIteratorConst()

TESS_API const TessPageIterator* TESS_CALL TessResultIteratorGetPageIteratorConst ( const TessResultIterator *  handle)

Definition at line 719 of file capi.cpp.

720 {
721  return handle;
722 }

◆ TessResultIteratorGetUTF8Text()

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

Definition at line 734 of file capi.cpp.

735 {
736  return handle->GetUTF8Text(level);
737 }

◆ TessResultIteratorNext()

TESS_API BOOL TESS_CALL TessResultIteratorNext ( TessResultIterator *  handle,
TessPageIteratorLevel  level 
)

Definition at line 729 of file capi.cpp.

730 {
731  return handle->Next(level);
732 }

◆ TessResultIteratorSymbolIsDropcap()

TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsDropcap ( const TessResultIterator *  handle)

Definition at line 791 of file capi.cpp.

792 {
793  return handle->SymbolIsDropcap() ? TRUE : FALSE;
794 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessResultIteratorSymbolIsSubscript()

TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsSubscript ( const TessResultIterator *  handle)

Definition at line 786 of file capi.cpp.

787 {
788  return handle->SymbolIsSubscript() ? TRUE : FALSE;
789 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessResultIteratorSymbolIsSuperscript()

TESS_API BOOL TESS_CALL TessResultIteratorSymbolIsSuperscript ( const TessResultIterator *  handle)

Definition at line 781 of file capi.cpp.

782 {
783  return handle->SymbolIsSuperscript() ? TRUE : FALSE;
784 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessResultIteratorWordFontAttributes()

TESS_API const char* TESS_CALL 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 749 of file capi.cpp.

752 {
753  bool bool_is_bold, bool_is_italic, bool_is_underlined, bool_is_monospace, bool_is_serif, bool_is_smallcaps;
754  const char* ret = handle->WordFontAttributes(&bool_is_bold, &bool_is_italic, &bool_is_underlined, &bool_is_monospace, &bool_is_serif,
755  &bool_is_smallcaps, pointsize, font_id);
756  if (is_bold)
757  *is_bold = bool_is_bold ? TRUE : FALSE;
758  if (is_italic)
759  *is_italic = bool_is_italic ? TRUE : FALSE;
760  if (is_underlined)
761  *is_underlined = bool_is_underlined ? TRUE : FALSE;
762  if (is_monospace)
763  *is_monospace = bool_is_monospace ? TRUE : FALSE;
764  if (is_serif)
765  *is_serif = bool_is_serif ? TRUE : FALSE;
766  if (is_smallcaps)
767  *is_smallcaps = bool_is_smallcaps ? TRUE : FALSE;
768  return ret;
769 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessResultIteratorWordIsFromDictionary()

TESS_API BOOL TESS_CALL TessResultIteratorWordIsFromDictionary ( const TessResultIterator *  handle)

Definition at line 771 of file capi.cpp.

772 {
773  return handle->WordIsFromDictionary() ? TRUE : FALSE;
774 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessResultIteratorWordIsNumeric()

TESS_API BOOL TESS_CALL TessResultIteratorWordIsNumeric ( const TessResultIterator *  handle)

Definition at line 776 of file capi.cpp.

777 {
778  return handle->WordIsNumeric() ? TRUE : FALSE;
779 }
TRUE
#define TRUE
Definition: capi.h:45
FALSE
#define FALSE
Definition: capi.h:46

◆ TessResultIteratorWordRecognitionLanguage()

TESS_API const char* TESS_CALL TessResultIteratorWordRecognitionLanguage ( const TessResultIterator *  handle)

Definition at line 744 of file capi.cpp.

745 {
746  return handle->WordRecognitionLanguage();
747 }

◆ TessResultRendererAddImage()

TESS_API BOOL TESS_CALL TessResultRendererAddImage ( TessResultRenderer *  renderer,
TessBaseAPI *  api 
)

Definition at line 103 of file capi.cpp.

104 {
105  return renderer->AddImage(api);
106 }

◆ TessResultRendererBeginDocument()

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

Definition at line 98 of file capi.cpp.

99 {
100  return renderer->BeginDocument(title);
101 }

◆ TessResultRendererEndDocument()

TESS_API BOOL TESS_CALL TessResultRendererEndDocument ( TessResultRenderer *  renderer)

Definition at line 108 of file capi.cpp.

109 {
110  return renderer->EndDocument();
111 }

◆ TessResultRendererExtention()

TESS_API const char* TESS_CALL TessResultRendererExtention ( TessResultRenderer *  renderer)

Definition at line 113 of file capi.cpp.

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

◆ TessResultRendererImageNum()

TESS_API int TESS_CALL TessResultRendererImageNum ( TessResultRenderer *  renderer)

Definition at line 123 of file capi.cpp.

124 {
125  return renderer->imagenum();
126 }

◆ TessResultRendererInsert()

TESS_API void TESS_CALL TessResultRendererInsert ( TessResultRenderer *  renderer,
TessResultRenderer *  next 
)

Definition at line 88 of file capi.cpp.

89 {
90  renderer->insert(next);
91 }

◆ TessResultRendererNext()

TESS_API TessResultRenderer* TESS_CALL TessResultRendererNext ( TessResultRenderer *  renderer)

Definition at line 93 of file capi.cpp.

94 {
95  return renderer->next();
96 }

◆ TessResultRendererTitle()

TESS_API const char* TESS_CALL TessResultRendererTitle ( TessResultRenderer *  renderer)

Definition at line 118 of file capi.cpp.

119 {
120  return renderer->title();
121 }

◆ TessTextRendererCreate()

TESS_API TessResultRenderer* TESS_CALL TessTextRendererCreate ( const char *  outputbase)

Definition at line 52 of file capi.cpp.

53 {
54  return new TessTextRenderer(outputbase);
55 }
TessTextRenderer
struct TessTextRenderer TessTextRenderer
Definition: capi.h:78

◆ TessUnlvRendererCreate()

TESS_API TessResultRenderer* TESS_CALL TessUnlvRendererCreate ( const char *  outputbase)

Definition at line 73 of file capi.cpp.

74 {
75  return new TessUnlvRenderer(outputbase);
76 }
TessUnlvRenderer
struct TessUnlvRenderer TessUnlvRenderer
Definition: capi.h:81

◆ TessVersion()

TESS_API const char* TESS_CALL TessVersion ( )

Definition at line 25 of file capi.cpp.

26 {
27  return TessBaseAPI::Version();
28 }