Classifier Model

Typedefs
typedef struct _vx_classifier_model *	vx_classifier_model
	classification model to be used in vxScanClassifierNode. The classification models are loadable by undefined binary format see vxImportClassifierModel. Extensions will be added to the specification, to support a defined binary format.

Enumerations
enum	vx_classifier_model_format_e { VX_CLASSIFIER_MODEL_UNDEFINED = VX_ENUM_BASE( VX_ID_KHRONOS, VX_ENUM_CLASSIFIER_MODEL ) + 0x0 }
	Classifier model format enums. In the main specification only undefined binary format is supported. Extensions to the specification will be added in order to support specific binary format. More...
enum	vx_classifier_type_e { VX_TYPE_CLASSIFER_MODEL = 0x02C }
	The type enumeration lists all classifier extension types. More...

Functions
VX_API_ENTRY vx_classifier_model VX_API_CALL	vxImportClassifierModel (vx_context context, vx_enum format, const vx_uint8 *ptr, vx_size length)
	Creates an opaque reference classifier model This function creates a classifier model to be used in vxScanClassifierNode. The object classifier object is a read-only constant object. It cannot be changed during graph execution.
VX_API_ENTRY vx_status VX_API_CALL	vxReleaseClassifierModel (vx_classifier_model *model)
	Releases a reference of an ClassifierModel object. The object may not be garbage collected until its total reference and its contained objects count is zero. After returning from this function the reference is zeroed/cleared.

Detailed Description

Typedef Documentation

vx_classifier_model

typedef struct _vx_classifier_model* vx_classifier_model

#include <vx_khr_class.h>

classification model to be used in vxScanClassifierNode. The classification models are loadable by undefined binary format see vxImportClassifierModel. Extensions will be added to the specification, to support a defined binary format.

Enumeration Type Documentation

vx_classifier_model_format_e

enum vx_classifier_model_format_e

#include <vx_khr_class.h>

Classifier model format enums. In the main specification only undefined binary format is supported. Extensions to the specification will be added in order to support specific binary format.

Enumerator
VX_CLASSIFIER_MODEL_UNDEFINED	Undefined binary format. Using this enumeration will result in an implementation defined behaviour.

vx_classifier_type_e

enum vx_classifier_type_e

#include <vx_khr_class.h>

The type enumeration lists all classifier extension types.

Enumerator
VX_TYPE_CLASSIFER_MODEL	A vx_classifier_model. type.

Function Documentation

vxImportClassifierModel()

VX_API_ENTRY vx_classifier_model VX_API_CALL vxImportClassifierModel	(	vx_context	context,
		vx_enum	format,
		const vx_uint8 *	ptr,
		vx_size	length )

#include <vx_khr_class.h>

Creates an opaque reference classifier model This function creates a classifier model to be used in vxScanClassifierNode. The object classifier object is a read-only constant object. It cannot be changed during graph execution.

Parameters

[in]	context	Reference to the context where to create the ClassifierModel.
[in]	format	The binary format which contain the classifier model. See vx_classifier_model_format_e. Currently only undefined binary format is supported. Extensions will be added to the specification, to support a classification model defined binary format.
[in]	ptr	A memory pointer to the binary format.
[in]	length	size in bytes of binary format data.

Returns

A ClassifierModel reference vx_classifier_model. Any possible errors preventing a successful creation should be checked using vxGetStatus.

vxReleaseClassifierModel()

VX_API_ENTRY vx_status VX_API_CALL vxReleaseClassifierModel

(

vx_classifier_model *

model

)

#include <vx_khr_class.h>

Releases a reference of an ClassifierModel object. The object may not be garbage collected until its total reference and its contained objects count is zero. After returning from this function the reference is zeroed/cleared.

Parameters

[in]

model

The pointer to the ClassifierModel to release.

Returns

A vx_status_e enumeration.

Return values

<tt>VX_SUCCESS</tt>	No errors; all other values indicate failure
An	error occurred. See vx_status_e.