CommonHeaderDLL.h File Reference

Header file for Commonly used variables. More...

#include <stdio.h>

Go to the source code of this file.

Classes
struct	SR_SegmentedObject
	Struct describing features of a segmentation object. More...
struct	SR_RotatedBox
	Structure describing features for a rotated rectangle. More...
struct	SR_DetectedBox
	Struct describing features of a detected box. More...
struct	SR_OCRTextBox
	Structure describing features of a OCR object. More...
struct	SR_ClassifiedResult
	Struct describing result of classification. More...

Macros
#define	SAIGEVISION_MAJOR   1
	Saige Vision Major Version.
#define	SAIGEVISION_MINOR   6
	Saige Vision Minor Version.
#define	SAIGEVISION_PATCHLEVEL   0
	Saige Vision Patch Level.
#define	SAIGEVISION_MINORPATCHLEVEL   0
	Saige Vision Minor Patch Level.
#define	SAIGEVISION_VERSION   (SAIGEVISION_MAJOR * SAIGEVISION_MAJOR_DIGIT + SAIGEVISION_MINOR * SAIGEVISION_MINOR_DIGIT + SAIGEVISION_PATCHLEVEL)
	Saige Vision Version.
#define	SR_USE_DEPRECATED_FUNCTIONS
	Usage flag of deprecated functions. More...

Enumerations
enum	eErrorType {   NO_ERROR_OUT = 0 , NO_LICENCE = 101 , USE_NOT_ALLOCATED_HANDLER = 102 , INAPPROPRIATE_HANDLER = 103 ,   OUT_OF_GPU_MEMORY = 104 , INAPPROPRIATE_GPU_NUMBER = 105 , NULL_INPUT = 106 , INAPPROPRIATE_INPUT = 107 ,   FILE_NOT_FOUND = 108 , NULL_HANDLE_FILE_PATH = 109 , EMPTY_IMAGE = 110 , SMALL_IMAGE = 111 ,   NOT_LOAD_NETWORK_IN_GPU = 113 , FORWARD_ALGO_TIMEOUT = 114 , INAPPROPRIATE_OUTPUT = 115 , LOW_VERSION_LICENSE = 116 ,   NO_LICENSE_DONGLE = 117 , LOW_VERSION_FILE = 118 , LICENSE_EXPIRED = 119 , NOT_SUPPORTED_FUNCTION = 120 ,   UNKNOWN_ERROR = 1000 }
	Enumerator indicating error codes. More...
enum	eAlgorithmType {   Classification_V1 = 0 , Classification_V2 = 1 , Classification_V3 = 2 , Detection_V1 = 10 ,   Detection_V2 = 11 , Segmentation_V1 = 20 , Segmentation_V2 = 21 , Segmentation_V3 = 22 ,   DefectGenerator_V1 = 30 , OCR_Box_V1 = 40 , OCR_Text_V1 = 41 , SuperResolution_V1 = 60 }
	Enumerator indicating a type of model. More...
enum	eHandlerType {   ClsTrainType , ClsTestType , DetTrainType , DetTestType ,   SegTrainType , SegTestType , GenTrainType , GenTestType ,   OCRTrainType , OCRTestType , SuperResolutionTrainType , SuperResolutionTestType }
	Enumerator indicating a type of handler. More...
enum	eModeOfPixelSizeFilter { SR_PIXELSIZE_FILTER_MODE_OFF = 0 , SR_PIXELSIZE_FILTER_MODE_ON_FAST = 1 , SR_PIXELSIZE_FILTER_MODE_ON_EXACT = 2 }
	Enumerator indicating a mode of filtering by object's area in segmentation. More...
enum	eModeOfCropLargeObjects { SR_CROP_BY_OBJECTSIZE_N_RESIZE_TO_CROPSIZE = 0 , SR_CROP_BY_OBJECTSIZE = 1 , SR_CROP_CENTER_BY_CROPSIZE = 2 , SR_CROP_BY_OBJECTSIZE_NOT_SQUARE = 3 }
	Enumerator indicating a mode of cropping large objects in segmentation. More...
enum	eFilterObjByRegionType
	Enumerator indicating a filtering object by region type in detection and segmentation.

