SaigeVisionAPI.h¶
Go to the source code of this file.
#include <stdint.h>#include "saige_error.h"
SaigeVision 추론 기능에 필요한 핵심적인 함수, 상수, 구조체, 플래그 등이 정의되어 있습니다.
Classes¶
| Type | Name |
|---|---|
| struct | SaigeHandleConfig 包含推理句柄的配置设置的结构体,这些设置可能影响 GPU 内存和推理时间。 |
| struct | SaigeRoiInfo 包含 ROI 信息的结构体。 由 ROI 模式和相应参数组成,以及常用的盲掩膜信息。 |
| struct | SaigeModelInfo 包含模型信息的结构体。 |
| struct | SaigeTextFormatting (OCR) 指定要识别文本的格式的选项。 有两种方法:设置字符集进行识别,无论字符数如何,或者根据字符位置定义字符集。 |
| struct | SaigeInferenceOption 包含推理选项的结构体。 |
| struct | SaigeRotatedBox 包含可旋转矩形信息的结构体。 |
| struct | SaigeDetectedObject 包含从对象检测(DET)中检测到的区域信息的结构体。 |
| struct | SaigeEllipse 包含椭圆信息的结构体。 |
| struct | SaigeSegmentedObject 包含通过分割(SEG)或异常检测(IAD)检测到的区域信息的结构体。 |
| struct | SaigeTextObject SaigeTextObject |
Public Attributes¶
| Type | Name |
|---|---|
| constexpr int | kMaxLenOfClassName = = 63 表示类别(Class)名称的最大长度的常量值。 |
| constexpr int | kMaxNumOfClasses = = 255 表示类别(Class)的最大数量的常量值。 |
| 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) 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 SAIGE VISION 运行版 C/C++ SDK 的主要版本 |
| define | SAIGEVISION_RUNTIME_VERSION_MINOR 13 SAIGE VISION 运行版 C/C++ SDK 的次要版本 |
| define | SAIGEVISION_RUNTIME_VERSION_PATCH 7 SAIGE VISION 运行版 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.7" SaigeVision 运行版 C/C++ SDK 的版本(已弃用)。请使用 MAJOR、MINOR 和 PATCH 版本。 |
Public Attributes Documentation¶
kMaxLenOfClassName¶
表示类别(Class)名称的最大长度的常量值。
constexpr int kMaxLenOfClassName;
kMaxNumOfClasses¶
表示类别(Class)的最大数量的常量值。
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¶
SaigeSetHandleMetadata
int SaigeSetHandleMetadata (
SaigeInferenceHandle handle,
const char * key,
const char * value
)
设置在数据收集期间收集的图像的元数据。设置后,这些元数据将被保留。
Parameters:
handle推理句柄。key元数据键。只有监控系统识别的键才会反映。value元数据值,根据监控系统定义的类型进行解释。
SaigeSetInferenceMetadata¶
SaigeSetInferenceMetadata
int SaigeSetInferenceMetadata (
SaigeInferenceResult result,
const char * key,
const char * value
)
设置在数据收集期间收集的图像的一次性元数据。
Parameters:
result推理结果句柄。key元数据键。只有监控系统识别的键才会反映。value元数据值,根据监控系统定义的类型进行解释。
SaigeSetResultMetadata¶
SaigeSetResultMetadata
int SaigeSetResultMetadata (
SaigeInferenceResult result,
const char * key,
const char * value
)
设置在数据收集期间收集的图像的一次性测试结果元数据。
Parameters:
result推理结果句柄。key元数据键。只有监控系统识别的键才会反映。value元数据值,根据监控系统定义的类型进行解释。
Macro Definition Documentation¶
SAIGEVISION_RUNTIME_VERSION_MAJOR¶
SAIGE VISION 运行版 C/C++ SDK 的主要版本
#define SAIGEVISION_RUNTIME_VERSION_MAJOR 2
SAIGEVISION_RUNTIME_VERSION_MINOR¶
SAIGE VISION 运行版 C/C++ SDK 的次要版本
#define SAIGEVISION_RUNTIME_VERSION_MINOR 13
SAIGEVISION_RUNTIME_VERSION_PATCH¶
SAIGE VISION 运行版 C/C++ SDK 的补丁版本
#define SAIGEVISION_RUNTIME_VERSION_PATCH 7
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 运行版 C/C++ SDK 的版本(已弃用)。请使用 MAJOR、MINOR 和 PATCH 版本。
#define SAIGEVISION_RUNTIME_VERSION "2.13.7"