SaigeVisionAPI.h¶

#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 Types¶

Type	Name
typedef void *	SaigeInferenceHandle 用于管理信息和执行推理的句柄。
typedef void *	SaigeInferenceResult 用于管理推理结果的句柄。

Public Attributes¶

Type	Name
constexpr int	kProjectTypeCLS = = 0 表示分类项目的常量值。
constexpr int	kProjectTypeDET = = 1 表示检测项目的常量值。
constexpr int	kProjectTypeSEG = = 2 表示分割项目的常量值。
constexpr int	kProjectTypeIAD = = 3 表示异常检测项目的常量值。
constexpr int	kProjectTypeOCR = = 4 表示OCR项目的常量值。
constexpr int	kProjectTypeIEN = = 5 表示IEN项目的常量值。
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	SaigeInferFromImageFile (SaigeInferenceHandle handle, const char * imagePath, SaigeInferenceResult result) 使用指定的图像文件路径进行推理。
int	SaigeInferFromByteArray (SaigeInferenceHandle handle, const unsigned char * imageData, const int width, const int height, const unsigned int flags, SaigeInferenceResult result) 对单个图像数据数组执行推理。对于3通道彩色图像，建议使用RGB顺序以提高实时应用程序的速度。如果图像以RGB格式获取，建议使用RGB。
int	SaigeInferFromByteArrayWithProductId (SaigeInferenceHandle handle, const unsigned char * imageData, const int width, const int height, const unsigned int flags, const char * productId, SaigeInferenceResult result) 在单个图像数据数组上执行推理，并附加产品标识符。这与 SaigeInferFromByteArray 类似，增加了产品ID，这是用户定义的检查目标标识符。
int	SaigeInferFromMultipleByteArray (SaigeInferenceHandle handle, const int numOfImages, const unsigned char imageData, const int width, const int height, const unsigned int flags, SaigeInferenceResult** * results) 输入多个相同大小的图像数据以执行批量推理。
int	SaigeInferFromMultiPageByteArray (SaigeInferenceHandle handle, const int numOfPages, const unsigned char ** imageData, const int width, const int height, const int * channels, const unsigned int flags, SaigeInferenceResult result) 使用多页图像数据进行推理。
int	SaigeGetInferenceResultScore (SaigeInferenceResult result, float * scores, bool includeAddScore) (CLS) 检索每个类别的分数数组。
int	SaigeGetInferenceResultClass (SaigeInferenceResult result, int * classIndex) (CLS) 检索包含额外分数的最终得分最高的类别的索引。
int	SaigeGetInferenceResultClassActivationMap (SaigeInferenceResult result, unsigned char ** classActivationMap) (CLS) 检索类别激活图数组。
int	SaigeGetInferenceResultNumOfDetectedObjects (SaigeInferenceResult result, int * numOfObjects) (DET) 获取对象检测中检测到的对象数量。
int	SaigeGetInferenceResultDetectedObjects (SaigeInferenceResult result, SaigeDetectedObject * detectedObjects) (DET) 获取对象检测中检测到的对象数组。
int	SaigeGetInferenceResultNumOfSegmentedObjects (SaigeInferenceResult result, int * num) 获取通过分割（SEG）或异常检测（IAD）检测到的分割对象的数量。
int	SaigeGetInferenceResultSegmentedObjects (SaigeInferenceResult result, SaigeSegmentedObject * segObjects) 获取通过分割（SEG）或异常检测（IAD）检测到的分割对象数组。
int	SaigeGetInferenceResultMask (SaigeInferenceResult result, unsigned char ** mask) 从分割（SEG）或异常检测（IAD）中获取掩码数组。
int	SaigeGetInferenceResultScoremapSEG (SaigeInferenceResult result, unsigned char ** scoremap) 获取分割（SEG）的得分图数组。
int	SaigeGetInferenceResultIsOversized (SaigeInferenceResult result, bool * isOversized) 检查输入图像大小是否超过`SaigeHandleConfig`中设置的检查大小。
int	SaigeGetInferenceResultAnomalyScores (SaigeInferenceResult result, double * anomalyScore, double * minScore, double * maxScore) 获取异常检测（IAD）的三种分数。
int	SaigeGetInferenceResultIsNg (SaigeInferenceResult result, bool * isNg) 获取异常检测（IAD）中图像的正常/异常分类结果。
int	SaigeGetInferenceResultScoremapIAD (SaigeInferenceResult result, float ** scoremap) 获取异常检测（IAD）的得分图数组。
int	SaigeGetInferenceResultHeatmap (SaigeInferenceResult result, float ** heatmap) 获取热图数组。
int	SaigeGetInferenceResultNumOfTextObjects (SaigeInferenceResult result, int * num) SaigeGetInferenceResultNumOfTextObjects
int	SaigeGetInferenceResultTextObjects (SaigeInferenceResult result, SaigeTextObject * textObjects) SaigeGetInferenceResultTextObjects
int	SaigeGetInferenceResultEnhancedImage (SaigeInferenceResult result, unsigned char ** image) SaigeGetInferenceResultEnhancedImage
int	SaigeGetInferenceResultInspectionTime (SaigeInferenceResult result, long long * imreadTime, long long * inferenceTime, long long * postProcessingTime) SaigeGetInferenceResultInspectionTime
int	SaigeGetInferenceResultProductId (SaigeInferenceResult result, const char ** productId, unsigned int * length) SaigeGetInferenceResultProductId
int	SaigeInitializeAlignModule (const int gpuIndex, const int sourceWidth, const int sourceHeight, const int targetWidth, const int targetHeight) 激活Saige Alignment功能的函数。
int	SaigeFinalizeAlignModule () 结束Saige Alignment功能的函数。释放功能使用的GPU内存。
int	SaigeAlignImageFromByteArray (const unsigned char * sourceImage, const int sourceWidth, const int sourceHeight, const int sourceChannel, const unsigned char * targetImage, const int targetWidht, const int targetHeight, const int targetChannel, unsigned int flag, unsigned char * croppedSourceImage) 将Source图像的位置调整到与Target图像匹配的函数。
int	SaigeAlignImageFromFile (const char * sourceImagePath, const char * targetImagePath, int * cropWidth, int * cropHeight, int * cropChannel, unsigned char * croppedSourceImage) Not Implemented
int	SaigeCreateInferenceHandle (SaigeInferenceHandle * handle, const int projectType, const char * modelFilePath, const int deviceIndex, SaigeHandleConfig * config, const unsigned int flags) 创建一个推理句柄。
int	SaigeDestroyInferenceHandle (SaigeInferenceHandle handle) 销毁推理句柄。
int	SaigeCreateInferenceResult (SaigeInferenceResult * result) 创建结果句柄。
int	SaigeDestroyInferenceResult (SaigeInferenceResult result) 销毁结果句柄。
int	SaigeGetModelInfo (SaigeInferenceHandle handle, SaigeModelInfo * info) 从推理句柄中检索模型信息。
int	SaigeSetInferenceOption (SaigeInferenceHandle handle, SaigeInferenceOption * option, const unsigned int flags) 在推理句柄上设置推理选项值。
int	SaigeGetInferenceOption (SaigeInferenceHandle handle, SaigeInferenceOption * option) 从推理句柄中检索推理选项值。
const char *	SaigeStrError (const int errnum) SaigeStrError
const char *	SaigeGetModuleVersion () SaigeGetModuleVersion
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	SAIGE_WRITE_ON_MODEL_FILE 0x01 (Common) 使用 SaigeSetInferenceOption 设置推理选项值时，此标志还会将选项值保存到模型文件中。
define	SAIGE_SET_CALC_TIME 0x2 (Common) 设置 `calcTime` 选项的标志。
define	SAIGE_SET_OVERSIZED_IMAGE_HANDLING 0x4 (SEG, OCR, IEN) 设置 `oversizedImageHandling` 选项的标志。
define	SAIGE_SET_ADDITIONAL_SCORES 0x8 (CLS) 设置 `additionalScores` 选项的标志。
define	SAIGE_SET_CALC_CLASS_ACTIVATION_MAP 0x10 (CLS) 设置 `calcClassActivationMap` 选项的标志。
define	SAIGE_SET_MAX_NUM_OF_DETECTED_OBJECTS 0x20 (DET) 设置 `maxNumOfDetectedObjects` 选项的标志。
define	SAIGE_SET_CALC_SCOREMAP 0x40 (SEG) 设置 `calcScoremap` 选项的标志。
define	SAIGE_SET_CALC_OBJECT 0x80 (SEG, IAD) 设置 `calcObject` 选项的标志。
define	SAIGE_SET_CALC_OBJECT_AREA_AND_APPLY_THRESHOLD 0x100 (SEG, IAD) 设置 `calcObjectAreaAndApplyThreshold` 选项的标志。
define	SAIGE_SET_CALC_OBJECT_SCORE_AND_APPLY_THRESHOLD 0x200 (SEG, IAD) 设置 `calcObjectScoreAndApplyThreshold` 选项的标志。
define	SAIGE_SET_OBJECT_BOUNDARY_THRESHOLD 0x400 (SEG, IAD) 在SEG中设置 `objectBoundaryThresholdPerClass` 选项，在IAD中设置 `objectBoundaryThreshold` 选项的标志。
define	SAIGE_SET_OBJECT_AREA_THRESHOLD 0x800 (SEG, DET, IAD) 在SEG和DET中设置 `objectAreaThresholdPerClass` 选项，在IAD中设置 `objectAreaThreshold` 选项的标志。
define	SAIGE_SET_OBJECT_SCORE_THRESHOLD 0x1000 (SEG, DET, IAD) 在SEG和DET中设置 `objectScoreThresholdPerClass` 选项，在IAD中设置 `objectScoreThreshold` 选项的标志。
define	SAIGE_SET_CALC_MASK 0x2000 (SEG, IAD) 设置 `calcMask` 选项的标志。
define	SAIGE_SET_CALC_HEATMAP 0x4000 (IAD) 设置 `calcHeatmap` 选项的标志。
define	SAIGE_SET_ANOMALY_SCORE_THRESHOLD 0x8000 (IAD) 设置 `anomalyScoreThreshold` 选项的标志。
define	SAIGE_SET_HEATMAP_COLOR_RANGE 0x10000 (IAD) 设置 `heatmapColorRangeMin` 和 `heatmapColorRangeMax` 选项的标志。
define	SAIGE_SET_POLYGON_SCORE_THRESHOLD 0x20000 (OCR) 设置 `polygonScoreThreshold` 选项的标志。
define	SAIGE_SET_TEXT_SIZE_RANGE 0x40000 (OCR) 设置 `textSizeRangeMin` 和 `textSizeRangeMax` 选项的标志。
define	SAIGE_SET_NUM_OF_TEXT_OBJECTS 0x80000 (OCR) 设置 `maxNumOfTextObjects` 选项的标志。
define	SAIGE_SET_TEXT_SCORE_THRESHOLD 0x100000 (OCR) 设置 `textScoreThreshold` 选项的标志。
define	SAIGE_SET_TEXT_FORMATTING 0x200000 (OCR) 设置 `textFormatting` 选项的标志。
define	SAIGE_IMAGE_COLOR 0x01 指示颜色图像数据的标志。
define	SAIGE_IMAGE_16BIT 0x02 指示每通道16位图像数据的标志。
define	SAIGE_IMAGE_ALPHA 0x04 指示带有Alpha通道的数据的标志。
define	SAIGE_IMAGE_BGR 0x08 指示颜色通道顺序为蓝色、绿色、红色的数据的标志。
define	SAIGE_IMAGE_8BIT_GRAY 0x00 指示8位灰度图像数据的宏。它是一个大小为Width x Height的单通道数组。
define	SAIGE_IMAGE_24BIT_RGB (SAIGE_IMAGE_COLOR) 指示24位RGB彩色图像数据的宏。它是一个大小为Width x Height x Channels (3)的数组，通道顺序为R, G, B。
define	SAIGE_IMAGE_24BIT_BGR (SAIGE_IMAGE_COLOR \| SAIGE_IMAGE_BGR) 指示24位BGR彩色图像数据的宏。它是一个大小为Width x Height x Channels (3)的数组，通道顺序为B, G, R。
define	SAIGE_IMAGE_32BIT_RGBA (SAIGE_IMAGE_COLOR \| SAIGE_IMAGE_ALPHA) 指示32位RGBA彩色图像数据的宏。它是一个大小为Width x Height x Channels (4)的数组，通道顺序为R, G, B, A。
define	SAIGE_IMAGE_32BIT_BGRA (SAIGE_IMAGE_COLOR \| SAIGE_IMAGE_ALPHA \| SAIGE_IMAGE_BGR) 指示32位BGRA彩色图像数据的宏。它是一个大小为Width x Height x Channels (4)的数组，通道顺序为B, G, R, A。
define	SAIGE_IMAGE_16BIT_GRAY (SAIGE_IMAGE_16BIT) 指示16位灰度图像数据的宏。它是一个大小为Width x Height的单通道数组，每个像素表示为unsigned short。
define	SAIGE_IMAGE_48BIT_RGB (SAIGE_IMAGE_COLOR \| SAIGE_IMAGE_16BIT) 指示48位RGB彩色图像数据的宏。它是一个大小为Width x Height x Channels (3)的数组，通道顺序为R, G, B，每个像素表示为unsigned short。
define	SAIGE_IMAGE_48BIT_BGR (SAIGE_IMAGE_COLOR \| SAIGE_IMAGE_16BIT \| SAIGE_IMAGE_BGR) 指示48位BGR彩色图像数据的宏。它是一个大小为Width x Height x Channels (3)的数组，通道顺序为B, G, R，每个像素表示为unsigned short。
define	SAIGE_IMAGE_64BIT_RGBA (SAIGE_IMAGE_COLOR \| SAIGE_IMAGE_16BIT \| SAIGE_IMAGE_ALPHA) 指示64位RGBA彩色图像数据的宏。它是一个大小为Width x Height x Channels (4)的数组，通道顺序为R, G, B, A，每个像素表示为unsigned short。
define	SAIGE_IMAGE_64BIT_BGRA (SAIGE_IMAGE_COLOR \| SAIGE_IMAGE_16BIT \| SAIGE_IMAGE_ALPHA \| SAIGE_IMAGE_BGR) 指示64位BGRA彩色图像数据的宏。它是一个大小为Width x Height x Channels (4)的数组，通道顺序为B, G, R, A，每个像素表示为unsigned short。
define	SAIGEVISION_RUNTIME_VERSION_MAJOR 2 SAIGE VISION 运行版 C/C++ SDK 的主要版本
define	SAIGEVISION_RUNTIME_VERSION_MINOR 12 SAIGE VISION 运行版 C/C++ SDK 的次要版本
define	SAIGEVISION_RUNTIME_VERSION_PATCH 0 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.12.0" SaigeVision 运行版 C/C++ SDK 的版本（已弃用）。请使用 MAJOR、MINOR 和 PATCH 版本。
define	SAIGE_SET_BATCH_SIZE 0x01 (CLS, DET, SEG, IAD) 设置推理的批量大小的标志。用于应用批量推理 API 时。
define	SAIGE_SET_INSPECTION_SIZE 0x02 (SEG, OCR) 设置用于推理的图像宽度和高度的标志。
define	SAIGE_OPTIMIZE_HANDLE 0x04 (Common) 应用优化到推理句柄的标志。应用推理优化可以减少推理时间，但可能会略微改变结果。
define	SAIGE_DO_NOT_INSPECT "do_not_inspect" (SEG) `oversizedImageHandling` 的选项之一，设置该值时不执行推理并引发错误。
define	SAIGE_DO_NOT_ENHANCE "do_not_enhance" (IEN) `oversizedImageHandling` 的选项之一，设置该值时不执行推理并引发错误。
define	SAIGE_RESIZE_TO_FIT "resize_to_fit" (SEG) `oversizedImageHandling` 的选项之一，设置该值时，图像将按比例缩放以适应检查大小，然后执行推理。
define	SAIGE_CROP_INTO_TILES "crop_into_tiles" (SEG, IEN) `oversizedImageHandling` 的选项之一，设置该值时，图像将根据检查大小裁剪为多个瓦片。对每个瓦片进行推理，并将结果组合在一起。

