This class represents high-level API for classification models. More...

Inheritance diagram for OpenCVForUnity.DnnModule.ClassificationModel:

Public Member Functions
	ClassificationModel (string model, string config)
	Create classification model from network represented in one of the supported formats. An order of `model` and `config` arguments does not matter. More...

	ClassificationModel (string model)
	Create classification model from network represented in one of the supported formats. An order of `model` and `config` arguments does not matter. More...

	ClassificationModel (Net network)
	Create model from deep learning network. More...

ClassificationModel	setEnableSoftmaxPostProcessing (bool enable)
	Set enable/disable softmax post processing option. More...

bool	getEnableSoftmaxPostProcessing ()
	Get enable/disable softmax post processing option. More...

void	classify (Mat frame, int[] classId, float[] conf)

Public Member Functions inherited from OpenCVForUnity.DnnModule.Model
IntPtr	getNativeObjAddr ()

	Model (string model, string config)
	Create model from deep learning network represented in one of the supported formats. An order of `model` and `config` arguments does not matter. More...

	Model (string model)
	Create model from deep learning network represented in one of the supported formats. An order of `model` and `config` arguments does not matter. More...

	Model (Net network)
	Create model from deep learning network. More...

Model	setInputSize (Size size)
	Set input size for frame. More...

Model	setInputSize (int width, int height)

Model	setInputMean (Scalar mean)
	Set mean value for frame. More...

Model	setInputScale (Scalar scale)
	Set scalefactor value for frame. More...

Model	setInputCrop (bool crop)
	Set flag crop for frame. More...

Model	setInputSwapRB (bool swapRB)
	Set flag swapRB for frame. More...

void	setInputParams (double scale, Size size, Scalar mean, bool swapRB, bool crop)
	Set preprocessing parameters for frame. More...

void	setInputParams (double scale, Size size, Scalar mean, bool swapRB)
	Set preprocessing parameters for frame. More...

void	setInputParams (double scale, Size size, Scalar mean)
	Set preprocessing parameters for frame. More...

void	setInputParams (double scale, Size size)
	Set preprocessing parameters for frame. More...

void	setInputParams (double scale)
	Set preprocessing parameters for frame. More...

void	setInputParams ()
	Set preprocessing parameters for frame. More...

void	predict (Mat frame, List< Mat > outs)
	Given the `input` frame, create input blob, run net and return the output `blobs`. More...

Model	setPreferableBackend (int backendId)

Model	setPreferableTarget (int targetId)

Model	enableWinograd (bool useWinograd)

Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()

void	ThrowIfDisposed ()

Static Public Member Functions
static new ClassificationModel	__fromPtr__ (IntPtr addr)

Static Public Member Functions inherited from OpenCVForUnity.DnnModule.Model
static Model	__fromPtr__ (IntPtr addr)

Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr	ThrowIfNullIntPtr (IntPtr ptr)

Protected Member Functions
override void	Dispose (bool disposing)

Protected Member Functions inherited from OpenCVForUnity.DnnModule.Model
override void	Dispose (bool disposing)

Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()

	DisposableOpenCVObject (IntPtr ptr)

	DisposableOpenCVObject (bool isEnabledDispose)

	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)

Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()

	DisposableObject (bool isEnabledDispose)

Additional Inherited Members
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed `[get, protected set]`

bool	IsEnabledDispose `[get, set]`

Detailed Description

This class represents high-level API for classification models.

ClassificationModel allows to set params for preprocessing input image. ClassificationModel creates net from file with trained weights and config, sets preprocessing input, runs forward pass and return top-1 prediction.

Constructor & Destructor Documentation

◆ ClassificationModel() [1/3]

OpenCVForUnity.DnnModule.ClassificationModel.ClassificationModel	(	string	model,
		string	config
	)

Create classification model from network represented in one of the supported formats. An order of model and config arguments does not matter.

Parameters

[in]	model	Binary file contains trained weights.
[in]	config	Text file contains network configuration.

◆ ClassificationModel() [2/3]

OpenCVForUnity.DnnModule.ClassificationModel.ClassificationModel ( string model )

Create classification model from network represented in one of the supported formats. An order of model and config arguments does not matter.

Parameters

[in]	model	Binary file contains trained weights.
[in]	config	Text file contains network configuration.

◆ ClassificationModel() [3/3]

OpenCVForUnity.DnnModule.ClassificationModel.ClassificationModel ( Net network )

Create model from deep learning network.

Parameters

[in] network Net object.

Member Function Documentation

◆ fromPtr()

static new ClassificationModel OpenCVForUnity.DnnModule.ClassificationModel.__fromPtr__ ( IntPtr addr )

static

◆ classify()

void OpenCVForUnity.DnnModule.ClassificationModel.classify	(	Mat	frame,
		int []	classId,
		float []	conf
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ Dispose()

override void OpenCVForUnity.DnnModule.ClassificationModel.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.DisposableOpenCVObject.

◆ getEnableSoftmaxPostProcessing()

bool OpenCVForUnity.DnnModule.ClassificationModel.getEnableSoftmaxPostProcessing ( )

Get enable/disable softmax post processing option.

This option defaults to false, softmax post processing is not applied within the classify() function.

◆ setEnableSoftmaxPostProcessing()

ClassificationModel OpenCVForUnity.DnnModule.ClassificationModel.setEnableSoftmaxPostProcessing ( bool enable )

Set enable/disable softmax post processing option.

If this option is true, softmax is applied after forward inference within the classify() function to convert the confidences range to [0.0-1.0]. This function allows you to toggle this behavior. Please turn true when not contain softmax layer in model.

Parameters

[in] enable Set enable softmax post processing within the classify() function.

The documentation for this class was generated from the following file:

OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/dnn/ClassificationModel.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClassificationModel() [1/3]

◆ ClassificationModel() [2/3]

◆ ClassificationModel() [3/3]

Member Function Documentation

◆ __fromPtr__()

◆ classify()

◆ Dispose()

◆ getEnableSoftmaxPostProcessing()

◆ setEnableSoftmaxPostProcessing()

◆ fromPtr()