Class Image Classification

ImageClassification Class

说明

一个用于表示和获取图像分类神经网络所识别对象相关数据的类。

语法

class ImageClassificationResult

成员

公共构造函数
ImageClassificationResult::ImageClassificationResult	构造一个 ImageClassificationResult 对象。
公共方法
ImageClassificationResult::classID	获取识别对象的类别 ID。
ImageClassificationResult::score	获取识别对象的置信度分数。

ImageClassificationResult::classID

说明

获取识别对象的类别 ID。

语法

int classID(void);

参数

NA

返回值

NA

示例代码

示例：RTSPImageClassification

备注

使用该类函数必须包含 "NNImageClassification.h"。对象类别可以从 "ClassificationClassList.h" 文件中获取。

ImageClassificationResult::score

说明

获取识别对象的置信度分数。

语法

int score(void);

参数

NA

返回值

NA

示例代码

示例：RTSPImageClassification

备注

使用该类函数必须包含 "NNImageClassification.h"。对象类别可以从 "ClassificationClassList.h" 文件中获取。

NNImageClassification Class

说明

一个用于配置、运行和获取图像分类神经网络模型结果的类。

语法

class NNImageClassification

成员

公共构造函数
NNImageClassification::NNImageClassification	构造一个 NNImageClassification 对象
公共方法
NNImageClassification::configInputImageColor	配置模型训练过程中使用的输入图像色彩模式
NNImageClassification::configVideo	配置输入视频流参数
NNImageClassification::configRegionOfInterest	配置图像分类的感兴趣区域
NNImageClassification::begin	在输入视频上启动图像分类处理
NNImageClassification::end	停止输入视频上的图像分类处理
NNImageClassification::setResultCallback	设置用户回调函数
NNImageClassification::getResultCount	获取目标检测结果的数量
NNImageClassification::getResult	获取图像分类结果
NNImageClassification::parseModelMetaData	解析并从模型元数据中提取关键信息，用于图像分类
NNImageClassification::getClassNameFromMeta	根据给定的类别索引，从模型元数据中获取类别标签名称
NNImageClassification::useModelMetaData	检查当前是否启用了模型元数据的使用

NNImageClassification::configInputImageColor

说明

配置模型训练过程中使用的输入图像色彩模式。

语法

void configInputImageColor(int color);

参数

color：用于模型训练的图像的色彩模式。

0（灰度）
1（RGB）

返回值

NA

示例代码

示例：RTSPImageClassification

备注

使用该类函数必须包含 "NNImageClassification.h"。

NNImageClassification::configVideo

说明

配置输入视频流参数。

语法

void configVideo(VideoSetting &config);

参数

config：包含所需视频配置的 VideoSetting 类对象。

返回值

NA

示例代码

示例：RTSPImageClassification

备注

使用该类函数必须包含 "NNImageClassification.h"。

NNImageClassification::configRegionOfInterest

说明

配置图像分类的感兴趣区域。

语法

void configRegionOfInterest(int xmin, int xmax, int ymin, int ymax);

参数

xmin：感兴趣区域的左边界，以像素为单位。

xmax：感兴趣区域的右边界，以像素为单位。

ymin：感兴趣区域的上边界，以像素为单位。

ymax：感兴趣区域的下边界，以像素为单位。

返回值

NA

示例代码

NA

备注

使用该类函数必须包含 "NNImageClassification.h"。

NNImageClassification::begin

说明

在输入视频上启动图像分类处理。

语法

void begin (void);

参数

NA

返回值

NA

示例代码

示例：RTSPImageClassification

备注

使用该类函数必须包含 "NNImageClassification.h"。

NNImageClassification::end

说明

停止输入视频上的图像分类处理。

语法

void end (void);

参数

NA

返回值

NA

示例代码

NA

备注

使用该类函数必须包含 "NNImageClassification.h"。

NNImageClassification::setResultCallback

说明

设置用户回调函数。

语法

void setResultCallback(void (*ic_callback)(void));

参数

ic_callback：用户回调函数。

返回值

NA

示例代码

示例：RTSPImageClassification

备注

使用该类函数必须包含 "NNImageClassification.h"。

NNImageClassification::getResultCount

说明

获取目标检测结果的数量。

语法

uint16_t getResultCount(void);

参数

NA

返回值

最近一组结果中检测到的对象数量，以无符号整数形式返回。

示例代码

示例：RTSPImageClassification

备注

使用该类函数必须包含 "NNImageClassification.h"。

NNImageClassification::getResult

说明

获取图像分类结果。

语法

ImageClassificationResult getResult(uint16_t index);
std::vector<ImageClassificationResult> getResult(void);

参数

index：要获取的特定图像分类结果的索引。

返回值

如果未指定索引，该函数返回一个包含所有检测到对象的 ImageClassificationResult 类对象向量。

如果指定了索引，该函数返回一个包含特定检测到对象的 ImageClassificationResult 类对象。

示例代码

示例：RTSPImageClassification

备注

使用该类函数必须包含 "NNImageClassification.h"。

NNImageClassification::parseModelMetaData

说明

解析并从模型的元数据中提取关键信息，用于图像分类。

语法

char *parseModelMetaData(mm_context_t *vipnn_ctx);

参数

vipnn_ctx：指向保存模型信息的 mm_context_t 结构体的指针。

返回值

指向包含解析后模型元数据的字符串的指针。

示例代码

NA

备注

使用该类函数必须包含 "NNImageClassification.h"。

NNImageClassification::getClassNameFromMeta

说明

根据给定的类别索引，从模型元数据中获取类别标签名称。

语法

char *getClassNameFromMeta(char *meta_data, int class_id, int prob);

参数

meta_data：指向包含类别信息的元数据缓冲区的指针。

class_id：要查找的类别的数字 ID。

prob：与该类别关联的概率或置信度值。

返回值

指向包含类别名称的字符串的指针。

示例代码

示例：RTSPImageClassification

备注

使用该类函数必须包含 "NNImageClassification.h"。

NNImageClassification::useModelMetaData

说明

检查当前是否启用了模型元数据的使用。

语法

void useModelMetaData(int use_meta_data);

参数

use_meta_data：用于控制是否使用模型元数据的标志（1 = 启用，0 = 禁用）。

返回值

NA

示例代码

示例：RTSPImageClassification

备注

使用该类函数必须包含 "NNImageClassification.h"。