Public Types Documentation¶

`SaigeInferenceHandle`¶

用于管理信息和执行推理的句柄。

void * SaigeInferenceHandle;

`SaigeInferenceResult`¶

用于管理推理结果的句柄。

void * SaigeInferenceResult;

Public Attributes Documentation¶

`kProjectTypeCLS`¶

表示分类项目的常量值。

constexpr int kProjectTypeCLS;

`kProjectTypeDET`¶

表示检测项目的常量值。

constexpr int kProjectTypeDET;

`kProjectTypeSEG`¶

表示分割项目的常量值。

constexpr int kProjectTypeSEG;

`kProjectTypeIAD`¶

表示异常检测项目的常量值。

constexpr int kProjectTypeIAD;

`kProjectTypeOCR`¶

表示OCR项目的常量值。

constexpr int kProjectTypeOCR;

`kProjectTypeIEN`¶

表示IEN项目的常量值。

constexpr int kProjectTypeIEN;

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

`SaigeInferFromImageFile`¶

使用指定的图像文件路径进行推理。

int SaigeInferFromImageFile (
    SaigeInferenceHandle handle,
    const char * imagePath,
    SaigeInferenceResult result
)

Parameters:

handle 要用于推理的推理句柄。
imagePath 用于推理的图像文件路径。支持的扩展名包括 jpg、jpeg、png、ppm、bmp、pgm、tif、tiff和webp。
result 用于存储推理结果的结果句柄。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeInferFromByteArray`¶

对单个图像数据数组执行推理。对于3通道彩色图像，建议使用RGB顺序以提高实时应用程序的速度。如果图像以RGB格式获取，建议使用RGB。

int SaigeInferFromByteArray (
    SaigeInferenceHandle handle,
    const unsigned char * imageData,
    const int width,
    const int height,
    const unsigned int flags,
    SaigeInferenceResult result
)

Parameters:

handle 要使用的推理句柄。
imageData 要用于推理的图像数据。
width 图像数据的宽度。
height 图像数据的高度。
flags 设置图像的颜色和位深度的标志。
result 用于存储推理结果的结果句柄。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeInferFromByteArrayWithProductId`¶

在单个图像数据数组上执行推理，并附加产品标识符。这与 SaigeInferFromByteArray 类似，增加了产品ID，这是用户定义的检查目标标识符。

int SaigeInferFromByteArrayWithProductId (
    SaigeInferenceHandle handle,
    const unsigned char * imageData,
    const int width,
    const int height,
    const unsigned int flags,
    const char * productId,
    SaigeInferenceResult result
)

Parameters:

handle 要使用的推理句柄。
imageData 用于推理的图像数据。
width 图像数据的宽度。
height 图像数据的高度。
flags 设置图像的颜色和位深度的标志。
productId 要推理的产品ID。
result 用于存储推理结果的结果句柄。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeInferFromMultipleByteArray`¶

输入多个相同大小的图像数据以执行批量推理。

int SaigeInferFromMultipleByteArray (
    SaigeInferenceHandle handle,
    const int numOfImages,
    const unsigned char ** imageData,
    const int width,
    const int height,
    const unsigned int flags,
    SaigeInferenceResult * results
)

Parameters:

handle 要使用的推理句柄。
numOfImages 要推理的图像数据的数量。
imageData 用于推理的图像数据数组。
width 图像数据的宽度。
height 图像数据的高度。
flags 设置图像的颜色和位深度的标志。
results 用于存储推理结果的结果句柄数组。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeInferFromMultiPageByteArray`¶

使用多页图像数据进行推理。

int SaigeInferFromMultiPageByteArray (
    SaigeInferenceHandle handle,
    const int numOfPages,
    const unsigned char ** imageData,
    const int width,
    const int height,
    const int * channels,
    const unsigned int flags,
    SaigeInferenceResult result
)

Parameters:

