SaigeVisionAPI.h¶

#include <stdint.h>
#include "saige_error.h"

SaigeVision 추론 기능에 필요한 핵심적인 함수, 상수, 구조체, 플래그 등이 정의되어 있습니다.

Classes¶

Type	Name
struct	SaigeHandleConfig Structure containing configuration settings for the inference handle, which can impact GPU memory and inference time.
struct	SaigeRoiInfo Structure containing ROI information. Composed of the ROI mode and corresponding parameters, along with common blind mask information.
struct	SaigeModelInfo Structure containing model information.
struct	SaigeTextFormatting (OCR) Option for specifying the format of text to be recognized. There are two approaches: setting a character set for recognition regardless of character count, or defining character sets based on character position.
struct	SaigeInferenceOption inference options struct
struct	SaigeRotatedBox Structure containing information about a rotatable rectangle.
struct	SaigeDetectedObject Structure containing information about a detected area from Object Detection (DET).
struct	SaigeEllipse Structure containing information about an ellipse.
struct	SaigeSegmentedObject Structure containing information about a detected area from Segmentation (SEG) or Anomaly Detection (IAD).
struct	SaigeTextObject SaigeTextObject.

Public Attributes¶

Type	Name
constexpr int	kMaxLenOfClassName = = 63 Constant value indicating the max length of class name.
constexpr int	kMaxNumOfClasses = = 255 Maximum number of classes.
constexpr int	kMaxLenOfModelName = = 63 Constant value indicating the max length of model name.
constexpr int	kMaxLenOfCameraName = = 63 Constant value indicating the max length of camera name.
constexpr int	kMaxLenOfTrainedVersion = = 63 Constant value indicating the max length of version information string.
constexpr int	kMaxLenOfToolName = = 63 kMaxLenOfToolName
constexpr int	kMaxLenOfTextFormatting = = 200 (OCR) Maximum length of recognized text. A recognized text in a single SaigeTextObject cannot exceed this length.

Public Functions¶

Type	Name
int	SaigeCheckLicenseInferenceHandle (SaigeInferenceHandle handle) Checks if the license of a inference handle is valid.
int	SaigeSetHandleMetadata (SaigeInferenceHandle handle, const char * key, const char * value) SaigeSetHandleMetadata.
int	SaigeSetInferenceMetadata (SaigeInferenceResult result, const char * key, const char * value) SaigeSetInferenceMetadata.
int	SaigeSetResultMetadata (SaigeInferenceResult result, const char * key, const char * value) SaigeSetResultMetadata.

Macros¶

Type	Name
define	SAIGEVISION_RUNTIME_VERSION_MAJOR 2 Major version of the SAIGE VISION Runtime C/C++ SDK.
define	SAIGEVISION_RUNTIME_VERSION_MINOR 13 Minor version of the SAIGE VISION Runtime C/C++ SDK.
define	SAIGEVISION_RUNTIME_VERSION_PATCH 5 Patch version of the SAIGE VISION Runtime C/C++ SDK.
define	SV_STR (x) #x
define	SV_VER (M, m, p) SV_STR(M) "." SV_STR(m) "." SV_STR(p)
define	SAIGEVISION_RUNTIME_VERSION "2.13.5" The version of the SaigeVision Runtime C/C++ SDK (deprecated). Please use MAJOR, MINOR, and PATCH versions instead.

Public Attributes Documentation¶

`kMaxLenOfClassName`¶

Constant value indicating the max length of class name.

constexpr int kMaxLenOfClassName;

`kMaxNumOfClasses`¶

Maximum number of classes.

constexpr int kMaxNumOfClasses;

`kMaxLenOfModelName`¶

Constant value indicating the max length of model name.

constexpr int kMaxLenOfModelName;

`kMaxLenOfCameraName`¶

Constant value indicating the max length of camera name.

constexpr int kMaxLenOfCameraName;

`kMaxLenOfTrainedVersion`¶

Constant value indicating the max length of version information string.

constexpr int kMaxLenOfTrainedVersion;

`kMaxLenOfToolName`¶

kMaxLenOfToolName

constexpr int kMaxLenOfToolName;

`kMaxLenOfTextFormatting`¶

(OCR) Maximum length of recognized text. A recognized text in a single SaigeTextObject cannot exceed this length.

constexpr int kMaxLenOfTextFormatting;

Public Functions Documentation¶

`SaigeCheckLicenseInferenceHandle`¶

Checks if the license of a inference handle is valid.