Detailed Description

Header file for Commonly used variables.

Macro Definition Documentation

SR_USE_DEPRECATED_FUNCTIONS

#define SR_USE_DEPRECATED_FUNCTIONS

Usage flag of deprecated functions.

If users want to use deprecated functions used before v1.2.0, please uncomment the below line

Enumeration Type Documentation

eAlgorithmType

enum eAlgorithmType

Enumerator indicating a type of model.

Enumerator
Classification_V1	Classification - Shallow
Classification_V2	Classification - Standard
Classification_V3	Classification - Deep
Detection_V1	Detection - Shallow
Detection_V2	Detection - Standard
Segmentation_V1	Segmentation - Standard
Segmentation_V2	Segmentation - Deep
Segmentation_V3	Segmentation - Shallow
DefectGenerator_V1	Generation - Standard
OCR_Box_V1	OCR-Box - Standard
OCR_Text_V1	OCR-Text - Standard
SuperResolution_V1	Super Resolution

eErrorType

enum eErrorType

Enumerator indicating error codes.

Enumerator
NO_ERROR_OUT	Success
NO_LICENCE	Type of license mismatch (USB License dongle is recognized )
USE_NOT_ALLOCATED_HANDLER	Handler is not allocated
INAPPROPRIATE_HANDLER	Handler is not allocated
OUT_OF_GPU_MEMORY	Fail to allocated memory on GPU
INAPPROPRIATE_GPU_NUMBER	Inserted index of GPU is nor applicable (out of range)
NULL_INPUT	Input is nullptr
INAPPROPRIATE_INPUT	Input is not appropriate
FILE_NOT_FOUND	File Path is not correct
NULL_HANDLE_FILE_PATH	File Path is null
EMPTY_IMAGE	Input image is empty (null)
SMALL_IMAGE	Input image is too small to conduct inspection (under 32 x 32)
NOT_LOAD_NETWORK_IN_GPU	Required GPU memory is not allocated yet
FORWARD_ALGO_TIMEOUT	Inspection time is out of limit
INAPPROPRIATE_OUTPUT	Output of inspection is not appropriate
LOW_VERSION_LICENSE	The version of a license key is low
NO_LICENSE_DONGLE	USB License dongle is not recognized
LOW_VERSION_FILE	The version of a model file is low
LICENSE_EXPIRED	The required license is expired
NOT_SUPPORTED_FUNCTION	Not supported function (e.g., OCR is not supported from v1.6
UNKNOWN_ERROR	Unknown Error

eHandlerType

enum eHandlerType

Enumerator indicating a type of handler.

Enumerator
ClsTrainType	Classification - Train
ClsTestType	Classification - Test
DetTrainType	Detection - Train
DetTestType	Detection - Test
SegTrainType	Segmentation - Train
SegTestType	Segmentation - Test
GenTrainType	Generation - Train
GenTestType	Generation - Test
OCRTrainType	OCR - Train
OCRTestType	OCR - Test
SuperResolutionTrainType	SuperResolution - Train
SuperResolutionTestType	SuperResolution - Test

eModeOfCropLargeObjects

enum eModeOfCropLargeObjects

Enumerator indicating a mode of cropping large objects in segmentation.

Details are expained in Segmentation's crop object.

Enumerator
SR_CROP_BY_OBJECTSIZE_N_RESIZE_TO_CROPSIZE	Crop objects by its own size and then resize it to preset size (square)
SR_CROP_BY_OBJECTSIZE	Crop objects by its own size (square)
SR_CROP_CENTER_BY_CROPSIZE	Crop objects by preset size (square)
SR_CROP_BY_OBJECTSIZE_NOT_SQUARE	Crop objects by its own size (not square)

eModeOfPixelSizeFilter

enum eModeOfPixelSizeFilter

Enumerator indicating a mode of filtering by object's area in segmentation.

Enumerator
SR_PIXELSIZE_FILTER_MODE_OFF	No filtering
SR_PIXELSIZE_FILTER_MODE_ON_FAST	Calculate area of object by fast but not exact method (1~2% error for segmentation)
SR_PIXELSIZE_FILTER_MODE_ON_EXACT	Calculate area of object by exact method