handle 要使用的推理句柄。
numOfPages 图像数据的页数。
imageData 用于推理的图像数据数组。
width 图像数据的宽度。
height 图像数据的高度。
channels 图像数据中通道数的数组。每个元素表示每个页面的通道数。
flags 设置图像的颜色和位深度的标志。
result 用于存储推理结果的结果句柄。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultScore`¶

(CLS) 检索每个类别的分数数组。

int SaigeGetInferenceResultScore (
    SaigeInferenceResult result,
    float * scores,
    bool includeAddScore
)

Parameters:

result 包含推理结果的结果句柄。
scores [out] 包含每个类别分数的数组。
includeAddScore 如果设置为 true，则检索包括额外分数的分数。如果为 false，则仅检索原始分数。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultClass`¶

(CLS) 检索包含额外分数的最终得分最高的类别的索引。

int SaigeGetInferenceResultClass (
    SaigeInferenceResult result,
    int * classIndex
)

Parameters:

result 包含推理结果的结果句柄。
classIndex [out] 得分最高类别的索引。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultClassActivationMap`¶

(CLS) 检索类别激活图数组。

int SaigeGetInferenceResultClassActivationMap (
    SaigeInferenceResult result,
    unsigned char ** classActivationMap
)

类别激活图是一个热图，显示了哪些图像区域对特定分类的贡献最大。
像素值范围从0到255，值越高表示对分类结果的贡献越大。
形状为（原始图像高度 H，原始图像宽度 W）。
在内部，以行主序的方式表示为1D数组。 i行j列的值位于data[W*i + j]。

Parameters:

result 包含推理结果的结果句柄。
classActivationMap [out] 包含类别激活图的数组。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultNumOfDetectedObjects`¶

(DET) 获取对象检测中检测到的对象数量。

int SaigeGetInferenceResultNumOfDetectedObjects (
    SaigeInferenceResult result,
    int * numOfObjects
)

Parameters:

result 包含推理结果的结果句柄。
numOfObjects [out] 检测到的对象数量。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultDetectedObjects`¶

(DET) 获取对象检测中检测到的对象数组。

int SaigeGetInferenceResultDetectedObjects (
    SaigeInferenceResult result,
    SaigeDetectedObject * detectedObjects
)

Parameters:

result 包含推理结果的结果句柄。
detectedObjects [out] 检测到的对象数组。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultNumOfSegmentedObjects`¶

获取通过分割（SEG）或异常检测（IAD）检测到的分割对象的数量。

int SaigeGetInferenceResultNumOfSegmentedObjects (
    SaigeInferenceResult result,
    int * num
)

Parameters:

result 包含推理结果的结果句柄。
num [out] 检测到的分割对象数量。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultSegmentedObjects`¶

获取通过分割（SEG）或异常检测（IAD）检测到的分割对象数组。

int SaigeGetInferenceResultSegmentedObjects (
    SaigeInferenceResult result,
    SaigeSegmentedObject * segObjects
)

Parameters:

result 包含推理结果的结果句柄。
segObjects [out] 检测到的分割对象数组。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultMask`¶

从分割（SEG）或异常检测（IAD）中获取掩码数组。

int SaigeGetInferenceResultMask (
    SaigeInferenceResult result,
    unsigned char ** mask
)

(IAD) 被分类为正常的像素为0，被分类为异常的像素为1。
(SEG) 被分类为OK类的像素为0，而被分类为其他类的像素由其类索引表示。
数组的形状为（图像高度H，图像宽度W）。
这是一个单指针的一维数组，采用行优先顺序。对于行i和列j，值为data[W*i + j]。

Parameters:

result 包含推理结果的结果句柄。
mask [out] 掩码数组。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultScoremapSEG`¶

获取分割（SEG）的得分图数组。

int SaigeGetInferenceResultScoremapSEG (
    SaigeInferenceResult result,
    unsigned char ** scoremap
)

SEG的得分图，与IAD的得分图不同。
形状为（包括OK的类别数量，图像高度H，图像宽度W）。
如果图像的i行，j列的像素被预测为c类，那么<tt>(c, i, j)像素包含的得分为0-255之间的整数。
这是一个单指针的一维数组，采用行优先顺序，其中类c，行i，列j的值为data[W*H*c + W*i + j]。

Parameters:

result 包含推理结果的结果句柄。
scoremap [out] 得分图数组。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultIsOversized`¶

检查输入图像大小是否超过SaigeHandleConfig中设置的检查大小。

int SaigeGetInferenceResultIsOversized (
    SaigeInferenceResult result,
    bool * isOversized
)

Parameters:

result 包含推理结果的结果句柄。
isOversized [out] 如果输入图像大小超过检查大小，则为true，否则为false。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultAnomalyScores`¶

获取异常检测（IAD）的三种分数。

int SaigeGetInferenceResultAnomalyScores (
    SaigeInferenceResult result,
    double * anomalyScore,
    double * minScore,
    double * maxScore
)

Parameters:

result 包含推理结果的结果句柄。
anomalyScore [out] 图像的代表性异常得分。
minScore [out] 图像中的最小像素级分数。
maxScore [out] 图像中的最大像素级分数。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultIsNg`¶

获取异常检测（IAD）中图像的正常/异常分类结果。

int SaigeGetInferenceResultIsNg (
    SaigeInferenceResult result,
    bool * isNg
)

Parameters:

result 包含推理结果的结果句柄。
isNg [out] 如果图像被分类为异常，则为true，如果正常，则为false。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultScoremapIAD`¶

获取异常检测（IAD）的得分图数组。

int SaigeGetInferenceResultScoremapIAD (
    SaigeInferenceResult result,
    float ** scoremap
)

特定于IAD的得分图，与SEG的得分图不同。
每个像素的得分表示为非负浮点数。
数组的形状为（图像高度H，图像宽度W）。
这是一个单指针的一维数组，采用行优先顺序，其中行i和列j的值为data[W*i + j]。

Parameters:

result 包含推理结果的结果句柄。
scoremap [out] 得分图数组。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultHeatmap`¶

获取热图数组。

int SaigeGetInferenceResultHeatmap (
    SaigeInferenceResult result,
    float ** heatmap
)

返回一个在heatmapColorRangeMin和heatmapColorRangeMax之间归一化的热图数组。每个像素值表示为在0到1范围内的浮点数。
形状为（图像高度H，图像宽度W）。
实现为单指针的一维数组，采用行优先顺序。因此，行i和列j的值为data[W*i + j]。

Parameters:

result 包含推理结果的结果句柄。
heatmap [out] 热图数组。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultNumOfTextObjects`¶

SaigeGetInferenceResultNumOfTextObjects

int SaigeGetInferenceResultNumOfTextObjects (
    SaigeInferenceResult result,
    int * num
)

获取通过OCR分析的图像中检测到的文本区域数量。

Parameters:

result 包含推理结果的结果句柄。
num [out] 检测到的文本区域数量。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultTextObjects`¶

