SaigeVision C/C++ 1.5.0
SaigeVision API document for C/C++
 
Loading...
Searching...
No Matches
OCRTestDLL.h File Reference

Header file for OCR Module. More...

#include "CommonHeaderDLL.h"

Go to the source code of this file.

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...
 
eErrorType SR_CreateOCRTestHandle_ErrorType (OCRTestHandle *ocrTestHandle, 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...
 
eErrorType SR_CreateOCRTestHandleByWideCharPath_ErrorType (OCRTestHandle *ocrTestHandle, const wchar_t *ocrBoxFilePath, const wchar_t *ocrTextFilePath)
 Create a OCRTestHandle via wide char path. More...
 
OCRTestResult SR_MakeOCRTestResult ()
 Construct a OCRTestResult. More...
 
eErrorType SR_MakeOCRTestResult_ErrorType (OCRTestResult *ocrTestResult)
 Construct a OCRTestResult. More...
 
eErrorType SR_LoadOCRTestNetworkInGPU (OCRTestHandle handle, int GPUNumber)
 Allocate required cpu & gpu memory. More...
 
eErrorType SR_GetOCRTestAlgorithmType (OCRTestHandle handle, eAlgorithmType *boxAlgoTypeOut, eAlgorithmType *textAlgoTypeOut)
 Get a algorithm type(ex, standard, deep) of OCR models.
 
eErrorType SR_PrintOCRTestParameters (OCRTestHandle handle)
 Print a model parameters (inspection options...)
 
eErrorType SR_GetOCRTrainedVersion (OCRTestHandle handle, int *trainedVersionMajor, int *trainedVersionMinor, int *trainedVersionPatch)
 Get a trained version of model file, -1 means before v1.4.8. More...
 
eErrorType SR_GetOCRTestScoreThreshold (OCRTestHandle handle, int *scoreThreshold)
 Get OCR's score threshold. More...
 
eErrorType SR_SetOCRTestScoreThreshold (OCRTestHandle handle, int scoreThreshold, bool writeOnModelFile=true)
 Set OCR's score threshold. More...
 
eErrorType SR_GetOCRTestAreaThreshold (OCRTestHandle handle, int *areaThreshold)
 Get OCR's area threshold. More...
 
eErrorType SR_SetOCRTestAreaThreshold (OCRTestHandle handle, int areaThreshold, bool writeOnModelFile=true)
 Get OCR's area threshold. More...
 
eErrorType SR_SetOCRTestCharsToExclude (OCRTestHandle handle, int nCharsToExclude, wchar_t *charsToExclude, bool writeOnModelFile=true)
 검사에서 제외할 문자(OCR's excluded characters)를 설정합니다. More...
 
eErrorType SR_SetOCRTestMaxInspectionSize (OCRTestHandle handle, int maxInspectionHeight, int maxInspectionWidth, bool writeOnModelFile=true)
 Set OCR's max inspection size. More...
 
eErrorType SR_GetOCRTestMaxInspectionSize (OCRTestHandle handle, int *maxInspectionHeight, int *maxInspectionWidth)
 Get OCR's max inspection size. More...
 
eErrorType SR_GetOCRTestForwardTimeLimit (OCRTestHandle handle, float *forwardTimeLimit)
 Get the Forward time limit. More...
 
eErrorType SR_GetOCRTestIsToUseForwardTimeLimit (OCRTestHandle handle, bool *bIsToUseForwardTimeLimit)
 Get the boolean whether the current model is using time limit or not. More...
 
eErrorType SR_GetOCRTestForwardTimeLimitVariables (OCRTestHandle handle, float *forwardTimeLimit, bool *bIsToUseForwardTimeLimit)
 Get the Forward time limit variables. More...
 
eErrorType SR_SetOCRTestForwardTimeLimit (OCRTestHandle handle, float forwardTimeLimit, bool writeOnModelFile=true)
 Set the Forward time limit. More...
 
eErrorType SR_SetOCRTestIsToUseForwardTimeLimit (OCRTestHandle handle, bool bIsToUseForwardTimeLimit, bool writeOnModelFile=true)
 Set the boolean whether the current model is using time limit or not. More...
 
eErrorType SR_SetOCRTestForwardTimeLimitVariables (OCRTestHandle handle, float forwardTimeLimit, bool bIsToUseForwardTimeLimit, bool writeOnModelFile=true)
 Set the Forward time limit variables. More...
 
eErrorType SR_ApplyOCRTestFromImageFile (OCRTestHandle handle, const char *imagePath, OCRTestResult ocrTestResult)
 Apply OCR algorithm to image by file path. More...
 
eErrorType SR_ApplyOCRTestFromImageFileByWideCharPath (OCRTestHandle handle, const wchar_t *imagePath, OCRTestResult ocrTestResult)
 Apply OCR algorithm to image by file path. More...
 
eErrorType SR_ApplyOCRTestFrom8bitImageData (OCRTestHandle handle, const void *imageData, const int height, const int width, const int channels, OCRTestResult ocrTestResult)
 Apply OCR algorithm to 1 or 3 or 4 channels image by 8-bit data. More...
 
eErrorType SR_GetOCRTestNumberOfTextBoxes (OCRTestResult ocrTestResult, int *numberOfOCRTextBoxes)
 Get the number of SR_OCRTextBox. More...
 
eErrorType SR_GetOCRTestTextBoxes (OCRTestResult ocrTestResult, SR_OCRTextBox *ocrTextBoxes)
 Get SR_OCRTextBox s. More...
 
eErrorType SR_GetOCRTestInspectionTime (OCRTestResult ocrTestResult, long *inspectionTimeInLong)
 Get the inspection time. More...
 
eErrorType SR_GetOCRTestInspectionTimeInDouble (OCRTestResult ocrTestResult, double *inspectionTimeInDouble)
 Get the inspection time. More...
 
eErrorType SR_GetOCRTestLoadImageTime (OCRTestResult ocrTestResult, long *imageLoadingTimeInLong)
 Get the image loading time. More...
 
eErrorType SR_GetOCRTestLoadImageTimeInDouble (OCRTestResult ocrTestResult, double *imageLoadingTimeInDouble)
 Get the image loading time. More...
 
eErrorType SR_DestroyOCRTestHandle (OCRTestHandle handle)
 Destruct a OCRTestHandle.
 
eErrorType SR_DeleteOCRTestResult (OCRTestResult ocrTestResult)
 Destruct a OCRTestResult.
 
eErrorType SR_SetOCRTestOptionsAsDefault (OCRTestHandle handle)
 Reset inspection options(OCR's area threshold, OCR's score threshold) as default values. More...
 
eErrorType SR_WriteOCRTestOptionsOnModelFile (OCRTestHandle handle)
 Write inspection options(OCR's area threshold, OCR's score threshold) on model file.
 
eErrorType SR_SetOCRTestResizeFactor (OCRTestHandle handle, float resizeFactor, bool writeOnModelFile)
 Set resize factor for default model.
 
eErrorType SR_SetOCRTestROIParameters (OCRTestHandle handle, int roiType, float *simpleROIParams, int *adROIParams, int numOfRectMask, float *rectMaskXMin, float *rectMaskYMin, float *rectMaskWidth, float *rectMaskHeight, int numOfEllipseMask, float *ellipseMaskXMin, float *ellipseMaskYMin, float *ellipseMaskWidth, float *ellipseMaskHeight, bool writeOnModelFile=true)
 Set ROI parameters for inspection in label tab.
 

Detailed Description

Header file for OCR Module.

Function Documentation

◆ SR_GetOCRTrainedVersion()

eErrorType SR_GetOCRTrainedVersion ( OCRTestHandle  handle,
int *  trainedVersionMajor,
int *  trainedVersionMinor,
int *  trainedVersionPatch 
)

Get a trained version of model file, -1 means before v1.4.8.

Parameters
handleOCR file handler
[out]trainedversion major
[out]trainedversion minor
[out]trainedversion patch level

◆ SR_SetOCRTestOptionsAsDefault()

eErrorType SR_SetOCRTestOptionsAsDefault ( OCRTestHandle  handle)