ClassifierTestDLL.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __linux__
    #define DLLTYPE_CLASSIFICATION
#elif _WIN32
    #ifdef DLLEXPORT_CLASSIFICATION
    #define DLLTYPE_CLASSIFICATION extern "C" __declspec(dllexport)
    #else
    #define DLLTYPE_CLASSIFICATION extern "C" __declspec(dllimport)
    #endif
#endif
 
#include "CommonHeaderDLL.h"
 
typedef void* ClsTestHandle;
typedef void* ClsTestResult;
 
DLLTYPE_CLASSIFICATION ClsTestHandle    SR_CreateClsTestHandle(const char* filePath);
 
DLLTYPE_CLASSIFICATION ClsTestHandle    SR_CreateClsTestHandleByWideCharPath(const wchar_t* filePath);
 
DLLTYPE_CLASSIFICATION ClsTestResult    SR_MakeClsTestResult();
DLLTYPE_CLASSIFICATION eErrorType       SR_LoadClsTestNetworkInGPU(ClsTestHandle handle,
                                                                    int GPUNumber,
                                                                    int batchSize = 1);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestAlgorithmType(ClsTestHandle handle,
                                                                    eAlgorithmType* algoType);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_PrintClsTestParameters(ClsTestHandle handle);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestNumberOfClasses(ClsTestHandle handle,
                                                                    int* numberOfClasses);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestMaxStrLenOfClassName(ClsTestHandle handle,
                                                                            int* len);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestOneClassNameWithWideChar(ClsTestHandle handle,
                                                                                const int classIdx,
                                                                                wchar_t* className);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestOneClassNameWithMultiByteChar(ClsTestHandle handle,
                                                                                    const int classIdx,
                                                                                    char* className);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestOneClassColor(ClsTestHandle handle,
                                                                    const int classIdx,
                                                                    int* classColor);
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestMedianImageSize(ClsTestHandle handle,
                                                                    int* height,
                                                                    int* width);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestAdditionalScore(ClsTestHandle handle, 
                                                                    int* additionalScores);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_SetClsTestAdditionalScore(ClsTestHandle handle, 
                                                                        int numOfClasses,
                                                                        int* additionalScores,
                                                                        bool writeOnModelFile = true);
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestForwardTimeLimit(ClsTestHandle handle,
                                                                        float* forwardTimeLimit); /* milliseconds */
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestIsToUseForwardTimeLimit(ClsTestHandle handle,
                                                                            bool* bIsToUseForwardTimeLimit);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestForwardTimeLimitVariables(ClsTestHandle handle,
                                                                                float* forwardTimeLimit,  /* milliseconds */
                                                                                bool* bIsToUseForwardTimeLimit);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_SetClsTestForwardTimeLimit(ClsTestHandle handle,
                                                                        float forwardTimeLimit,  /* milliseconds */
                                                                        bool writeOnModelFile = true);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_SetClsTestIsToUseForwardTimeLimit(ClsTestHandle handle,
                                                                            bool bIsToUseForwardTimeLimit,
                                                                            bool writeOnModelFile = true);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_SetClsTestForwardTimeLimitVariables(ClsTestHandle handle,
                                                                                float forwardTimeLimit, /* milliseconds */
                                                                                bool bIsToUseForwardTimeLimit,
                                                                                bool writeOnModelFile = true);
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFromImageFile(ClsTestHandle handle,
                                                                    const char* imagePath,
                                                                    ClsTestResult clsTestResult);
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFromImageFileByWideCharPath(ClsTestHandle handle,
                                                                                    const wchar_t* imagePath,
                                                                                    ClsTestResult clsTestResult);
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFrom8bitCharGrayArray(ClsTestHandle handle,
                                                                            const unsigned char* imageData,
                                                                            const int height,
                                                                            const int width,
                                                                            ClsTestResult clsTestResult);
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFrom8bitCharColorArray(ClsTestHandle handle,
                                                                                const unsigned char* imageData,
                                                                                const int height,
                                                                                const int width,
                                                                                ClsTestResult clsTestResult);
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFromUnsignedIntColorArray(ClsTestHandle handle,
                                                                                    const unsigned int* imageData,
                                                                                    const int height,
                                                                                    const int width,
                                                                                    ClsTestResult clsTestResult);
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFromMultiple8bitCharGrayArrays(ClsTestHandle handle,
                                                                                        int numberOfImages,
                                                                                        unsigned char** imageData,
                                                                                        int* heights,
                                                                                        int* widths,
                                                                                        ClsTestResult* clsTestResults);
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFromMultiple8bitCharColorArrays(ClsTestHandle handle,
                                                                                        int numberOfImages,
                                                                                        unsigned char** imageData,
                                                                                        int* heights,
                                                                                        int* widths,
                                                                                        ClsTestResult* clsTestResults);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFromMultipleUnsignedIntColorArrays(ClsTestHandle handle,
                                                                                            int numberOfImages,
                                                                                            unsigned int** imageData,
                                                                                            int* heights,
                                                                                            int* widths,
                                                                                            ClsTestResult* clsTestResults);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFromSegmentedObjects(ClsTestHandle handle,
                                                                            int numberOfObjects,
                                                                            SR_SegmentedObject* segmentedObjects,
                                                                            ClsTestResult* clsTestResults);
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestResultScore(ClsTestResult clsTestResult,
                                                                const int numClasses,
                                                                int* scores,
                                                                bool includeAddScore = false);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestResultClass(ClsTestResult clsTestResult,
                                                                int* classIdx);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestInspectionTime(ClsTestResult clsTestResult,
    long* inspectionTimeInLong); /* milliseconds */
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestInspectionTimeInDouble(ClsTestResult clsTestResult,
    double* inspectionTimeInDouble); /* milliseconds */
 
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestLoadImageTime(ClsTestResult clsTestResult,
    long* imageLoadingTimeInLong); /* milliseconds */
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestLoadImageTimeInDouble(ClsTestResult clsTestResult,
    double* imageLoadingTimeInDouble); /* milliseconds */
