Net Class

This class allows to create and manipulate comprehensive artificial neural networks.

Inheritance Hierarchy

SystemObject
  OpenCvSharpDisposableObject
    OpenCvSharpDisposableCvObject
      OpenCvSharp.DnnNet

Namespace: OpenCvSharp.Dnn
Assembly: OpenCvSharp (in OpenCvSharp.dll) Version: 1.0.0

Syntax

C++

Copy

public class Net : DisposableCvObject

Public Class Net
	Inherits DisposableCvObject

public ref class Net : public DisposableCvObject

type Net =  
    class
        inherit DisposableCvObject
    end

The Net type exposes the following members.

Constructors

	Name	Description
	Net	Default constructor.
	Net(IntPtr)	Initializes a new instance of the Net class

Top

Properties

	Name	Description
	AllocatedMemory	Gets or sets a memory address allocated by AllocMemory. (Inherited from DisposableObject.)
	AllocatedMemorySize	Gets or sets the byte length of the allocated memory (Inherited from DisposableObject.)
	CvPtr	Native pointer of OpenCV structure (Inherited from DisposableCvObject.)
	DataHandle	Gets or sets a handle which allocates using cvSetData. (Inherited from DisposableObject.)
	IsDisposed	Gets a value indicating whether this instance has been disposed. (Inherited from DisposableObject.)
	IsEnabledDispose	Gets or sets a value indicating whether you permit disposing this instance. (Inherited from DisposableObject.)

Top

Methods

	Name	Description
	AllocGCHandle	Pins the object to be allocated by cvSetData. (Inherited from DisposableObject.)
	AllocMemory	Allocates the specified size of memory. (Inherited from DisposableObject.)
	Connect(String, String)	Connects output of the first layer to input of the second layer.
	Connect(Int32, Int32, Int32, Int32)	Connects #@p outNum output of the first layer to #@p inNum input of the second layer.
	Dispose	Releases the resources (Inherited from DisposableObject.)
	Dispose(Boolean)	Releases the resources (Inherited from DisposableObject.)
	DisposeManaged	Releases managed resources (Inherited from DisposableObject.)
	DisposeUnmanaged	(Overrides DisposableCvObjectDisposeUnmanaged.)
	Empty	Returns true if there are no layers in the network.
	EnableFusion	Enables or disables layer fusion in the network.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Destructor (Inherited from DisposableObject.)
	Forward(String)	Runs forward pass to compute output of layer with name @p outputName. By default runs forward pass for the whole network.
	Forward(IEnumerableMat, IEnumerableString)	Runs forward pass to compute outputs of layers listed in @p outBlobNames.
	Forward(IEnumerableMat, String)	Runs forward pass to compute output of layer with name @p outputName.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLayerId	Converts string name of the layer to the integer identifier.
	GetLayerNames
	GetPerfProfile	Returns overall time for inference and timings (in ticks) for layers. Indexes in returned vector correspond to layers ids.Some layers can be fused with others, in this case zero ticks count will be return for that skipped layers.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUnconnectedOutLayers	Returns indexes of layers with unconnected outputs.
	GetUnconnectedOutLayersNames	Returns names of layers with unconnected outputs.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyMemoryPressure	Notifies the allocated size of memory. (Inherited from DisposableObject.)
	ReadNet	Read deep learning network represented in one of the supported formats. This function automatically detects an origin framework of trained model and calls an appropriate function such @ref readNetFromCaffe, @ref readNetFromTensorflow,
	ReadNetFromCaffe	Reads a network model stored in Caffe model files.
	ReadNetFromDarknet	Reads a network model stored in Darknet (https://pjreddie.com/darknet/) model files.
	ReadNetFromModelOptimizer	Load a network from Intel's Model Optimizer intermediate representation. Networks imported from Intel's Model Optimizer are launched in Intel's Inference Engine backend.
	ReadNetFromONNX	Reads a network model ONNX https://onnx.ai/
	ReadNetFromTensorflow	Reads a network model stored in Tensorflow model file.
	ReadNetFromTorch	Reads a network model stored in Torch model file.
	SetHalideScheduler	Compile Halide layers. Schedule layers that support Halide backend. Then compile them for specific target.For layers that not represented in scheduling file or if no manual scheduling used at all, automatic scheduling will be applied.
	SetInput	Sets the new value for the layer output blob
	SetInputsNames	Sets outputs names of the network input pseudo layer.
	SetPreferableBackend	Ask network to use specific computation backend where it supported.
	SetPreferableTarget	Ask network to make computations on specific target device.
	ThrowIfDisposed	If this object is disposed, then ObjectDisposedException is thrown. (Inherited from DisposableObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	ptr	Data pointer (Inherited from DisposableCvObject.)

Top

Remarks

Neural network is presented as directed acyclic graph(DAG), where vertices are Layer instances, and edges specify relationships between layers inputs and outputs. Each network layer has unique integer id and unique string name inside its network. LayerId can store either layer name or layer id. This class supports reference counting of its instances, i.e.copies point to the same instance.

Reference

OpenCvSharp.Dnn Namespace