SaigeVision C/C++  1.4.7
SaigeVision API document for C/C++
OCR's handle construction

Typedefs

typedef void * OCRTestHandle
 OCR file handler. More...
 
typedef void * OCRTestResult
 OCR inspection results handler. More...
 

Functions

OCRTestHandle SR_CreateOCRTestHandle (const char *ocrBoxFilePath, const char *ocrTextFilePath)
 Create a OCRTestHandle via multi byte char path. More...
 
OCRTestHandle SR_CreateOCRTestHandleByWideCharPath (const wchar_t *ocrBoxFilePath, const wchar_t *ocrTextFilePath)
 Create a OCRTestHandle via wide char path. More...
 
OCRTestResult SR_MakeOCRTestResult ()
 Construct a OCRTestResult. More...
 

Detailed Description

Construct OCRTestHandle or OCRTestResult.

Typedef Documentation

◆ OCRTestHandle

typedef void* OCRTestHandle

OCR file handler.

OCRTestHandle is a handle of OCR files (.srOcrBox, .srOcrText). One OCRTestHandle object manages two files, one for each stage (box-stage, text-stage).

See also
SR_CreateOCRTestHandleByWideCharPath, SR_DestroyOCRTestHandle

◆ OCRTestResult

typedef void* OCRTestResult

OCR inspection results handler.

OCRTestResult is a handle of OCR's inspection results. Users can get the inspection results(SR_OCRTextBox) after each inspection through a created OCRTestResult.

See also
SR_MakeOCRTestResult, SR_DeleteOCRTestResult

Function Documentation

◆ SR_CreateOCRTestHandle()

OCRTestHandle SR_CreateOCRTestHandle ( const char *  ocrBoxFilePath,
const char *  ocrTextFilePath 
)

Create a OCRTestHandle via multi byte char path.

Parameters
ocrBoxFilePathfile path of box-stage model (.srOcrBox)
ocrTextFilePathfile path of text-stage model (.srOcrText)
Returns
OCR file handler. Return nullptr if ocrBoxFilePath is invalid.
See also
SR_CreateOCRTestHandleByWideCharPath
Warning
OCRTestHandle should be destroyed by SR_DestroyOCRTestHandle after inspection finished.

◆ SR_CreateOCRTestHandleByWideCharPath()

OCRTestHandle SR_CreateOCRTestHandleByWideCharPath ( const wchar_t *  ocrBoxFilePath,
const wchar_t *  ocrTextFilePath 
)

Create a OCRTestHandle via wide char path.

Parameters
ocrBoxFilePathfile path of box-stage model (.srOcrBox)
ocrTextFilePathfile path of text-stage model (.srOcrText)
Returns
OCR file handler. Return nullptr if ocrBoxFilePath is invalid.
See also
SR_CreateOCRTestHandle
Warning
OCRTestHandle should be destroyed by SR_DestroyOCRTestHandle after inspection finished.
Examples
ExampleOCRErrorHandling.cpp, ExampleOCRRuntime.cpp, and ExampleOCRRuntimeSimple.cpp.

◆ SR_MakeOCRTestResult()

OCRTestResult SR_MakeOCRTestResult ( )

Construct a OCRTestResult.

Warning
OCRTestResult should be destroyed by SR_DeleteOCRTestResult after inspection finished.
Examples
ExampleOCRRuntime.cpp, and ExampleOCRRuntimeSimple.cpp.