ExampleClsRuntime.cpp

This is an example of how to inspect sample images by using all the functions of cls module. More details about this example.

 
#include "ClassifierTestDLL.h"
#include "SRUtils.h"
 
/* define this variable when user want to use new additional score other than preset values. */
//#define SR_USE_NEW_ADDITIONAL_SCORE
 
/* define this variable when user want to get class activation map */
//#define SR_GET_CLASS_ACTIVATION_MAP
 
/* define this variable when user want to limit the forward time of classfication algorithm. */
//#define SR_USE_FORWARD_TIME_LIMIT
 
int main()
{
    std::wstring data_dir = L"../../../examples/data";
 
    // trained model path
    std::wstring trainedModelPath = data_dir + L"/models/textile_sample_model.srCls";
 
    // image paths to classify
    std::vector<std::wstring> imagePaths(6);
    imagePaths[0] = data_dir + L"/images/Textile/class1_ok/000001.png";
    imagePaths[1] = data_dir + L"/images/Textile/class1_ng/000002.png";
    imagePaths[2] = data_dir + L"/images/Textile/class2_ok/000001.png";
    imagePaths[3] = data_dir + L"/images/Textile/class2_ng/000002.png";
    imagePaths[4] = data_dir + L"/images/Textile/class3_ok/000001.png";
    imagePaths[5] = data_dir + L"/images/Textile/class3_ng/000002.png";
 
    eErrorType srStatus = eErrorType::NO_ERROR_OUT;
 
    /***********************************************************
    *    0. 이미지 인풋 타입 설정, Set input type of images
    *    inputImageType -
    *             ImageFilePathMultiByteChar:   from file path (multi byte char)
    *             ImageFilePathWideChar: from file path (wide char)
    *             UCGrayImage:  from memory(8bit unsigned char gray image)
    *             UCColorImage: from memory(8bit unsigned char color image)
    *             UIColorImage: from memory(32bit unsigned int color image)
    ***********************************************************/
    //eSRInputImageType inputImageType = eSRInputImageType::ImageFilePathMultiByteChar;
    //eSRInputImageType inputImageType = eSRInputImageType::ImageFilePathWideChar;
    //eSRInputImageType inputImageType = eSRInputImageType::UCGrayImage;
    eSRInputImageType inputImageType = eSRInputImageType::UCColorImage;
    //eSRInputImageType inputImageType = eSRInputImageType::UIColorImage;
 
    unsigned char* ucImageData = nullptr; // unsigned char image data
    unsigned int* uiImageData = nullptr; // unsigned int image data
 
    /***********************************************************
    *    0-1. 정보 띄우기 단계 설정 (Verbosity)
    *    verbosity -
    *             0:    only warning
    *             1:    warning + model info
    *             2:    warning + model info + result info
    *             3:    warning + model info + result info + image display
    *    displayTime - 결과 이미지 display 하는 시간 (milliseconds)
    *    resizeFactor - 결과 이미지 display 하는 스케일 (display 크기 = 원본 크기 * resizeFactor)
    ***********************************************************/
    int verbosity = 3;
    int displayTime = 100;
    double resizeFactor = 1.0;
 
    /***********************************************************
    *    0-2. GPU 번호 설정, index of gpu to use
    *    gpuIndex - 사용하고자 하는 gpu의 번호
    *       Multi GPU 가 가능한 License의 경우에 한하여 gpuIndex를
    *       0~3까지 설정해 줄 수 있다. 아닌 경우 gpuIndex는 0을 사용하여야 한다.
    ***********************************************************/
    int gpuIndex = 0;
 
    /***********************************************************
    *    1.  모델 파일 및 검사 결과 handle 생성,
    *        Create handles for model files and inspection results
    ***********************************************************/
    ClsTestHandle handle = nullptr;
    srStatus = SR_CreateClsTestHandleByWideCharPath_ErrorType(&handle, trainedModelPath.c_str());
    if (srStatus != NO_ERROR_OUT || handle == nullptr)
    {
        std::wcout << "Saige Vision failed: Please check the file path of trained model." << std::endl;
    }
 
    ClsTestResult clsTestResult = nullptr;
    srStatus = SR_MakeClsTestResult_ErrorType(&clsTestResult);
    if (srStatus != NO_ERROR_OUT || clsTestResult == nullptr)
    {
        PrintErrorType(srStatus, verbosity);
        SR_DestroyClsTestHandle(handle);
        return -1;
    }
 
    /***********************************************************
    *    2. 클래스 정보 확인 (Optional)
    *       Check class information
    ***********************************************************/
    // Print classification Test Parameters() by calling one fuctions
    srStatus = SR_PrintClsTestParameters(handle);
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that the handle is not created.
        SR_DestroyClsTestHandle(handle);
        return -1;
    }
 
    // Get classification test parameters one by one
    int numberOfClassesOutput = 0;
    int maxStrLenOfClassName = 0;
 
    // Get the number of classes
    srStatus = SR_GetClsTestNumberOfClasses(handle, &numberOfClassesOutput);
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that input pointer is not allocated (nullptr).
        SR_DestroyClsTestHandle(handle);
        return -1;
    }
 
    // Get the maximum length of class names
    srStatus = SR_GetClsTestMaxStrLenOfClassName(handle, &maxStrLenOfClassName);
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that input pointer is not allocated (nullptr).
        SR_DestroyClsTestHandle(handle);
        return -1;
    }
 
    std::vector<std::string> classNames(numberOfClassesOutput);
    std::vector<std::wstring> wClassNames(numberOfClassesOutput);
    std::vector<int> classColorsOutput(numberOfClassesOutput);
    std::vector<int> additionalScoreOutput(numberOfClassesOutput);
 
    char* classNameOutput = new char[maxStrLenOfClassName];
    wchar_t* wClassNameOutput = new wchar_t[maxStrLenOfClassName];
 
    for (int i = 0; i < numberOfClassesOutput; i++)
    {
        // Get a color of single class
        srStatus = SR_GetClsTestOneClassColor(handle, i, &(classColorsOutput[i]));
        if (srStatus != NO_ERROR_OUT)
        {
            PrintErrorType(srStatus, verbosity);
            // if you get this error, it's possible that the input index is out of bound(# of classes) or input pointer is not allocated (nullptr).
            SR_DestroyClsTestHandle(handle);
            return -1;
        }
 
        // Get a name of single class by multi byte char (char*)
        srStatus = SR_GetClsTestOneClassNameWithMultiByteChar(handle, i, classNameOutput);
        if (srStatus != NO_ERROR_OUT)
        {
            PrintErrorType(srStatus, verbosity);
            // if you get this error, it's possible that the input index is out of bound(# of classes) or input pointer is not allocated (nullptr).
            SR_DestroyClsTestHandle(handle);
            return -1;
        }
 
        // Get a name of single class by wide char (wchar_t*)
        srStatus = SR_GetClsTestOneClassNameWithWideChar(handle, i, wClassNameOutput);
        if (srStatus != NO_ERROR_OUT)
        {
            PrintErrorType(srStatus, verbosity);
            // if you get this error, it's possible that the input index is out of bound(# of classes) or input pointer is not allocated (nullptr).
            SR_DestroyClsTestHandle(handle);
            return -1;
        }
        classNames[i] = classNameOutput;
        wClassNames[i] = wClassNameOutput;
    }
 
    delete[] classNameOutput;
    delete[] wClassNameOutput;
 
    /***********************************************************
    *    3. 검사 옵션 확인 및 수정 (Optional)
    *       Check inspection options and set new values
    ***********************************************************/
    // Get the additional score for each class
    srStatus = SR_GetClsTestAdditionalScore(handle, additionalScoreOutput.data());
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that input pointer is not allocated (nullptr).
        SR_DestroyClsTestHandle(handle);
        return -1;
    }
