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

Header file for Detection Module. More...

#include "CommonHeaderDLL.h"

Go to the source code of this file.

Typedefs

typedef void * DetTestHandle
 Detection file handler. More...
 
typedef void * DetTestResult
 Detection inspection results handler. More...
 

Functions

DetTestHandle SR_CreateDetTestHandle (const char *filePath)
 Create a DetTestHandle via multi byte char path. More...
 
eErrorType SR_CreateDetTestHandle_ErrorType (DetTestHandle *detTestHandle, const char *filePath)
 Create a DetTestHandle via multi byte char path. More...
 
DetTestHandle SR_CreateDetTestHandleByWideCharPath (const wchar_t *filePath)
 Create a DetTestHandle via wide char path. More...
 
eErrorType SR_CreateDetTestHandleByWideCharPath_ErrorType (DetTestHandle *detTestHandle, const wchar_t *filePath)
 Create a DetTestHandle via wide char path. More...
 
DetTestResult SR_MakeDetTestResult ()
 Construct a DetTestResult. More...
 
eErrorType SR_MakeDetTestResult_ErrorType (DetTestResult *detTestResult)
 Construct a DetTestResult. More...
 
eErrorType SR_LoadDetTestNetworkInGPU (DetTestHandle handle, int GPUNumber)
 Allocate required cpu & gpu memory. More...
 
eErrorType SR_GetDetTestAlgorithmType (DetTestHandle handle, eAlgorithmType *algoType)
 Get a algorithm type(ex, standard, deep) of a detection model.
 
