Interface
ITessApiSignatures

The exported tesseract api signatures.

Definition

Namespace:Tesseract.Interop

Assembly:Telerik.Windows.Documents.TesseractOcr.dll

Syntax:

cs-api-definition
public interface ITessApiSignatures

Methods

AltoRendererCreate(string)

Declaration

cs-api-definition
nint AltoRendererCreate(string outputbase)

Parameters

outputbase

string

Returns

nint

BaseAPIAnalyseLayout(HandleRef)

Declaration

cs-api-definition
nint BaseAPIAnalyseLayout(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

BaseAPIClear(HandleRef)

Declaration

cs-api-definition
void BaseAPIClear(HandleRef handle)

Parameters

handle

HandleRef

BaseAPIGetComponentImages(HandleRef, PageIteratorLevel, int, nint, nint)

Declaration

cs-api-definition
nint BaseAPIGetComponentImages(HandleRef handle, PageIteratorLevel level, int text_only, nint pixa, nint blockids)

Parameters

handle

HandleRef

level

PageIteratorLevel

text_only

int

pixa

nint

blockids

nint

Returns

nint

BaseAPIGetDatapath(HandleRef)

Declaration

cs-api-definition
string BaseAPIGetDatapath(HandleRef handle)

Parameters

handle

HandleRef

Returns

string

BaseAPIGetPageSegMode(HandleRef)

Declaration

cs-api-definition
PageSegMode BaseAPIGetPageSegMode(HandleRef handle)

Parameters

handle

HandleRef

Returns

PageSegMode

BaseAPIGetThresholdedImage(HandleRef)

Declaration

cs-api-definition
nint BaseAPIGetThresholdedImage(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

BaseAPIGetUTF8TextInternal(HandleRef)

Declaration

cs-api-definition
nint BaseAPIGetUTF8TextInternal(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

BaseAPIMeanTextConf(HandleRef)

Declaration

cs-api-definition
int BaseAPIMeanTextConf(HandleRef handle)

Parameters

handle

HandleRef

Returns

int

BaseAPISetInputName(HandleRef, string)

Declaration

cs-api-definition
void BaseAPISetInputName(HandleRef handle, string name)

Parameters

handle

HandleRef

name

string

BaseAPISetOutputName(HandleRef, string)

Declaration

cs-api-definition
void BaseAPISetOutputName(HandleRef handle, string name)

Parameters

handle

HandleRef

name

string

BaseAPISetPageSegMode(HandleRef, PageSegMode)

Declaration

cs-api-definition
void BaseAPISetPageSegMode(HandleRef handle, PageSegMode mode)

Parameters

handle

HandleRef

mode

PageSegMode

BaseApiCreate()

Creates a new BaseAPI instance

Declaration

cs-api-definition
nint BaseApiCreate()

Returns

nint

BaseApiDelete(HandleRef)

Deletes a base api instance.

Declaration

cs-api-definition
void BaseApiDelete(HandleRef ptr)

Parameters

ptr

HandleRef

BaseApiGetAltoTextInternal(HandleRef, int)

Declaration

cs-api-definition
nint BaseApiGetAltoTextInternal(HandleRef handle, int pageNum)

Parameters

handle

HandleRef

pageNum

int

Returns

nint

BaseApiGetBoolVariable(HandleRef, string, out int)

Declaration

cs-api-definition
int BaseApiGetBoolVariable(HandleRef handle, string name, out int value)

Parameters

handle

HandleRef

name

string

value

int

Returns

int

BaseApiGetBoxTextInternal(HandleRef, int)

Declaration

cs-api-definition
nint BaseApiGetBoxTextInternal(HandleRef handle, int pageNum)

Parameters

handle

HandleRef

pageNum

int

Returns

nint

BaseApiGetDoubleVariable(HandleRef, string, out double)

Declaration

cs-api-definition
int BaseApiGetDoubleVariable(HandleRef handle, string name, out double value)

Parameters

handle

HandleRef

name

string

value

double

Returns

int

BaseApiGetHOCRTextInternal(HandleRef, int)

Declaration

cs-api-definition
nint BaseApiGetHOCRTextInternal(HandleRef handle, int pageNum)

Parameters

handle

HandleRef

pageNum

int

Returns

nint

BaseApiGetIntVariable(HandleRef, string, out int)

Declaration

cs-api-definition
int BaseApiGetIntVariable(HandleRef handle, string name, out int value)

Parameters

handle

HandleRef

name

string

value

int

Returns

int

BaseApiGetIterator(HandleRef)

Declaration

cs-api-definition
nint BaseApiGetIterator(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

BaseApiGetLSTMBoxTextInternal(HandleRef, int)

Declaration

cs-api-definition
nint BaseApiGetLSTMBoxTextInternal(HandleRef handle, int pageNum)

Parameters

handle

HandleRef

pageNum

int

Returns

nint

BaseApiGetStringVariableInternal(HandleRef, string)

Declaration

cs-api-definition
nint BaseApiGetStringVariableInternal(HandleRef handle, string name)

Parameters

handle

HandleRef

name

string

Returns

nint

BaseApiGetTsvTextInternal(HandleRef, int)

Declaration

cs-api-definition
nint BaseApiGetTsvTextInternal(HandleRef handle, int pageNum)

Parameters

handle

HandleRef

pageNum

int

Returns

nint

BaseApiGetUNLVTextInternal(HandleRef)

Declaration

cs-api-definition
nint BaseApiGetUNLVTextInternal(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

BaseApiGetWordStrBoxTextInternal(HandleRef, int)

Declaration

cs-api-definition
nint BaseApiGetWordStrBoxTextInternal(HandleRef handle, int pageNum)

Parameters

handle

HandleRef

pageNum

int

Returns

nint

BaseApiInit(HandleRef, string, string, int, string[], int, string[], string[], nuint, bool)

Declaration

cs-api-definition
int BaseApiInit(HandleRef handle, string datapath, string language, int mode, string[] configs, int configs_size, string[] vars_vec, string[] vars_values, nuint vars_vec_size, bool set_only_non_debug_params)

Parameters

handle

HandleRef

datapath

string

language

string

mode

int

configs

string[]

configs_size

int

vars_vec

string[]

vars_values

string[]

vars_vec_size

nuint

set_only_non_debug_params

bool

Returns

int

BaseApiPrintVariablesToFile(HandleRef, string)

Declaration

cs-api-definition
int BaseApiPrintVariablesToFile(HandleRef handle, string filename)

Parameters

handle

HandleRef

filename

string

Returns

int

BaseApiRecognize(HandleRef, HandleRef)

Declaration

cs-api-definition
int BaseApiRecognize(HandleRef handle, HandleRef monitor)

Parameters

handle

HandleRef

monitor

HandleRef

Returns

int

BaseApiSetDebugVariable(HandleRef, string, nint)

Declaration

cs-api-definition
int BaseApiSetDebugVariable(HandleRef handle, string name, nint valPtr)

Parameters

handle

HandleRef

name

string

valPtr

nint

Returns

int

BaseApiSetImage(HandleRef, HandleRef)

Declaration

cs-api-definition
void BaseApiSetImage(HandleRef handle, HandleRef pixHandle)

Parameters

handle

HandleRef

pixHandle

HandleRef

BaseApiSetInputName(HandleRef, string)

Declaration

cs-api-definition
void BaseApiSetInputName(HandleRef handle, string value)

Parameters

handle

HandleRef

value

string

BaseApiSetRectangle(HandleRef, int, int, int, int)

Declaration

cs-api-definition
void BaseApiSetRectangle(HandleRef handle, int left, int top, int width, int height)

Parameters

handle

HandleRef

left

int

top

int

width

int

height

int

BaseApiSetVariable(HandleRef, string, nint)

Declaration

cs-api-definition
int BaseApiSetVariable(HandleRef handle, string name, nint valPtr)

Parameters

handle

HandleRef

name

string

valPtr

nint

Returns

int

BoxTextRendererCreate(string)

Declaration

cs-api-definition
nint BoxTextRendererCreate(string outputbase)

Parameters

outputbase

string

Returns

nint

ChoiceIteratorDelete(HandleRef)

Native API call to TessChoiceIteratorDelete

Declaration

cs-api-definition
void ChoiceIteratorDelete(HandleRef handle)

Parameters

handle

HandleRef

ChoiceIteratorGetConfidence(HandleRef)

Native API call to TessChoiceIteratorConfidence

Declaration

cs-api-definition
float ChoiceIteratorGetConfidence(HandleRef handle)

Parameters

handle

HandleRef

Returns

float

ChoiceIteratorGetUTF8TextInternal(HandleRef)

Native API call to TessChoiceIteratorGetUTF8Text

Declaration

cs-api-definition
nint ChoiceIteratorGetUTF8TextInternal(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

ChoiceIteratorNext(HandleRef)

Native API call to TessChoiceIteratorNext

Declaration

cs-api-definition
int ChoiceIteratorNext(HandleRef handle)

Parameters

handle

HandleRef

Returns

int

DeleteIntArray(nint)

Declaration

cs-api-definition
void DeleteIntArray(nint arr)

Parameters

arr

nint

DeleteResultRenderer(HandleRef)

Declaration

cs-api-definition
void DeleteResultRenderer(HandleRef renderer)

Parameters

renderer

HandleRef

DeleteText(nint)

Declaration

cs-api-definition
void DeleteText(nint textPtr)

Parameters

textPtr

nint

DeleteTextArray(nint)

Declaration

cs-api-definition
void DeleteTextArray(nint arr)

Parameters

arr

nint

GetVersion()

Declaration

cs-api-definition
nint GetVersion()

Returns

nint

HOcrRendererCreate(string)

Declaration

cs-api-definition
nint HOcrRendererCreate(string outputbase)

Parameters

outputbase

string

Returns

nint

HOcrRendererCreate2(string, int)

Declaration

cs-api-definition
nint HOcrRendererCreate2(string outputbase, int font_info)

Parameters

outputbase

string

font_info

int

Returns

nint

LSTMBoxRendererCreate(string)

Declaration

cs-api-definition
nint LSTMBoxRendererCreate(string outputbase)

Parameters

outputbase

string

Returns

nint

PDFRendererCreate(string, nint, int)

Declaration

cs-api-definition
nint PDFRendererCreate(string outputbase, nint datadir, int textonly)

Parameters

outputbase

string

datadir

nint

textonly

int

Returns

nint

PageIteratorBaseline(HandleRef, PageIteratorLevel, out int, out int, out int, out int)

Declaration

cs-api-definition
int PageIteratorBaseline(HandleRef handle, PageIteratorLevel level, out int x1, out int y1, out int x2, out int y2)

Parameters

handle

HandleRef

level

PageIteratorLevel

x1

int

y1

int

x2

int

y2

int

Returns

int

PageIteratorBegin(HandleRef)

Declaration

cs-api-definition
void PageIteratorBegin(HandleRef handle)

Parameters

handle

HandleRef

PageIteratorBlockType(HandleRef)

Declaration

cs-api-definition
PolyBlockType PageIteratorBlockType(HandleRef handle)

Parameters

handle

HandleRef

Returns

PolyBlockType

PageIteratorBoundingBox(HandleRef, PageIteratorLevel, out int, out int, out int, out int)

Declaration

cs-api-definition
int PageIteratorBoundingBox(HandleRef handle, PageIteratorLevel level, out int left, out int top, out int right, out int bottom)

Parameters

handle

HandleRef

level

PageIteratorLevel

left

int

top

int

right

int

bottom

int

Returns

int

PageIteratorCopy(HandleRef)

Declaration

cs-api-definition
nint PageIteratorCopy(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

PageIteratorDelete(HandleRef)

Declaration

cs-api-definition
void PageIteratorDelete(HandleRef handle)

Parameters

handle

HandleRef

PageIteratorGetBinaryImage(HandleRef, PageIteratorLevel)

Declaration

cs-api-definition
nint PageIteratorGetBinaryImage(HandleRef handle, PageIteratorLevel level)

Parameters

handle

HandleRef

level

PageIteratorLevel

Returns

nint

PageIteratorGetImage(HandleRef, PageIteratorLevel, int, HandleRef, out int, out int)

Declaration

cs-api-definition
nint PageIteratorGetImage(HandleRef handle, PageIteratorLevel level, int padding, HandleRef originalImage, out int left, out int top)

Parameters

handle

HandleRef

level

PageIteratorLevel

padding

int

originalImage

HandleRef

left

int

top

int

Returns

nint

PageIteratorIsAtBeginningOf(HandleRef, PageIteratorLevel)

Declaration

cs-api-definition
int PageIteratorIsAtBeginningOf(HandleRef handle, PageIteratorLevel level)

Parameters

handle

HandleRef

level

PageIteratorLevel

Returns

int

PageIteratorIsAtFinalElement(HandleRef, PageIteratorLevel, PageIteratorLevel)

Declaration

cs-api-definition
int PageIteratorIsAtFinalElement(HandleRef handle, PageIteratorLevel level, PageIteratorLevel element)

Parameters

handle

HandleRef

level

PageIteratorLevel

element

PageIteratorLevel

Returns

int

PageIteratorNext(HandleRef, PageIteratorLevel)

Declaration

cs-api-definition
int PageIteratorNext(HandleRef handle, PageIteratorLevel level)

Parameters

handle

HandleRef

level

PageIteratorLevel

Returns

int

PageIteratorOrientation(HandleRef, out Orientation, out WritingDirection, out TextLineOrder, out float)

Declaration

cs-api-definition
void PageIteratorOrientation(HandleRef handle, out Orientation orientation, out WritingDirection writing_direction, out TextLineOrder textLineOrder, out float deskew_angle)

Parameters

handle

HandleRef

orientation

Orientation

writing_direction

WritingDirection

textLineOrder

TextLineOrder

deskew_angle

float

ResultIteratorCopy(HandleRef)

Declaration

cs-api-definition
nint ResultIteratorCopy(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

ResultIteratorDelete(HandleRef)

Declaration

cs-api-definition
void ResultIteratorDelete(HandleRef handle)

Parameters

handle

HandleRef

ResultIteratorGetChoiceIterator(HandleRef)

Native API call to TessResultIteratorGetChoiceIterator

Declaration

cs-api-definition
nint ResultIteratorGetChoiceIterator(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

ResultIteratorGetConfidence(HandleRef, PageIteratorLevel)

Declaration

cs-api-definition
float ResultIteratorGetConfidence(HandleRef handle, PageIteratorLevel level)

Parameters

handle

HandleRef

level

PageIteratorLevel

Returns

float

ResultIteratorGetPageIterator(HandleRef)

Declaration

cs-api-definition
nint ResultIteratorGetPageIterator(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

ResultIteratorGetUTF8TextInternal(HandleRef, PageIteratorLevel)

Declaration

cs-api-definition
nint ResultIteratorGetUTF8TextInternal(HandleRef handle, PageIteratorLevel level)

Parameters

handle

HandleRef

level

PageIteratorLevel

Returns

nint

ResultIteratorSymbolIsDropcap(HandleRef)

Declaration

cs-api-definition
bool ResultIteratorSymbolIsDropcap(HandleRef handle)

Parameters

handle

HandleRef

Returns

bool

ResultIteratorSymbolIsSubscript(HandleRef)

Declaration

cs-api-definition
bool ResultIteratorSymbolIsSubscript(HandleRef handle)

Parameters

handle

HandleRef

Returns

bool

ResultIteratorSymbolIsSuperscript(HandleRef)

Declaration

cs-api-definition
bool ResultIteratorSymbolIsSuperscript(HandleRef handle)

Parameters

handle

HandleRef

Returns

bool

ResultIteratorWordFontAttributes(HandleRef, out bool, out bool, out bool, out bool, out bool, out bool, out int, out int)

Declaration

cs-api-definition
nint ResultIteratorWordFontAttributes(HandleRef handle, out bool isBold, out bool isItalic, out bool isUnderlined, out bool isMonospace, out bool isSerif, out bool isSmallCaps, out int pointSize, out int fontId)

Parameters

handle

HandleRef

isBold

bool

isItalic

bool

isUnderlined

bool

isMonospace

bool

isSerif

bool

isSmallCaps

bool

pointSize

int

fontId

int

Returns

nint

ResultIteratorWordIsFromDictionary(HandleRef)

Declaration

cs-api-definition
bool ResultIteratorWordIsFromDictionary(HandleRef handle)

Parameters

handle

HandleRef

Returns

bool

ResultIteratorWordIsNumeric(HandleRef)

Declaration

cs-api-definition
bool ResultIteratorWordIsNumeric(HandleRef handle)

Parameters

handle

HandleRef

Returns

bool

ResultIteratorWordRecognitionLanguageInternal(HandleRef)

Declaration

cs-api-definition
nint ResultIteratorWordRecognitionLanguageInternal(HandleRef handle)

Parameters

handle

HandleRef

Returns

nint

ResultRendererAddImage(HandleRef, HandleRef)

Declaration

cs-api-definition
int ResultRendererAddImage(HandleRef renderer, HandleRef api)

Parameters

renderer

HandleRef

api

HandleRef

Returns

int

ResultRendererBeginDocument(HandleRef, nint)

Declaration

cs-api-definition
int ResultRendererBeginDocument(HandleRef renderer, nint titlePtr)

Parameters

renderer

HandleRef

titlePtr

nint

Returns

int

ResultRendererEndDocument(HandleRef)

Declaration

cs-api-definition
int ResultRendererEndDocument(HandleRef renderer)

Parameters

renderer

HandleRef

Returns

int

ResultRendererExtention(HandleRef)

Declaration

cs-api-definition
nint ResultRendererExtention(HandleRef renderer)

Parameters

renderer

HandleRef

Returns

nint

ResultRendererImageNum(HandleRef)

Declaration

cs-api-definition
int ResultRendererImageNum(HandleRef renderer)

Parameters

renderer

HandleRef

Returns

int

ResultRendererInsert(HandleRef, HandleRef)

Declaration

cs-api-definition
void ResultRendererInsert(HandleRef renderer, HandleRef next)

Parameters

renderer

HandleRef

next

HandleRef

ResultRendererNext(HandleRef)

Declaration

cs-api-definition
nint ResultRendererNext(HandleRef renderer)

Parameters

renderer

HandleRef

Returns

nint

ResultRendererTitle(HandleRef)

Declaration

cs-api-definition
nint ResultRendererTitle(HandleRef renderer)

Parameters

renderer

HandleRef

Returns

nint

TessBaseAPIDetectOrientationScript(HandleRef, out int, out float, out nint, out float)

Declaration

cs-api-definition
int TessBaseAPIDetectOrientationScript(HandleRef handle, out int orient_deg, out float orient_conf, out nint script_name, out float script_conf)

Parameters

handle

HandleRef

orient_deg

int

orient_conf

float

script_name

nint

script_conf

float

Returns

int

TextRendererCreate(string)

Declaration

cs-api-definition
nint TextRendererCreate(string outputbase)

Parameters

outputbase

string

Returns

nint

TsvRendererCreate(string)

Declaration

cs-api-definition
nint TsvRendererCreate(string outputbase)

Parameters

outputbase

string

Returns

nint

UnlvRendererCreate(string)

Declaration

cs-api-definition
nint UnlvRendererCreate(string outputbase)

Parameters

outputbase

string

Returns

nint

WordStrBoxRendererCreate(string)

Declaration

cs-api-definition
nint WordStrBoxRendererCreate(string outputbase)

Parameters

outputbase

string

Returns

nint

In this article
DefinitionMethodsAltoRendererCreate(string)BaseAPIAnalyseLayout(HandleRef)BaseAPIClear(HandleRef)BaseAPIGetComponentImages(HandleRef, PageIteratorLevel, int, nint, nint)BaseAPIGetDatapath(HandleRef)BaseAPIGetPageSegMode(HandleRef)BaseAPIGetThresholdedImage(HandleRef)BaseAPIGetUTF8TextInternal(HandleRef)BaseAPIMeanTextConf(HandleRef)BaseAPISetInputName(HandleRef, string)BaseAPISetOutputName(HandleRef, string)BaseAPISetPageSegMode(HandleRef, PageSegMode)BaseApiCreate()BaseApiDelete(HandleRef)BaseApiGetAltoTextInternal(HandleRef, int)BaseApiGetBoolVariable(HandleRef, string, out int)BaseApiGetBoxTextInternal(HandleRef, int)BaseApiGetDoubleVariable(HandleRef, string, out double)BaseApiGetHOCRTextInternal(HandleRef, int)BaseApiGetIntVariable(HandleRef, string, out int)BaseApiGetIterator(HandleRef)BaseApiGetLSTMBoxTextInternal(HandleRef, int)BaseApiGetStringVariableInternal(HandleRef, string)BaseApiGetTsvTextInternal(HandleRef, int)BaseApiGetUNLVTextInternal(HandleRef)BaseApiGetWordStrBoxTextInternal(HandleRef, int)BaseApiInit(HandleRef, string, string, int, string[], int, string[], string[], nuint, bool)BaseApiPrintVariablesToFile(HandleRef, string)BaseApiRecognize(HandleRef, HandleRef)BaseApiSetDebugVariable(HandleRef, string, nint)BaseApiSetImage(HandleRef, HandleRef)BaseApiSetInputName(HandleRef, string)BaseApiSetRectangle(HandleRef, int, int, int, int)BaseApiSetVariable(HandleRef, string, nint)BoxTextRendererCreate(string)ChoiceIteratorDelete(HandleRef)ChoiceIteratorGetConfidence(HandleRef)ChoiceIteratorGetUTF8TextInternal(HandleRef)ChoiceIteratorNext(HandleRef)DeleteIntArray(nint)DeleteResultRenderer(HandleRef)DeleteText(nint)DeleteTextArray(nint)GetVersion()HOcrRendererCreate(string)HOcrRendererCreate2(string, int)LSTMBoxRendererCreate(string)PDFRendererCreate(string, nint, int)PageIteratorBaseline(HandleRef, PageIteratorLevel, out int, out int, out int, out int)PageIteratorBegin(HandleRef)PageIteratorBlockType(HandleRef)PageIteratorBoundingBox(HandleRef, PageIteratorLevel, out int, out int, out int, out int)PageIteratorCopy(HandleRef)PageIteratorDelete(HandleRef)PageIteratorGetBinaryImage(HandleRef, PageIteratorLevel)PageIteratorGetImage(HandleRef, PageIteratorLevel, int, HandleRef, out int, out int)PageIteratorIsAtBeginningOf(HandleRef, PageIteratorLevel)PageIteratorIsAtFinalElement(HandleRef, PageIteratorLevel, PageIteratorLevel)PageIteratorNext(HandleRef, PageIteratorLevel)PageIteratorOrientation(HandleRef, out Orientation, out WritingDirection, out TextLineOrder, out float)ResultIteratorCopy(HandleRef)ResultIteratorDelete(HandleRef)ResultIteratorGetChoiceIterator(HandleRef)ResultIteratorGetConfidence(HandleRef, PageIteratorLevel)ResultIteratorGetPageIterator(HandleRef)ResultIteratorGetUTF8TextInternal(HandleRef, PageIteratorLevel)ResultIteratorSymbolIsDropcap(HandleRef)ResultIteratorSymbolIsSubscript(HandleRef)ResultIteratorSymbolIsSuperscript(HandleRef)ResultIteratorWordFontAttributes(HandleRef, out bool, out bool, out bool, out bool, out bool, out bool, out int, out int)ResultIteratorWordIsFromDictionary(HandleRef)ResultIteratorWordIsNumeric(HandleRef)ResultIteratorWordRecognitionLanguageInternal(HandleRef)ResultRendererAddImage(HandleRef, HandleRef)ResultRendererBeginDocument(HandleRef, nint)ResultRendererEndDocument(HandleRef)ResultRendererExtention(HandleRef)ResultRendererImageNum(HandleRef)ResultRendererInsert(HandleRef, HandleRef)ResultRendererNext(HandleRef)ResultRendererTitle(HandleRef)TessBaseAPIDetectOrientationScript(HandleRef, out int, out float, out nint, out float)TextRendererCreate(string)TsvRendererCreate(string)UnlvRendererCreate(string)WordStrBoxRendererCreate(string)
Not finding the help you need?
Contact Support