SaigeGetInferenceResultTextObjects

int SaigeGetInferenceResultTextObjects (
    SaigeInferenceResult result,
    SaigeTextObject * textObjects
)

从OCR推理结果中获取检测到的文本区域（SaigeTextObject）数组。

Parameters:

result 包含推理结果的结果句柄。
textObjects [out] 输出的SaigeTextObject结构数组。此数组应分配至少由SaigeGetInferenceResultNumOfTextObjects返回的元素数量。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

See also: SaigeTextObject

`SaigeGetInferenceResultEnhancedImage`¶

SaigeGetInferenceResultEnhancedImage

int SaigeGetInferenceResultEnhancedImage (
    SaigeInferenceResult result,
    unsigned char ** image
)

获取图像增强（IEN）结果的高质量图像。

Parameters:

result 包含推理结果的结果句柄。
image [out] 存储增强图像数据的指针。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultInspectionTime`¶

SaigeGetInferenceResultInspectionTime

int SaigeGetInferenceResultInspectionTime (
    SaigeInferenceResult result,
    long long * imreadTime,
    long long * inferenceTime,
    long long * postProcessingTime
)

获取推理API执行各个阶段所花费的时间，单位为毫秒。

Parameters:

result 包含推理结果的结果句柄。
imreadTime [out] 读取图像所花费的时间。
inferenceTime [out] 图像预处理和深度学习推理所花费的时间。
postProcessingTime [out] 后处理所花费的时间。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeGetInferenceResultProductId`¶

SaigeGetInferenceResultProductId

int SaigeGetInferenceResultProductId (
    SaigeInferenceResult result,
    const char ** productId,
    unsigned int * length
)

获取推理执行期间使用或生成的产品ID。

Parameters:

result 包含推理结果的结果句柄。
productId [out] 指向产品ID字符串的指针。
length [out] 产品ID字符串的长度。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeInitializeAlignModule`¶

激活Saige Alignment功能的函数。

int SaigeInitializeAlignModule (
    const int gpuIndex,
    const int sourceWidth,
    const int sourceHeight,
    const int targetWidth,
    const int targetHeight
)

Alignment功能将Source图像的位置调整到与Target图像匹配并裁剪它。因此，Source图像必须大于Target图像。

Parameters:

gpuIndex 此功能使用GPU，是要使用的GPU的索引。
sourceWidth
sourceHeight
targetWidth
targetHeight

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeFinalizeAlignModule`¶

结束Saige Alignment功能的函数。释放功能使用的GPU内存。

