SaigeVisionAPI.h¶

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

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

Classes¶

Type	Name
struct	SaigeHandleConfig 추론 핸들 설정 사항이 담긴 구조체입니다. GPU 메모리 및 추론 시간에 영향을 미칠 수 있는 항목들입니다.
struct	SaigeRoiInfo ROI 정보가 담긴 구조체입니다. ROI 모드와 그에 대응하는 파라미터, 그리고 공통적으로 사용되는 blind mask 정보로 구성되어 있습니다.
struct	SaigeClassRoc 한 클래스의 ROC 곡선과 AUROC입니다. 학습 시 validation 단계에서 산출됩니다.
struct	SaigeValidationRoc 모델의 클래스별 validation ROC/AUROC입니다 (CLS, DET, SEG). 해당 지표 없이 학습된 모델에서는 `numClasses`가 0입니다.
struct	SaigeModelInfo 모델 정보가 담긴 구조체입니다.
struct	SaigeTextFormatting (OCR) 인식하고자 하는 글자의 포맷을 지정하는 옵션입니다. 글자 수에 관계 없이 인식하고자 하는 글자집합을 설정하는 방식과, 글자의 위치별로 인식하고자 하는 글자집합을 설정하는 두 가지 방식이 있습니다.
struct	SaigeInferenceOption 추론 옵션이 담긴 구조체입니다.
struct	SaigeRotatedBox 회전 가능한 직사각형의 정보가 담긴 구조체입니다.
struct	SaigeDetectedObject Object detection(DET)을 통해 검출된 영역의 정보가 담긴 구조체입니다.
struct	SaigeEllipse 타원 정보가 담긴 구조체입니다.
struct	SaigeSegmentedObject Segmentation(SEG) 또는 Anomaly Detection(IAD)을 통해 검출된 영역의 정보가 담긴 구조체입니다.
struct	SaigeTextObject 텍스트를 검출하는 OCR 검사의 결과가 담긴 구조체입니다.

Public Attributes¶

Type	Name
constexpr int	kMaxLenOfClassName = = 63 클래스 이름의 최대 길이를 나타내는 상수입니다.
constexpr int	kMaxNumOfClasses = = 255 클래스 개수의 최댓값을 나타내는 상수입니다.
constexpr int	kMaxLenOfModelName = = 63 모델 이름의 최대 길이를 나타내는 상수입니다.
constexpr int	kMaxLenOfCameraName = = 63 MLOps 기능 반영 시 안내 예정.
constexpr int	kMaxLenOfTrainedVersion = = 63 버전 정보 문자열의 최대 길이를 나타내는 상수입니다.
constexpr int	kMaxLenOfToolName = = 63 MLOps 기능 반영 시 안내 예정.
constexpr int	kMaxLenOfTextFormatting = = 200 (OCR) 인식할 수 있는 글자의 최대 길이입니다. 하나의 SaigeTextObject 에 인식된 글자는 이 길이를 넘을 수 없습니다.

Public Functions¶

Type	Name
int	SaigeCheckLicenseInferenceHandle (SaigeInferenceHandle handle) 추론 핸들의 라이센스가 유효한지 확인합니다.
int	SaigeSetHandleMetadata (SaigeInferenceHandle handle, const char * key, const char * value) 데이터가 수집되는 경우 수집된 이미지에 대한 메타데이터를 설정합니다. 한 번 설정하면 계속 유지됩니다.
int	SaigeSetInferenceMetadata (SaigeInferenceResult result, const char * key, const char * value) 데이터가 수집되는 경우, 수집된 이미지에 대한 일회성 메타데이터를 설정합니다.
int	SaigeSetResultMetadata (SaigeInferenceResult result, const char * key, const char * value) 데이터가 수집되는 경우, 수집된 이미지에 대한 일회성 검사 결과 메타데이터를 설정합니다.

Macros¶

Type	Name
define	SAIGEVISION_RUNTIME_VERSION_MAJOR 2 SAIGE VISION Runtime C/C++ SDK의 Major 버전
define	SAIGEVISION_RUNTIME_VERSION_MINOR 14 SAIGE VISION Runtime C/C++ SDK의 Minor 버전
define	SAIGEVISION_RUNTIME_VERSION_PATCH 0 SAIGE VISION Runtime C/C++ SDK의 Patch 버전
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.14.0" SaigeVision Runtime C/C++ SDK의 버전입니다. (폐기 예정) 가급적이면 MAJOR, MINOR, PATCH 버전을 사용해주시기 바랍니다.