DLLTYPE_CLASSIFICATION eErrorType       SR_DestroyClsTestHandle(ClsTestHandle handle);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_DeleteClsTestResult(ClsTestResult clsTestResult);
DLLTYPE_CLASSIFICATION eErrorType       SR_SetClsTestOptionsAsDefault(ClsTestHandle handle);
 
DLLTYPE_CLASSIFICATION eErrorType       SR_WriteClsTestOptionsOnModelFile(ClsTestHandle handle);
 
/***********************************************************
* For SaigeVision software 
***********************************************************/
/* Apply classification algorithms to a single image via multi byte char path.
* Users can get an activation map after apply this function.
*/
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFromImageFileWithActivationMap(ClsTestHandle handle,
                                                                                        const char* imagePath,
                                                                                        ClsTestResult clsTestResultOutput);
 
/* Apply classification algorithms to a single image via wide char path.
* Users can get an activation map after apply this function.
*/
DLLTYPE_CLASSIFICATION eErrorType       SR_ApplyClsTestFromImageFileWithActivationMapByWideCharPath(ClsTestHandle handle,
                                                                                                    const wchar_t* imagePath,
                                                                                                    ClsTestResult clsTestResultOutput);
 
/* Get the shape (width, height) of the activation map*/
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestActivationMapShape(ClsTestHandle handle,
                                                                        int* activationMapWidthOutput,
                                                                        int* activationMapHeightOutput);
 
/* Get the float pointer of the activation map*/
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestActivationMap(ClsTestHandle handle,
                                                                    float* activationMapOutput);
 
 
#ifdef SR_USE_DEPRECATED_FUNCTIONS
/***********************************************************
* These functions will be deprecated in version 2.0.0
***********************************************************/
/* This function behaves identically with SR_GetClsTestOneClassNameWithWideChar*/
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestOneClassName(ClsTestHandle handle, const int index, wchar_t* classNameOutput);
 
/* This function behaves identically with SR_GetClsTestOneClassNameWithMultiByteChar*/
DLLTYPE_CLASSIFICATION eErrorType       SR_GetClsTestOneClassNameWith1byteCharacter(ClsTestHandle handle, const int index, char* classNameOutput);
#endif