eErrorType SR_PrintDetTestParameters (DetTestHandle handle)
 Print a model parameters (Detection's class information, inspection options...)
 
eErrorType SR_GetDetTestNumberOfClasses (DetTestHandle handle, int *numberOfClasses)
 Get the number of classes. More...
 
eErrorType SR_GetDetTestMaxStrLenOfClassName (DetTestHandle handle, int *len)
 Get a maximum length of class name. More...
 
eErrorType SR_GetDetTestOneClassNameWithWideChar (DetTestHandle handle, const int classIdx, wchar_t *className)
 Get a wide char name of certain class by given index. More...
 
eErrorType SR_GetDetTestOneClassNameWithMultiByteChar (DetTestHandle handle, const int classIdx, char *className)
 Get a multi byte char name of certain class by given index. More...
 
eErrorType SR_GetDetTestOneClassColor (DetTestHandle handle, const int classIdx, int *classColor)
 Get a color of certain class by given index. More...
 
eErrorType SR_GetDetTrainedVersion (DetTestHandle handle, int *trainedVersionMajor, int *trainedVersionMinor, int *trainedVersionPatch)
 Get a trained version of model file, -1 means before v1.4.8. More...
 
eErrorType SR_GetDetTestMaxNumberOfDetectionBoxesForEachClass (DetTestHandle handle, int *maxNumBoxes)
 Get Max number of boxes. More...
 
eErrorType SR_SetDetTestMaxNumberOfDetectionBoxesForEachClass (DetTestHandle handle, int numOfClasses, int *maxNumBoxes, bool writeOnModelFile=true)
 Set Max number of boxes. More...
 
eErrorType SR_GetDetTestMinScoreThresholdForSingleClass (DetTestHandle handle, const int classIdx, int *scoreThreshold)
 Get Detection's score threshold for single class. More...
 
eErrorType SR_GetDetTestMinScoreThreshold (DetTestHandle handle, int *scoreThreshold)
 Get Detection's score threshold for each class. More...
 
eErrorType SR_SetDetTestMinScoreThreshold (DetTestHandle handle, int numOfClasses, int *scoreThreshold, bool writeOnModelFile=true)
 Set Detection's score threshold for each class. More...
 
eErrorType SR_GetDetTestPixelSizeThreshold (DetTestHandle handle, int *areaThreshold)
 Get Detection's area threshold for each class. More...
 
eErrorType SR_SetDetTestPixelSizeThreshold (DetTestHandle handle, int *areaThreshold, bool writeOnModelFile=true)
 Set Detection's area threshold for each class. More...
 
eErrorType SR_GetDetTestCropSize (DetTestHandle handle, int *numHorizontalCroppedPatches, int *numVerticalCroppedPatches)
 Get the number of horizontally and vertically cropped patches. More...
 
eErrorType SR_SetDetTestCropDetectedBoxesOptions (DetTestHandle handle, bool isToStoreCroppedImage, int defaultCropSize=-1, eModeOfCropLargeObjects modeOfCropLargeObjects=SR_CROP_BY_OBJECTSIZE_NOT_SQUARE, float margin=0.00, bool writeOnModelFile=true)
 Set the parameters of Detection's crop box. More...
 
eErrorType SR_GetDetFilterObjByRegion (DetTestHandle handle, eFilterObjByRegionType *filterObjType)
 Get the filtering object type by Detection's filter object by region. More...
 
eErrorType SR_GetDetFilterObjSimpleParameters (DetTestHandle handle, float *simpleParams)
 Get the simple parameters of filtering object by Detection's filter object by region. More...
 
eErrorType SR_SetDetFilterObjByRegion (DetTestHandle handle, eFilterObjByRegionType filterObjType, bool writeOnModelFile=true)
 Set the filtering object type by Detection's filter object by region. More...
 
eErrorType SR_SetDetFilterObjSimpleParameters (DetTestHandle handle, float *simpleParams, bool writeOnModelFile=true)
 Set the simple parameters of filtering object by Detection's filter object by region. More...
 
eErrorType SR_GetDetTestForwardTimeLimit (DetTestHandle handle, float *forwardTimeLimit)
 Get the Forward time limit. More...
 
eErrorType SR_GetDetTestIsToUseForwardTimeLimit (DetTestHandle handle, bool *bIsToUseForwardTimeLimit)
 Get the boolean whether the current model is using time limit or not. More...
 
eErrorType SR_GetDetTestForwardTimeLimitVariables (DetTestHandle handle, float *forwardTimeLimit, bool *bIsToUseForwardTimeLimit)
 Get the Forward time limit variables. More...
 
eErrorType SR_SetDetTestForwardTimeLimit (DetTestHandle handle, float forwardTimeLimit, bool writeOnModelFile=true)
 Set the Forward time limit. More...
 
eErrorType SR_SetDetTestIsToUseForwardTimeLimit (DetTestHandle handle, bool bIsToUseForwardTimeLimit, bool writeOnModelFile=true)
 Set the boolean whether the current model is using time limit or not. More...
 
eErrorType SR_SetDetTestForwardTimeLimitVariables (DetTestHandle handle, float forwardTimeLimit, bool bIsToUseForwardTimeLimit, bool writeOnModelFile=true)
 Set the Forward time limit variables. More...
 
eErrorType SR_ApplyDetTestFromImageFile (DetTestHandle handle, const char *imagePath, DetTestResult detTestResult)
 Apply detection algorithm to image by file path. More...
 
eErrorType SR_ApplyDetTestFromImageFileByWideCharPath (DetTestHandle handle, const wchar_t *imagePath, DetTestResult detTestResult)
 Apply detection algorithm to image by file path. More...
 
eErrorType SR_ApplyDetTestFrom8bitCharGrayArray (DetTestHandle handle, const unsigned char *imageData, const int height, const int width, DetTestResult detTestResult)
 Apply detection algorithm to 1-channel image by 8-bit data. More...
 
eErrorType SR_ApplyDetTestFrom8bitCharColorArray (DetTestHandle handle, const unsigned char *imageData, const int height, const int width, DetTestResult detTestResult)
 Apply detection algorithm to 3-channels(BGR) image by 8-bit data. More...
 
eErrorType SR_ApplyDetTestFromUnsignedIntColorArray (DetTestHandle handle, const unsigned int *imageData, const int height, const int width, DetTestResult detTestResult)
 Apply detection algorithm to 4-channels(BGRA) image by 8-bit data. More...
 
eErrorType SR_GetDetTestResultNumberOfBoxes (DetTestResult detTestResult, int *numDetectedBoxes)
 Get the number of detected boxes. More...
 
eErrorType SR_GetDetTestResultDetectedBoxes (DetTestResult detTestResult, const int numDetectedBoxes, SR_DetectedBox *detectedBoxes)
 Get SR_DetectedBox. More...
 
eErrorType SR_GetDetTestResultAllBoxesInfo (DetTestResult detTestResult, const int numDetectedBoxes, int *classIndices, float *scores, int *coordinatesXYXY)
 Get all the detected boxes. More...
 
eErrorType SR_GetDetTestResultOneBoxInfo (DetTestResult detTestResult, const int boxIndex, int *classIndex, float *score, int *coordinateXYXY)
 Get a single detected box. More...
 
eErrorType SR_GetDetTestResultNumberOfBoxesBeforeFiltered (DetTestResult detTestResult, int numClasses, int *numRawBoxes)
 Get the number of raw detected boxes before filtered by Max number of boxes for each class. More...
 
eErrorType SR_GetDetTestInspectionTime (DetTestResult detTestResult, long *inspectionTimeInLong)
 Get the inspection time. More...
 
eErrorType SR_GetDetTestInspectionTimeInDouble (DetTestResult detTestResult, double *inspectionTimeInDouble)
 Get the inspection time. More...
 
eErrorType SR_GetDetTestLoadImageTime (DetTestResult detTestResult, long *imageLoadingTimeInLong)
 Get the image loading time. More...
 
eErrorType SR_GetDetTestLoadImageTimeInDouble (DetTestResult detTestResult, double *imageLoadingTimeInDouble)
 Get the image loading time. More...
 
eErrorType SR_DestroyDetTestHandle (DetTestHandle handle)
 Destruct a DetTestHandle.
 
eErrorType SR_DeleteDetTestResult (DetTestResult detTestResult)
 Destruct a DetTestResult.
 
eErrorType SR_SetDetTestOptionsAsDefault (DetTestHandle handle)
 Reset inspection options(Forward time limit, Detection's score threshold etc) as default values. More...
 
eErrorType SR_WriteDetTestOptionsOnModelFile (DetTestHandle handle)
 Write inspection options(Forward time limit, Detection's score threshold etc) on model file.
 

Detailed Description

Header file for Detection Module.

Function Documentation

◆ SR_GetDetTestCropSize()

eErrorType SR_GetDetTestCropSize ( DetTestHandle  handle,
int *  numHorizontalCroppedPatches,
int *  numVerticalCroppedPatches 
)

Get the number of horizontally and vertically cropped patches.

Parameters
handledetection file handler
[out]numHorizontalCroppedPatches
[out]numVerticalCroppedPatches