#ifdef SR_USE_NEW_ADDITIONAL_SCORE
    std::vector<int> additionalScore(numberOfClassesOutput);
 
    for (int i = 0; i < numberOfClassesOutput; i++)
    {
        additionalScore[i] = 10;
    }
    srStatus = SR_SetClsTestAdditionalScore(handle, numberOfClassesOutput, additionalScore.data(), true);
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that the input's [# of classes] does not match the model's or input pointer is not allocated (nullptr).
        SR_DestroyClsTestHandle(handle);
        return -1;
    }
 
#endif
#ifdef SR_GET_CLASS_ACTIVATION_MAP
    // todo cam
    srStatus = SR_SetClsTestIsToStoreActivationMap(handle, true, false);
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that handle is not created.
        SR_DestroyClsTestHandle(handle);
        return -1;
    }
#endif
#ifdef SR_USE_FORWARD_TIME_LIMIT
    float timeLimit = 1000; // milliseconds
    srStatus = SR_SetClsTestForwardTimeLimitVariables(handle, timeLimit, true, true);
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that handle is not created.
        SR_DestroyClsTestHandle(handle);
        return -1;
    }
#endif
#ifndef SR_USE_FORWARD_TIME_LIMIT
    srStatus = SR_SetClsTestIsToUseForwardTimeLimit(handle, false, true);
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that handle is not created.
        SR_DestroyClsTestHandle(handle);
        return -1;
    }
