ailia_classifier.h File Reference

object classification library More...

#include "ailia.h"
#include "ailia_format.h"

Include dependency graph for ailia_classifier.h:

Go to the source code of this file.

Classes
struct	_AILIAClassifierClass

Macros
#define	AILIA_CLASSIFIER_CLASS_VERSION   (1)

Typedefs
typedef struct _AILIAClassifierClass	AILIAClassifierClass

Functions
int AILIA_API	ailiaCreateClassifier (struct AILIAClassifier **classifier, struct AILIANetwork *net, unsigned int format, unsigned int channel, unsigned int range)
	Creates a classifier instance. More...
void AILIA_API	ailiaDestroyClassifier (struct AILIAClassifier *classifier)
	Destroys the classifier instance. More...
int AILIA_API	ailiaClassifierCompute (struct AILIAClassifier *classifier, const void *src, unsigned int src_stride, unsigned int src_width, unsigned int src_height, unsigned int src_format, unsigned int max_class_count)
	Performs object classification. More...
int AILIA_API	ailiaClassifierGetClassCount (struct AILIAClassifier *classifier, unsigned int *cls_count)
	Gets the number of classification results. More...
int AILIA_API	ailiaClassifierGetClass (struct AILIAClassifier *classifier, AILIAClassifierClass *obj, unsigned int cls_idx, unsigned int version)
	Gets the classification results. More...

Detailed Description

object classification library

Copyright

AXELL CORPORATION, ailia Inc.

Date

2021/07/28

Macro Definition Documentation

AILIA_CLASSIFIER_CLASS_VERSION

#define AILIA_CLASSIFIER_CLASS_VERSION   (1)

Typedef Documentation

AILIAClassifierClass

typedef struct _AILIAClassifierClass AILIAClassifierClass

Function Documentation

ailiaClassifierCompute()

int AILIA_API ailiaClassifierCompute	(	struct AILIAClassifier *	classifier,
		const void *	src,
		unsigned int	src_stride,
		unsigned int	src_width,
		unsigned int	src_height,
		unsigned int	src_format,
		unsigned int	max_class_count
	)

Performs object classification.

Parameters

classifier	A classifier instance pointer
src	Image data (32 bpp)
src_stride	The number of bytes in 1 line
src_width	Image width
src_height	Image height
src_format	Image format (AILIA_IMAGE_FORMAT_*)
max_class_count	The maximum number of classification results

Returns

If this function is successful, it returns AILIA_STATUS_SUCCESS , or an error code otherwise.

ailiaClassifierGetClass()

int AILIA_API ailiaClassifierGetClass	(	struct AILIAClassifier *	classifier,
		AILIAClassifierClass *	obj,
		unsigned int	cls_idx,
		unsigned int	version
	)

Gets the classification results.

Parameters

classifier	A classifier instance pointer
cls	Class information
cls_idx	Class index
version	AILIA_CLASSIFIER_CLASS_VERSION

Returns

If this function is successful, it returns AILIA_STATUS_SUCCESS , or an error code otherwise.

If ailiaClassifierCompute() is not run at all, the function returns AILIA_STATUS_INVALID_STATE . The classification results are sorted in the order of estimated probability.

ailiaClassifierGetClassCount()

int AILIA_API ailiaClassifierGetClassCount	(	struct AILIAClassifier *	classifier,
		unsigned int *	cls_count
	)

Gets the number of classification results.

Parameters

classifier	A classifier instance pointer
cls_count	The number of classes

Returns

If this function is successful, it returns AILIA_STATUS_SUCCESS , or an error code otherwise.

ailiaCreateClassifier()

int AILIA_API ailiaCreateClassifier	(	struct AILIAClassifier **	classifier,
		struct AILIANetwork *	net,
		unsigned int	format,
		unsigned int	channel,
		unsigned int	range
	)

Creates a classifier instance.

Parameters

classifier	A pointer to a classifier instance pointer
net	A network instance pointer
format	The network image format (AILIA_NETWORK_IMAGE_FORMAT_*)
channel	The network image channel (AILIA_NETWORK_IMAGE_CHANNEL_*)
range	The network image range (AILIA_NETWORK_IMAGE_RANGE_*)

Returns

If this function is successful, it returns AILIA_STATUS_SUCCESS , or an error code otherwise.

ailiaDestroyClassifier()

void AILIA_API ailiaDestroyClassifier

(

struct AILIAClassifier *

classifier

)

Destroys the classifier instance.

Parameters

classifier

A classifier instance pointer