int SaigeFinalizeAlignModule ()

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeAlignImageFromByteArray`¶

将Source图像的位置调整到与Target图像匹配的函数。

int SaigeAlignImageFromByteArray (
    const unsigned char * sourceImage,
    const int sourceWidth,
    const int sourceHeight,
    const int sourceChannel,
    const unsigned char * targetImage,
    const int targetWidht,
    const int targetHeight,
    const int targetChannel,
    unsigned int flag,
    unsigned char * croppedSourceImage
)

Crop的Source图像的大小应为targetWidth * targetHeight * sourceChannel。

Parameters:

sourceImage Source图像的字节数组。
sourceWidth Source图像的宽度。
sourceHeight Source图像的高度。
sourceChannel Source图像的通道。
targetImage Target图像的字节数组。
targetWidht Target图像的宽度。
targetHeight Target图像的高度。
targetChannel Target图像的通道。
flag 是否检测裁剪的Source图像的边缘。
croppedSourceImage 裁剪的Source图像的字节数组。

Returns:

errorCode 成功时返回0，失败时返回错误代码。

`SaigeAlignImageFromFile`¶

Not Implemented

int SaigeAlignImageFromFile (
    const char * sourceImagePath,
    const char * targetImagePath,
    int * cropWidth,
    int * cropHeight,
    int * cropChannel,
    unsigned char * croppedSourceImage
)

`SaigeCreateInferenceHandle`¶

创建一个推理句柄。

int SaigeCreateInferenceHandle (
    SaigeInferenceHandle * handle,
    const int projectType,
    const char * modelFilePath,
    const int deviceIndex,
    SaigeHandleConfig * config,
    const unsigned int flags
)

请确保项目类型和模型文件路径根据预期任务正确设置。如果指定的项目类型与模型文件中的项目信息不匹配，将会发生错误。

Parameters:

handle [out] 要使用的推理句柄。
projectType 表示项目类型的整数值。
modelFilePath 模型文件的路径。
deviceIndex 用于推理的设备索引。使用 GPU 的索引（非负整数）表示 GPU，使用 -1 表示 CPU。
config 包含推理句柄配置设置的结构。
flags 要配置的项目。

Returns:

errorCode 成功时返回 0，发生错误时返回错误代码。

`SaigeDestroyInferenceHandle`¶

销毁推理句柄。

int SaigeDestroyInferenceHandle (
    SaigeInferenceHandle handle
)

Parameters:

handle 已完成使用的推理句柄。

Returns:

errorCode 成功时返回 0，发生错误时返回错误代码。

`SaigeCreateInferenceResult`¶

创建结果句柄。

int SaigeCreateInferenceResult (
    SaigeInferenceResult * result
)

Parameters:

result [out] 要使用的结果句柄。

Returns:

errorCode 成功时返回 0，发生错误时返回错误代码。

`SaigeDestroyInferenceResult`¶

销毁结果句柄。

int SaigeDestroyInferenceResult (
    SaigeInferenceResult result
)

Parameters:

result 已完成使用的结果句柄。

Returns:

errorCode 成功时返回 0，发生错误时返回错误代码。

`SaigeGetModelInfo`¶

从推理句柄中检索模型信息。

int SaigeGetModelInfo (
    SaigeInferenceHandle handle,
    SaigeModelInfo * info
)

Parameters:

handle 要检索信息的推理句柄。
info [out] 用于存储模型信息的结构。

Returns:

errorCode 成功时返回 0，发生错误时返回错误代码。

`SaigeSetInferenceOption`¶

在推理句柄上设置推理选项值。

int SaigeSetInferenceOption (
    SaigeInferenceHandle handle,
    SaigeInferenceOption * option,
    const unsigned int flags
)

Parameters:

handle 要使用的推理句柄。
option 包含要设置的选项值的结构。
flags 要设置的特定选项项目。

Returns:

errorCode 成功时返回 0，失败时返回错误代码。

See also: SaigeInferenceOption

`SaigeGetInferenceOption`¶

从推理句柄中检索推理选项值。

int SaigeGetInferenceOption (
    SaigeInferenceHandle handle,
    SaigeInferenceOption * option
)

Parameters:

handle 要从中检索选项值的推理句柄。
option [out] 用于存储检索到的选项值的结构。

Returns:

errorCode 成功时返回 0，失败时返回错误代码。

See also: SaigeInferenceOption

`SaigeStrError`¶

SaigeStrError

const char * SaigeStrError (
    const int errnum
)

获取与给定的SaigeVision错误代码相对应的消息。

Parameters:

errnum 错误代码。

Returns:

errorMessage 返回与错误代码相关联的错误消息。

`SaigeGetModuleVersion`¶

SaigeGetModuleVersion

const char * SaigeGetModuleVersion ()

获取SaigeVision使用的模块版本。

Returns:

格式：(功能)版本; (功能)版本; ...

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

`SAIGE_WRITE_ON_MODEL_FILE`¶

(Common) 使用 SaigeSetInferenceOption 设置推理选项值时，此标志还会将选项值保存到模型文件中。

#define SAIGE_WRITE_ON_MODEL_FILE 0x01

`SAIGE_SET_CALC_TIME`¶

(Common) 设置 calcTime 选项的标志。

#define SAIGE_SET_CALC_TIME 0x2

`SAIGE_SET_OVERSIZED_IMAGE_HANDLING`¶

(SEG, OCR, IEN) 设置 oversizedImageHandling 选项的标志。

#define SAIGE_SET_OVERSIZED_IMAGE_HANDLING 0x4

`SAIGE_SET_ADDITIONAL_SCORES`¶

(CLS) 设置 additionalScores 选项的标志。

#define SAIGE_SET_ADDITIONAL_SCORES 0x8

`SAIGE_SET_CALC_CLASS_ACTIVATION_MAP`¶

(CLS) 设置 calcClassActivationMap 选项的标志。

#define SAIGE_SET_CALC_CLASS_ACTIVATION_MAP 0x10

`SAIGE_SET_MAX_NUM_OF_DETECTED_OBJECTS`¶

(DET) 设置 maxNumOfDetectedObjects 选项的标志。

#define SAIGE_SET_MAX_NUM_OF_DETECTED_OBJECTS 0x20

`SAIGE_SET_CALC_SCOREMAP`¶

(SEG) 设置 calcScoremap 选项的标志。

#define SAIGE_SET_CALC_SCOREMAP 0x40

`SAIGE_SET_CALC_OBJECT`¶

(SEG, IAD) 设置 calcObject 选项的标志。

#define SAIGE_SET_CALC_OBJECT 0x80

`SAIGE_SET_CALC_OBJECT_AREA_AND_APPLY_THRESHOLD`¶

(SEG, IAD) 设置 calcObjectAreaAndApplyThreshold 选项的标志。

#define SAIGE_SET_CALC_OBJECT_AREA_AND_APPLY_THRESHOLD 0x100

`SAIGE_SET_CALC_OBJECT_SCORE_AND_APPLY_THRESHOLD`¶

(SEG, IAD) 设置 calcObjectScoreAndApplyThreshold 选项的标志。

#define SAIGE_SET_CALC_OBJECT_SCORE_AND_APPLY_THRESHOLD 0x200

`SAIGE_SET_OBJECT_BOUNDARY_THRESHOLD`¶

(SEG, IAD) 在SEG中设置 objectBoundaryThresholdPerClass 选项，在IAD中设置 objectBoundaryThreshold 选项的标志。

#define SAIGE_SET_OBJECT_BOUNDARY_THRESHOLD 0x400

`SAIGE_SET_OBJECT_AREA_THRESHOLD`¶

(SEG, DET, IAD) 在SEG和DET中设置 objectAreaThresholdPerClass 选项，在IAD中设置 objectAreaThreshold 选项的标志。

#define SAIGE_SET_OBJECT_AREA_THRESHOLD 0x800

`SAIGE_SET_OBJECT_SCORE_THRESHOLD`¶

(SEG, DET, IAD) 在SEG和DET中设置 objectScoreThresholdPerClass 选项，在IAD中设置 objectScoreThreshold 选项的标志。

#define SAIGE_SET_OBJECT_SCORE_THRESHOLD 0x1000

`SAIGE_SET_CALC_MASK`¶

(SEG, IAD) 设置 calcMask 选项的标志。

#define SAIGE_SET_CALC_MASK 0x2000

`SAIGE_SET_CALC_HEATMAP`¶

(IAD) 设置 calcHeatmap 选项的标志。

#define SAIGE_SET_CALC_HEATMAP 0x4000

`SAIGE_SET_ANOMALY_SCORE_THRESHOLD`¶

(IAD) 设置 anomalyScoreThreshold 选项的标志。

#define SAIGE_SET_ANOMALY_SCORE_THRESHOLD 0x8000

`SAIGE_SET_HEATMAP_COLOR_RANGE`¶

(IAD) 设置 heatmapColorRangeMin 和 heatmapColorRangeMax 选项的标志。

#define SAIGE_SET_HEATMAP_COLOR_RANGE 0x10000

`SAIGE_SET_POLYGON_SCORE_THRESHOLD`¶

(OCR) 设置 polygonScoreThreshold 选项的标志。

#define SAIGE_SET_POLYGON_SCORE_THRESHOLD 0x20000

`SAIGE_SET_TEXT_SIZE_RANGE`¶

(OCR) 设置 textSizeRangeMin 和 textSizeRangeMax 选项的标志。

#define SAIGE_SET_TEXT_SIZE_RANGE 0x40000

`SAIGE_SET_NUM_OF_TEXT_OBJECTS`¶

(OCR) 设置 maxNumOfTextObjects 选项的标志。

#define SAIGE_SET_NUM_OF_TEXT_OBJECTS 0x80000

`SAIGE_SET_TEXT_SCORE_THRESHOLD`¶

(OCR) 设置 textScoreThreshold 选项的标志。

#define SAIGE_SET_TEXT_SCORE_THRESHOLD 0x100000

`SAIGE_SET_TEXT_FORMATTING`¶

(OCR) 设置 textFormatting 选项的标志。

#define SAIGE_SET_TEXT_FORMATTING 0x200000

`SAIGE_IMAGE_COLOR`¶

指示颜色图像数据的标志。

#define SAIGE_IMAGE_COLOR 0x01

`SAIGE_IMAGE_16BIT`¶

指示每通道16位图像数据的标志。

#define SAIGE_IMAGE_16BIT 0x02

`SAIGE_IMAGE_ALPHA`¶

指示带有Alpha通道的数据的标志。

#define SAIGE_IMAGE_ALPHA 0x04

`SAIGE_IMAGE_BGR`¶

指示颜色通道顺序为蓝色、绿色、红色的数据的标志。

#define SAIGE_IMAGE_BGR 0x08

`SAIGE_IMAGE_8BIT_GRAY`¶

指示8位灰度图像数据的宏。它是一个大小为Width x Height的单通道数组。

#define SAIGE_IMAGE_8BIT_GRAY 0x00

`SAIGE_IMAGE_24BIT_RGB`¶

指示24位RGB彩色图像数据的宏。它是一个大小为Width x Height x Channels (3)的数组，通道顺序为R, G, B。

#define SAIGE_IMAGE_24BIT_RGB ( SAIGE_IMAGE_COLOR )

`SAIGE_IMAGE_24BIT_BGR`¶

指示24位BGR彩色图像数据的宏。它是一个大小为Width x Height x Channels (3)的数组，通道顺序为B, G, R。

#define SAIGE_IMAGE_24BIT_BGR ( SAIGE_IMAGE_COLOR | SAIGE_IMAGE_BGR )

`SAIGE_IMAGE_32BIT_RGBA`¶

指示32位RGBA彩色图像数据的宏。它是一个大小为Width x Height x Channels (4)的数组，通道顺序为R, G, B, A。

#define SAIGE_IMAGE_32BIT_RGBA ( SAIGE_IMAGE_COLOR | SAIGE_IMAGE_ALPHA )

`SAIGE_IMAGE_32BIT_BGRA`¶

指示32位BGRA彩色图像数据的宏。它是一个大小为Width x Height x Channels (4)的数组，通道顺序为B, G, R, A。

#define SAIGE_IMAGE_32BIT_BGRA ( SAIGE_IMAGE_COLOR | SAIGE_IMAGE_ALPHA | SAIGE_IMAGE_BGR )

`SAIGE_IMAGE_16BIT_GRAY`¶

指示16位灰度图像数据的宏。它是一个大小为Width x Height的单通道数组，每个像素表示为unsigned short。

#define SAIGE_IMAGE_16BIT_GRAY ( SAIGE_IMAGE_16BIT )

`SAIGE_IMAGE_48BIT_RGB`¶

指示48位RGB彩色图像数据的宏。它是一个大小为Width x Height x Channels (3)的数组，通道顺序为R, G, B，每个像素表示为unsigned short。

#define SAIGE_IMAGE_48BIT_RGB ( SAIGE_IMAGE_COLOR | SAIGE_IMAGE_16BIT )

`SAIGE_IMAGE_48BIT_BGR`¶

指示48位BGR彩色图像数据的宏。它是一个大小为Width x Height x Channels (3)的数组，通道顺序为B, G, R，每个像素表示为unsigned short。

#define SAIGE_IMAGE_48BIT_BGR ( SAIGE_IMAGE_COLOR | SAIGE_IMAGE_16BIT | SAIGE_IMAGE_BGR )

`SAIGE_IMAGE_64BIT_RGBA`¶

指示64位RGBA彩色图像数据的宏。它是一个大小为Width x Height x Channels (4)的数组，通道顺序为R, G, B, A，每个像素表示为unsigned short。

#define SAIGE_IMAGE_64BIT_RGBA ( SAIGE_IMAGE_COLOR | SAIGE_IMAGE_16BIT | SAIGE_IMAGE_ALPHA )

`SAIGE_IMAGE_64BIT_BGRA`¶

指示64位BGRA彩色图像数据的宏。它是一个大小为Width x Height x Channels (4)的数组，通道顺序为B, G, R, A，每个像素表示为unsigned short。

#define SAIGE_IMAGE_64BIT_BGRA ( SAIGE_IMAGE_COLOR | SAIGE_IMAGE_16BIT | SAIGE_IMAGE_ALPHA | SAIGE_IMAGE_BGR )

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

`SAIGEVISION_RUNTIME_VERSION_PATCH`¶

SAIGE VISION 运行版 C/C++ SDK 的补丁版本

#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 运行版 C/C++ SDK 的版本（已弃用）。请使用 MAJOR、MINOR 和 PATCH 版本。

#define SAIGEVISION_RUNTIME_VERSION "2.12.0"

`SAIGE_SET_BATCH_SIZE`¶

(CLS, DET, SEG, IAD) 设置推理的批量大小的标志。用于应用批量推理 API 时。

#define SAIGE_SET_BATCH_SIZE 0x01

See also: SaigeHandleConfig::batchSize

`SAIGE_SET_INSPECTION_SIZE`¶

(SEG, OCR) 设置用于推理的图像宽度和高度的标志。

#define SAIGE_SET_INSPECTION_SIZE 0x02

`SAIGE_OPTIMIZE_HANDLE`¶

(Common) 应用优化到推理句柄的标志。应用推理优化可以减少推理时间，但可能会略微改变结果。

#define SAIGE_OPTIMIZE_HANDLE 0x04

`SAIGE_DO_NOT_INSPECT`¶

(SEG) oversizedImageHandling 的选项之一，设置该值时不执行推理并引发错误。

#define SAIGE_DO_NOT_INSPECT "do_not_inspect"

`SAIGE_DO_NOT_ENHANCE`¶

(IEN) oversizedImageHandling 的选项之一，设置该值时不执行推理并引发错误。

#define SAIGE_DO_NOT_ENHANCE "do_not_enhance"

`SAIGE_RESIZE_TO_FIT`¶

(SEG) oversizedImageHandling 的选项之一，设置该值时，图像将按比例缩放以适应检查大小，然后执行推理。

#define SAIGE_RESIZE_TO_FIT "resize_to_fit"

`SAIGE_CROP_INTO_TILES`¶

(SEG, IEN) oversizedImageHandling 的选项之一，设置该值时，图像将根据检查大小裁剪为多个瓦片。对每个瓦片进行推理，并将结果组合在一起。

#define SAIGE_CROP_INTO_TILES "crop_into_tiles"

SaigeVisionAPI.h¶

Classes¶

Public Types¶

Public Attributes¶

Public Functions¶

Macros¶

Public Types Documentation¶

SaigeInferenceHandle¶

SaigeInferenceResult¶

Public Attributes Documentation¶

kProjectTypeCLS¶

kProjectTypeDET¶

kProjectTypeSEG¶

kProjectTypeIAD¶

kProjectTypeOCR¶

kProjectTypeIEN¶

kMaxLenOfClassName¶

kMaxNumOfClasses¶

kMaxLenOfModelName¶

kMaxLenOfCameraName¶

kMaxLenOfTrainedVersion¶

kMaxLenOfToolName¶

kMaxLenOfTextFormatting¶

Public Functions Documentation¶

SaigeInferFromImageFile¶

SaigeInferFromByteArray¶

SaigeInferFromByteArrayWithProductId¶

SaigeInferFromMultipleByteArray¶

SaigeInferFromMultiPageByteArray¶

SaigeGetInferenceResultScore¶

SaigeGetInferenceResultClass¶

SaigeGetInferenceResultClassActivationMap¶

SaigeGetInferenceResultNumOfDetectedObjects¶

SaigeGetInferenceResultDetectedObjects¶

SaigeGetInferenceResultNumOfSegmentedObjects¶

SaigeGetInferenceResultSegmentedObjects¶

SaigeGetInferenceResultMask¶

SaigeGetInferenceResultScoremapSEG¶

SaigeGetInferenceResultIsOversized¶

SaigeGetInferenceResultAnomalyScores¶

SaigeGetInferenceResultIsNg¶

SaigeGetInferenceResultScoremapIAD¶

SaigeGetInferenceResultHeatmap¶

SaigeGetInferenceResultNumOfTextObjects¶

SaigeGetInferenceResultTextObjects¶

SaigeGetInferenceResultEnhancedImage¶

SaigeGetInferenceResultInspectionTime¶

SaigeGetInferenceResultProductId¶

SaigeInitializeAlignModule¶

SaigeFinalizeAlignModule¶

SaigeAlignImageFromByteArray¶

SaigeAlignImageFromFile¶

SaigeCreateInferenceHandle¶

SaigeDestroyInferenceHandle¶

SaigeCreateInferenceResult¶

SaigeDestroyInferenceResult¶

SaigeGetModelInfo¶

SaigeSetInferenceOption¶

SaigeGetInferenceOption¶

SaigeStrError¶

SaigeGetModuleVersion¶

SaigeSetHandleMetadata¶

SaigeSetInferenceMetadata¶

SaigeSetResultMetadata¶

Macro Definition Documentation¶

SAIGE_WRITE_ON_MODEL_FILE¶

SAIGE_SET_CALC_TIME¶

SAIGE_SET_OVERSIZED_IMAGE_HANDLING¶

SAIGE_SET_ADDITIONAL_SCORES¶

SAIGE_SET_CALC_CLASS_ACTIVATION_MAP¶

SAIGE_SET_MAX_NUM_OF_DETECTED_OBJECTS¶

SAIGE_SET_CALC_SCOREMAP¶

SAIGE_SET_CALC_OBJECT¶

SAIGE_SET_CALC_OBJECT_AREA_AND_APPLY_THRESHOLD¶

SAIGE_SET_CALC_OBJECT_SCORE_AND_APPLY_THRESHOLD¶

SAIGE_SET_OBJECT_BOUNDARY_THRESHOLD¶

SAIGE_SET_OBJECT_AREA_THRESHOLD¶

SAIGE_SET_OBJECT_SCORE_THRESHOLD¶

SAIGE_SET_CALC_MASK¶

SAIGE_SET_CALC_HEATMAP¶

`SaigeInferenceHandle`¶

`SaigeInferenceResult`¶

`kProjectTypeCLS`¶

`kProjectTypeDET`¶

`kProjectTypeSEG`¶

`kProjectTypeIAD`¶

`kProjectTypeOCR`¶

`kProjectTypeIEN`¶

`kMaxLenOfClassName`¶

`kMaxNumOfClasses`¶

`kMaxLenOfModelName`¶

`kMaxLenOfCameraName`¶

`kMaxLenOfTrainedVersion`¶

`kMaxLenOfToolName`¶

`kMaxLenOfTextFormatting`¶

`SaigeInferFromImageFile`¶

`SaigeInferFromByteArray`¶

`SaigeInferFromByteArrayWithProductId`¶

`SaigeInferFromMultipleByteArray`¶

`SaigeInferFromMultiPageByteArray`¶

`SaigeGetInferenceResultScore`¶

`SaigeGetInferenceResultClass`¶

`SaigeGetInferenceResultClassActivationMap`¶

`SaigeGetInferenceResultNumOfDetectedObjects`¶

`SaigeGetInferenceResultDetectedObjects`¶

`SaigeGetInferenceResultNumOfSegmentedObjects`¶

`SaigeGetInferenceResultSegmentedObjects`¶

`SaigeGetInferenceResultMask`¶

`SaigeGetInferenceResultScoremapSEG`¶

`SaigeGetInferenceResultIsOversized`¶

`SaigeGetInferenceResultAnomalyScores`¶

`SaigeGetInferenceResultIsNg`¶

`SaigeGetInferenceResultScoremapIAD`¶

`SaigeGetInferenceResultHeatmap`¶

`SaigeGetInferenceResultNumOfTextObjects`¶

`SaigeGetInferenceResultTextObjects`¶

`SaigeGetInferenceResultEnhancedImage`¶

`SaigeGetInferenceResultInspectionTime`¶

`SaigeGetInferenceResultProductId`¶

`SaigeInitializeAlignModule`¶

`SaigeFinalizeAlignModule`¶

`SaigeAlignImageFromByteArray`¶

`SaigeAlignImageFromFile`¶

`SaigeCreateInferenceHandle`¶

`SaigeDestroyInferenceHandle`¶

`SaigeCreateInferenceResult`¶

`SaigeDestroyInferenceResult`¶

`SaigeGetModelInfo`¶

`SaigeSetInferenceOption`¶

`SaigeGetInferenceOption`¶

`SaigeStrError`¶

`SaigeGetModuleVersion`¶

`SaigeSetHandleMetadata`¶

`SaigeSetInferenceMetadata`¶

`SaigeSetResultMetadata`¶

`SAIGE_WRITE_ON_MODEL_FILE`¶

`SAIGE_SET_CALC_TIME`¶

`SAIGE_SET_OVERSIZED_IMAGE_HANDLING`¶

`SAIGE_SET_ADDITIONAL_SCORES`¶

`SAIGE_SET_CALC_CLASS_ACTIVATION_MAP`¶

`SAIGE_SET_MAX_NUM_OF_DETECTED_OBJECTS`¶

`SAIGE_SET_CALC_SCOREMAP`¶

`SAIGE_SET_CALC_OBJECT`¶

`SAIGE_SET_CALC_OBJECT_AREA_AND_APPLY_THRESHOLD`¶

`SAIGE_SET_CALC_OBJECT_SCORE_AND_APPLY_THRESHOLD`¶

`SAIGE_SET_OBJECT_BOUNDARY_THRESHOLD`¶

`SAIGE_SET_OBJECT_AREA_THRESHOLD`¶

`SAIGE_SET_OBJECT_SCORE_THRESHOLD`¶

`SAIGE_SET_CALC_MASK`¶

`SAIGE_SET_CALC_HEATMAP`¶

`SAIGE_SET_ANOMALY_SCORE_THRESHOLD`¶

`SAIGE_SET_HEATMAP_COLOR_RANGE`¶

`SAIGE_SET_POLYGON_SCORE_THRESHOLD`¶

`SAIGE_SET_TEXT_SIZE_RANGE`¶

`SAIGE_SET_NUM_OF_TEXT_OBJECTS`¶

`SAIGE_SET_TEXT_SCORE_THRESHOLD`¶

`SAIGE_SET_TEXT_FORMATTING`¶

`SAIGE_IMAGE_COLOR`¶

`SAIGE_IMAGE_16BIT`¶

`SAIGE_IMAGE_ALPHA`¶