#endif
 
    /***********************************************************
    *    4. 메모리를 GPU 및 CPU에 할당합니다.
    *       Allocate GPU and CPU memory
    ***********************************************************/
    srStatus = SR_LoadClsTestNetworkInGPU(handle, gpuIndex);
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that the inserted index is not applicable.
        SR_DestroyClsTestHandle(handle);
        return -1;
    }
 
 
    for (size_t i_img = 0; i_img < imagePaths.size(); i_img++)
    {
        int h = 0, w = 0;
        if (inputImageType == eSRInputImageType::UIColorImage)
        {
            uiImageData = (unsigned int*)GetImageDataByInputImageType(imagePaths[i_img], inputImageType, h, w);
        }
        else
        {
            ucImageData = (unsigned char*)GetImageDataByInputImageType(imagePaths[i_img], inputImageType, h, w);
        }
 
        /***********************************************************
        *    5. 이미지 검사하기, Inspect images
        ***********************************************************/
        if (inputImageType == eSRInputImageType::ImageFilePathMultiByteChar)
        {
            // Check if given image path(UNICODE) can be converted to ASCII CODE without any loss.
            size_t sizeOfChar = 0;
            size_t sizeOfWChar = wcslen(imagePaths[i_img].c_str());
            size_t bufferSize = sizeOfWChar * 2;
            std::vector<char> imagePathMB(bufferSize);
 
            sizeOfChar = wcstombs(
                imagePathMB.data(),
                imagePaths[i_img].c_str(),
                bufferSize
            );
 
            if (sizeOfChar != sizeOfWChar)
            {
                std::wcout << "Saige Vision FAILED: Wrong Image path" << imagePaths[i_img] << std::endl;
                continue;
            }
            srStatus = SR_ApplyClsTestFromImageFile(handle, imagePathMB.data(), clsTestResult);
        }
        else if (inputImageType == eSRInputImageType::ImageFilePathWideChar)
        {
            srStatus = SR_ApplyClsTestFromImageFileByWideCharPath(handle, imagePaths[i_img].c_str(), clsTestResult);
        }
        else if (inputImageType == eSRInputImageType::UCGrayImage)
        {
            srStatus = SR_ApplyClsTestFrom8bitCharGrayArray(handle, ucImageData, h, w, clsTestResult);
        }
        else if (inputImageType == eSRInputImageType::UCColorImage)
        {
            srStatus = SR_ApplyClsTestFrom8bitCharColorArray(handle, ucImageData, h, w, clsTestResult);
        }
        else if (inputImageType == eSRInputImageType::UIColorImage)
        {
            srStatus = SR_ApplyClsTestFromUnsignedIntColorArray(handle, uiImageData, h, w, clsTestResult);
        }
 
        if (srStatus != NO_ERROR_OUT)
        {
            PrintErrorType(srStatus, verbosity);
            // if you get this error, it's possible that the input data is not loaded successfully.
            if (verbosity >= 3)
            {
                DisplayFailedImageOnCVWindow(imagePaths[i_img], "FAIL TO CLASSIFY", "classification Result", displayTime, resizeFactor);
            }
            continue; // jump to next image
        }
 
        /***********************************************************
        *    6. 검사 결과 받아오기, Retrieve inspection results
        ***********************************************************/
        long inspectionTimeOutput = 0, loadImageTimeOutput = 0;
 
        SR_ClassifiedResult clsResult;
        srStatus = SR_GetClsTestClassifiedResult(clsTestResult, &clsResult);
        if (srStatus != NO_ERROR_OUT)
        {
            PrintErrorType(srStatus, verbosity);
            // if you get this error, it's possible that the input's [# of classes] does not match the result's or input pointer is not allocated (nullptr).
            continue; // jump to next image
        }
 
        // Get the inspection time
        srStatus = SR_GetClsTestInspectionTime(clsTestResult, &inspectionTimeOutput);
        if (srStatus != NO_ERROR_OUT)
        {
            PrintErrorType(srStatus, verbosity);
            // if you get this error, it's possible that the input pointer is not allocated (nullptr).
            continue; // jump to next image
        }
 
        // Get the image-loading time
        srStatus = SR_GetClsTestLoadImageTime(clsTestResult, &loadImageTimeOutput);
        if (srStatus != NO_ERROR_OUT)
        {
            PrintErrorType(srStatus, verbosity);
            // if you get this error, it's possible that the input pointer is not allocated (nullptr).
            continue; // jump to next image
        }
 
        // Display and draw
        if (verbosity >= 2)
        {
            std::cout << "====== classification Test Result ======" << std::endl;
            std::wcout << imagePaths[i_img] << std::endl;
            for (int j = 0; j < numberOfClassesOutput; j++)
            {
                std::cout << "  - " << j << "-th class score (original, with additional): " << clsResult.scoresOriginal[j] << '\t' << clsResult.scoresIncludingAdd[j] << std::endl;
            }
            std::cout << "  - Result Class: " << clsResult.classIdx << std::endl;
            std::cout << "  - Image Loading time: " << loadImageTimeOutput << std::endl;
            std::cout << "  - Inspection time: " << inspectionTimeOutput << std::endl;
        }
 
        if (verbosity >= 3)
        {
            cv::Mat image = cv::Mat();
 
            if (inputImageType == eSRInputImageType::UCGrayImage)
            {
                image = cv::Mat(h, w, CV_8UC1, ucImageData);
                image = image.clone(); /* to prevent modifying raw data */
            }
            else if (inputImageType == eSRInputImageType::UCColorImage)
            {
                image = cv::Mat(h, w, CV_8UC3, ucImageData);
                image = image.clone(); /* to prevent modifying raw data */
            }
            else if (inputImageType == eSRInputImageType::UIColorImage)
            {
                image = cv::Mat(h, w, CV_8UC4, uiImageData);
                image = image.clone(); /* to prevent modifying raw data */
            }
            else
            {
                int isSuccess = OpenImageFile(imagePaths[i_img].c_str(), image);
                if (isSuccess == 0)
                {
                    std::cout << "Saige Vision FAILED: Fail to open image file to display" << std::endl;
                    continue;
                }
            }
 
            if (image.channels() == 4)
            {
                cv::cvtColor(image, image, cv::COLOR_BGRA2BGR);
            }
            if (image.channels() == 1)
            {
                cv::cvtColor(image, image, cv::COLOR_GRAY2BGR);
            }
 
#ifdef SR_GET_CLASS_ACTIVATION_MAP
            if (clsResult.camImage != nullptr)
            {
                int xROI = 0, yROI = 0, wROI = 0, hROI = 0;
                SR_GetClsTestROI(clsTestResult, &xROI, &yROI, &wROI, &hROI);
 
                cv::Mat camImage = cv::Mat(clsResult.camImageHeight, clsResult.camImageWidth, CV_32FC1, clsResult.camImage);
                cv::resize(camImage, camImage, cv::Size(wROI, hROI), 0.0, 0.0, cv::INTER_CUBIC);
                camImage.convertTo(camImage, CV_8U);
                cv::applyColorMap(camImage, camImage, cv::COLORMAP_JET);
                cv::copyMakeBorder(camImage, camImage, yROI, h - yROI - hROI, xROI, w - xROI - wROI, cv::BORDER_CONSTANT, cv::Scalar(0.0, 0.0, 0.0));
 
                cv::Mat imageWithCam;
                double alpha = 0.7;
                double beta = 0.3;
                double gamma = 0.0;
                cv::addWeighted(image, alpha, camImage, beta, gamma, imageWithCam);
 
                cv::namedWindow("classification Result - cam", cv::WINDOW_NORMAL);
                cv::resizeWindow("classification Result - cam", imageWithCam.size().width * resizeFactor, imageWithCam.size().height * resizeFactor);
                cv::imshow("classification Result - cam", imageWithCam);
                cv::waitKey(displayTime);
            }
#endif
 
            // get class color
            int colorTmp = classColorsOutput[clsResult.classIdx];
            unsigned char r = (colorTmp >> 16) & 0xFF;
            unsigned char g = (colorTmp >> 8) & 0xFF;
            unsigned char b = (colorTmp) & 0xFF;
            cv::Scalar classColor = cv::Scalar(b, g, r);
 
            cv::putText(image, classNames[clsResult.classIdx],
                cv::Point(int(image.size().width * 0.1), int(image.size().height * 0.9)), // Coordinates
                cv::FONT_HERSHEY_COMPLEX_SMALL, // Font
                2.0, // Scale. 2.0 = 2x bigger
                classColor, // BGR Color
                4 // Line Thickness (Optional)
            );
 
            cv::namedWindow("classification Result", cv::WINDOW_NORMAL);
            cv::resizeWindow("classification Result", image.size().width * resizeFactor, image.size().height * resizeFactor);
            cv::imshow("classification Result", image);
            cv::waitKey(displayTime);
        }
 
        if (ucImageData != nullptr)
        {
            delete[] ucImageData;
        }
        if (uiImageData != nullptr)
        {
            delete[] uiImageData;
        }
    }
 
    /***********************************************************
    *    7. Handle 파괴, Destruct handles
    ***********************************************************/
    srStatus = SR_DeleteClsTestResult(clsTestResult);
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that the input pointer is not allocated (nullptr).
        return -1;
    }
    srStatus = SR_DestroyClsTestHandle(handle);
    if (srStatus != NO_ERROR_OUT)
    {
        PrintErrorType(srStatus, verbosity);
        // if you get this error, it's possible that the input pointer is not allocated (nullptr).
        return -1;
    }
 
    std::cout << "SaigeVision successfully completed, please press enter key to terminate" << std::endl;
    std::cin.get();
 
    return 0;
}