Public Attributes Documentation¶

`kMaxLenOfClassName`¶

클래스 이름의 최대 길이를 나타내는 상수입니다.

constexpr int kMaxLenOfClassName;

`kMaxNumOfClasses`¶

클래스 개수의 최댓값을 나타내는 상수입니다.

constexpr int kMaxNumOfClasses;

`kMaxLenOfModelName`¶

모델 이름의 최대 길이를 나타내는 상수입니다.

constexpr int kMaxLenOfModelName;

`kMaxLenOfCameraName`¶

MLOps 기능 반영 시 안내 예정.

constexpr int kMaxLenOfCameraName;

`kMaxLenOfTrainedVersion`¶

버전 정보 문자열의 최대 길이를 나타내는 상수입니다.

constexpr int kMaxLenOfTrainedVersion;

`kMaxLenOfToolName`¶

MLOps 기능 반영 시 안내 예정.

constexpr int kMaxLenOfToolName;

`kMaxLenOfTextFormatting`¶

(OCR) 인식할 수 있는 글자의 최대 길이입니다. 하나의 SaigeTextObject 에 인식된 글자는 이 길이를 넘을 수 없습니다.

constexpr int kMaxLenOfTextFormatting;

Public Functions Documentation¶

`SaigeCheckLicenseInferenceHandle`¶

추론 핸들의 라이센스가 유효한지 확인합니다.

int SaigeCheckLicenseInferenceHandle (
    SaigeInferenceHandle handle
)

Parameters:

handle 확인할 추론 핸들입니다.

Returns:

errorCode 라이센스가 유효하면 0을 리턴하고, 라이센스가 유효하지 않거나 에러가 발생하면 에러코드를 리턴합니다.

`SaigeSetHandleMetadata`¶

데이터가 수집되는 경우 수집된 이미지에 대한 메타데이터를 설정합니다. 한 번 설정하면 계속 유지됩니다.

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

Parameters:

handle 추론 핸들입니다.
key 메타데이터의 키 입니다. 모니터링 시스템에서 설정된 키만 반영 됩니다.
value 메타데이터의 값 입니다. 모니터링 시스템에서 설정된 타입으로 해석됩니다.

`SaigeSetInferenceMetadata`¶

데이터가 수집되는 경우, 수집된 이미지에 대한 일회성 메타데이터를 설정합니다.

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

Parameters:

result 추론 결과 핸들입니다.
key 메타데이터의 키 입니다. 모니터링 시스템에서 설정된 키만 반영 됩니다.
value 메타데이터의 값 입니다. 모니터링 시스템에서 설정된 타입으로 해석됩니다.

`SaigeSetResultMetadata`¶

데이터가 수집되는 경우, 수집된 이미지에 대한 일회성 검사 결과 메타데이터를 설정합니다.

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

Parameters:

result 추론 결과 핸들입니다.
key 메타데이터의 키 입니다. 모니터링 시스템에서 설정된 키만 반영 됩니다.
value 메타데이터의 값 입니다. 모니터링 시스템에서 설정된 타입으로 해석됩니다.

Macro Definition Documentation¶

`SAIGEVISION_RUNTIME_VERSION_MAJOR`¶

SAIGE VISION Runtime C/C++ SDK의 Major 버전

#define SAIGEVISION_RUNTIME_VERSION_MAJOR 2

`SAIGEVISION_RUNTIME_VERSION_MINOR`¶

SAIGE VISION Runtime C/C++ SDK의 Minor 버전

#define SAIGEVISION_RUNTIME_VERSION_MINOR 14

`SAIGEVISION_RUNTIME_VERSION_PATCH`¶

SAIGE VISION Runtime C/C++ SDK의 Patch 버전

#define SAIGEVISION_RUNTIME_VERSION_PATCH 0

`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`¶

SaigeVision Runtime C/C++ SDK의 버전입니다. (폐기 예정) 가급적이면 MAJOR, MINOR, PATCH 버전을 사용해주시기 바랍니다.

#define SAIGEVISION_RUNTIME_VERSION "2.14.0"

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`¶