int SaigeCheckLicenseInferenceHandle (
    SaigeInferenceHandle handle
)

Parameters:

handle The inference handle to check.

Returns:

errorCode Returns 0 if the license is valid, or an error code if the license is invalid or an error occurs.

`SaigeSetHandleMetadata`¶

SaigeSetHandleMetadata.

int SaigeSetHandleMetadata (
    SaigeInferenceHandle handle,
    const char * key,
    const char * value
)

Sets metadata for the image collected during data collection. Once set, this metadata is retained.

Parameters:

handle The inference handle.
key The metadata key. Only keys recognized by the monitoring system will be reflected.
value The metadata value, interpreted according to the monitoring system's defined types.

`SaigeSetInferenceMetadata`¶

SaigeSetInferenceMetadata.

int SaigeSetInferenceMetadata (
    SaigeInferenceResult result,
    const char * key,
    const char * value
)

Sets one-time metadata for the image collected during data collection.

Parameters:

result The inference result handle.
key The metadata key. Only keys recognized by the monitoring system will be reflected.
value The metadata value, interpreted according to the monitoring system's defined types.

`SaigeSetResultMetadata`¶

SaigeSetResultMetadata.

int SaigeSetResultMetadata (
    SaigeInferenceResult result,
    const char * key,
    const char * value
)

Sets one-time test result metadata for the collected image during data collection.

Parameters:

result The inference result handle.
key The metadata key. Only keys recognized by the monitoring system will be reflected.
value The metadata value, interpreted according to the monitoring system's defined types.

Macro Definition Documentation¶

`SAIGEVISION_RUNTIME_VERSION_MAJOR`¶

Major version of the SAIGE VISION Runtime C/C++ SDK.

#define SAIGEVISION_RUNTIME_VERSION_MAJOR 2

`SAIGEVISION_RUNTIME_VERSION_MINOR`¶

Minor version of the SAIGE VISION Runtime C/C++ SDK.

#define SAIGEVISION_RUNTIME_VERSION_MINOR 13

`SAIGEVISION_RUNTIME_VERSION_PATCH`¶

Patch version of the SAIGE VISION Runtime C/C++ SDK.

#define SAIGEVISION_RUNTIME_VERSION_PATCH 5

`SV_STR`¶

#define SV_STR (
    x
) #x

`SV_VER`¶

#define SV_VER (
    M,
    m,
    p
) SV_STR(M) "." SV_STR(m) "." SV_STR(p)

`SAIGEVISION_RUNTIME_VERSION`¶

The version of the SaigeVision Runtime C/C++ SDK (deprecated). Please use MAJOR, MINOR, and PATCH versions instead.

#define SAIGEVISION_RUNTIME_VERSION "2.13.5"

SaigeVisionAPI.h¶

Classes¶

Public Attributes¶

Public Functions¶

Macros¶

Public Attributes Documentation¶

kMaxLenOfClassName¶

kMaxNumOfClasses¶

kMaxLenOfModelName¶

kMaxLenOfCameraName¶

kMaxLenOfTrainedVersion¶

kMaxLenOfToolName¶

kMaxLenOfTextFormatting¶

Public Functions Documentation¶

SaigeCheckLicenseInferenceHandle¶

SaigeSetHandleMetadata¶

SaigeSetInferenceMetadata¶

SaigeSetResultMetadata¶

Macro Definition Documentation¶

SAIGEVISION_RUNTIME_VERSION_MAJOR¶

SAIGEVISION_RUNTIME_VERSION_MINOR¶

SAIGEVISION_RUNTIME_VERSION_PATCH¶

SV_STR¶

SV_VER¶

SAIGEVISION_RUNTIME_VERSION¶

`kMaxLenOfClassName`¶

`kMaxNumOfClasses`¶

`kMaxLenOfModelName`¶

`kMaxLenOfCameraName`¶

`kMaxLenOfTrainedVersion`¶

`kMaxLenOfToolName`¶

`kMaxLenOfTextFormatting`¶

`SaigeCheckLicenseInferenceHandle`¶

`SaigeSetHandleMetadata`¶

`SaigeSetInferenceMetadata`¶

`SaigeSetResultMetadata`¶

`SAIGEVISION_RUNTIME_VERSION_MAJOR`¶

`SAIGEVISION_RUNTIME_VERSION_MINOR`¶

`SAIGEVISION_RUNTIME_VERSION_PATCH`¶

`SV_STR`¶

`SV_VER`¶

`SAIGEVISION_RUNTIME_VERSION`¶