实用函数¶

提供简单的图像处理、推理结果可视化等实用函数。

Public Functions¶

Type	Name
void	SaigeInitTextFormatting (SaigeTextFormatting * formatting) 初始化给定 SaigeTextFormatting 中字符集包含状态的布尔数组，所有值设置为 false。
unsigned int	SaigeConvertImageType (const int channel, const int type) 将图像通道数和 SaigeImageType 转换为 SaigeInferFromByteArray 中使用的图像标志宏。此函数用于准备推理所需的图像数据。
int	SaigeOverlaySegmentedObjects (const void * baseImage, const SaigeSegmentedObject * objects, SaigeModelInfo * modelInfo, const int numOfSegmentedObjects, const int width, const int height, const int channels, const int type, const bool isRGB, const double overlayAlpha, void * resultImage) 在基础图像上绘制分割对象并将结果存储在输出图像中。此函数允许在原始图像上可视化分割结果。
int	SaigeOverlayDetectedObjects (const void * baseImage, const SaigeDetectedObject * objects, SaigeModelInfo * modelInfo, const int numOfDetectedObjects, const int width, const int height, const int channels, const int type, const bool withClassName, const bool isRGB, const double overlayAlpha, void * resultImage) 在基础图像上绘制检测到的对象的边界框，并将结果存储在输出图像中。此函数允许在原始图像上可视化检测结果。
int	SaigeOverlayTextObjects (const void * baseImage, const SaigeTextObject * objects, const int numOfTextObjects, const int width, const int height, const int channels, const int type, const bool isRGB, const double overlayAlpha, const double textScale, void * resultImage) 在基础图像上绘制OCR结果，表示为SaigeTextObject，并将结果存储在输出图像中。当前，韩文显示为‘？’，未来计划支持。
int	SaigeOverlayHeatmap (const void * baseImage, const float * heatmap, const int width, const int height, const int channels, const int type, const bool isRGB, const double overlayAlpha, void * resultImage) 在基础图像上绘制上色的热图，并将结果存储在输出图像中。此函数有助于可视化热图数据与原始图像的关系。
int	SaigeShowImage (const void * image, const int width, const int height, const int channels, const int type, const bool isRGB, const bool invert, const double alpha, const int waitMS) 在单独的窗口中显示图像。此函数在开发或调试过程中可用于可视化图像。
void *	SaigeCropWithRotatedBox (const void * originalImage, const int width, const int height, const int channel, SaigeRotatedBox * rotatedBox, int * croppedWidth, int * croppedHeight)
int	SaigeFreeCroppedImage (void * croppedImage)

Public Functions Documentation¶

`SaigeInitTextFormatting`¶

初始化给定 SaigeTextFormatting 中字符集包含状态的布尔数组，所有值设置为 false。

void SaigeInitTextFormatting (
    SaigeTextFormatting * formatting
)

Parameters:

formatting 要设置的变量的指针。

`SaigeConvertImageType`¶

将图像通道数和 SaigeImageType 转换为 SaigeInferFromByteArray 中使用的图像标志宏。此函数用于准备推理所需的图像数据。

unsigned int SaigeConvertImageType (
    const int channel,
    const int type
)

Parameters:

channel 图像的通道数。
type 图像的数据类型。有关设置选项，请参阅 SaigeDrawImage。

Returns:

imageFlag 返回转换后的图像标志宏。

`SaigeOverlaySegmentedObjects`¶

在基础图像上绘制分割对象并将结果存储在输出图像中。此函数允许在原始图像上可视化分割结果。

int SaigeOverlaySegmentedObjects (
    const void * baseImage,
    const SaigeSegmentedObject * objects,
    SaigeModelInfo * modelInfo,
    const int numOfSegmentedObjects,
    const int width,
    const int height,
    const int channels,
    const int type,
    const bool isRGB,
    const double overlayAlpha,
    void * resultImage
)

Parameters:

baseImage 将要绘制分割对象的基础图像数据。
objects 从推理中检测到的分割对象数组。
modelInfo 模型信息，用于类颜色；如果为null，则使用红色。
numOfSegmentedObjects 分割对象数量。
width 基础和结果图像的宽度。
height 基础和结果图像的高度。
channels 基础和结果图像的通道数。
type 图像的类型。有关详细信息，请参阅 SaigeImageType。
overlayAlpha 可视化分割对象时的透明度值；范围为0到1，值越接近1表示分割对象越透明。
resultImage [out] 存储绘制了分割对象的结果图像数据。

Returns:

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

`SaigeOverlayDetectedObjects`¶

在基础图像上绘制检测到的对象的边界框，并将结果存储在输出图像中。此函数允许在原始图像上可视化检测结果。

int SaigeOverlayDetectedObjects (
    const void * baseImage,
    const SaigeDetectedObject * objects,
    SaigeModelInfo * modelInfo,
    const int numOfDetectedObjects,
    const int width,
    const int height,
    const int channels,
    const int type,
    const bool withClassName,
    const bool isRGB,
    const double overlayAlpha,
    void * resultImage
)

Parameters:

baseImage 将要绘制检测对象的基础图像数据。
objects 从推理中检测到的对象数组。
modelInfo 模型信息，用于类名称和颜色；如果为null，则使用红色。
numOfDetectedObjects 检测到的对象数量。
width 基础和结果图像的宽度。
height 基础和结果图像的高度。
channels 基础和结果图像的通道数。
type 图像的类型。有关详细信息，请参阅 SaigeImageType。
withClassName 如果设置为true，还会显示每个检测对象的类名。
isRGB 如果设置为true，表示图像数据为RGB顺序。
overlayAlpha 可视化检测对象时的透明度值；范围为0到1，值越接近1表示检测对象越透明。
resultImage [out] 存储绘制了检测对象的结果图像数据。

Returns:

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

`SaigeOverlayTextObjects`¶

在基础图像上绘制OCR结果，表示为SaigeTextObject，并将结果存储在输出图像中。当前，韩文显示为‘？’，未来计划支持。

int SaigeOverlayTextObjects (
    const void * baseImage,
    const SaigeTextObject * objects,
    const int numOfTextObjects,
    const int width,
    const int height,
    const int channels,
    const int type,
    const bool isRGB,
    const double overlayAlpha,
    const double textScale,
    void * resultImage
)

Parameters:

baseImage 将要绘制SaigeTextObject的基础图像数据。
objects 从推理中检测到的SaigeTextObject数组。
numOfSaigeTextObject SaigeTextObject的数量。
width 基础和结果图像的宽度。
height 基础和结果图像的高度。
channels 基础和结果图像的通道数。
type 图像的类型。有关详细信息，请参阅 SaigeImageType。
isRGB 如果设置为true，则表示图像数据为RGB顺序。
overlayAlpha 可视化SaigeTextObject时的透明度值；范围为0到1，值越接近1表示SaigeTextObject越透明。
resultImage [out] 存储绘制了SaigeTextObject的结果图像数据。

Returns:

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

See also: SaigeGetInferenceResultNumOfSaigeTextObject, SaigeGetInferenceResultSaigeTextObject

`SaigeOverlayHeatmap`¶

在基础图像上绘制上色的热图，并将结果存储在输出图像中。此函数有助于可视化热图数据与原始图像的关系。

int SaigeOverlayHeatmap (
    const void * baseImage,
    const float * heatmap,
    const int width,
    const int height,
    const int channels,
    const int type,
    const bool isRGB,
    const double overlayAlpha,
    void * resultImage
)

Parameters:

baseImage 将要绘制热图的基础图像数据。
heatmap 从检查结果获得的热图数据数组。
width 基础和结果图像的宽度。
height 基础和结果图像的高度。
channels 基础和结果图像的通道数。
type 图像的类型。有关详细信息，请参阅 SaigeImageType。
isRGB 如果设置为true，则表示图像数据为RGB顺序。
overlayAlpha 可视化热图时的透明度值；范围为0到1，值越接近1表示热图越透明。
resultImage [out] 存储绘制了热图的结果图像数据。

Returns:

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

`SaigeShowImage`¶

在单独的窗口中显示图像。此函数在开发或调试过程中可用于可视化图像。

int SaigeShowImage (
    const void * image,
    const int width,
    const int height,
    const int channels,
    const int type,
    const bool isRGB,
    const bool invert,
    const double alpha,
    const int waitMS
)

Parameters:

image 要显示的图像数据。
width 图像的宽度。
height 图像的高度。
channels 图像的通道数。
type 图像的数据类型。有关设置选项，请参阅 SaigeImageType。
isRGB 如果设置为true，则表示图像数据为RGB顺序。
invert 如果设置为true，则在显示过程中颜色会被反转。
alpha 乘以图像数据像素值的值；这有助于调整显示图像的亮度。
waitMS 显示持续时间（以毫秒为单位）；如果设置为0，则必须手动关闭显示窗口。

`SaigeCropWithRotatedBox`¶

void * SaigeCropWithRotatedBox (
    const void * originalImage,
    const int width,
    const int height,
    const int channel,
    SaigeRotatedBox * rotatedBox,
    int * croppedWidth,
    int * croppedHeight
)

`SaigeFreeCroppedImage`¶

int SaigeFreeCroppedImage (
    void * croppedImage
)

实用函数¶

Public Functions¶

Public Functions Documentation¶

SaigeInitTextFormatting¶

SaigeConvertImageType¶

SaigeOverlaySegmentedObjects¶

SaigeOverlayDetectedObjects¶

SaigeOverlayTextObjects¶

SaigeOverlayHeatmap¶

SaigeShowImage¶

SaigeCropWithRotatedBox¶

SaigeFreeCroppedImage¶

`SaigeInitTextFormatting`¶

`SaigeConvertImageType`¶

`SaigeOverlaySegmentedObjects`¶

`SaigeOverlayDetectedObjects`¶

`SaigeOverlayTextObjects`¶

`SaigeOverlayHeatmap`¶

`SaigeShowImage`¶

`SaigeCropWithRotatedBox`¶

`SaigeFreeCroppedImage`¶