org.bytedeco.javacpp

Class opencv_dnn.Net

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.opencv_dnn.Net

All Implemented Interfaces:

AutoCloseable

Enclosing class:

opencv_dnn

@Namespace(value="cv::dnn")
@NoOffset
public static class opencv_dnn.Net
extends Pointer

\brief This class allows to create and manipulate comprehensive artificial neural networks. 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.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
opencv_dnn.Net() Default constructor.
opencv_dnn.Net(long size) Native array allocator.
opencv_dnn.Net(Pointer p) Pointer cast constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	addLayer(BytePointer name, BytePointer type, opencv_dnn.LayerParams params) \brief Adds new layer to the net.
int	addLayer(String name, String type, opencv_dnn.LayerParams params)
int	addLayerToPrev(BytePointer name, BytePointer type, opencv_dnn.LayerParams params) \brief Adds new layer and connects its first input to the first output of previously added layer.
int	addLayerToPrev(String name, String type, opencv_dnn.LayerParams params)
void	connect(BytePointer outPin, BytePointer inpPin) \brief Connects output of the first layer to input of the second layer.
void	connect(int outLayerId, int outNum, int inpLayerId, int inpNum) \brief Connects #\p outNum output of the first layer to #\p inNum input of the second layer.
void	connect(String outPin, String inpPin)
void	deleteLayer(opencv_dnn.DictValue layer) \brief Delete layer for the network (not implemented yet)
void	forward() \brief Runs forward pass for the whole network
void	forward(opencv_dnn.DictValue toLayer) \brief Runs forward pass to compute output of layer \p toLayer
opencv_dnn.Blob	getBlob(BytePointer outputName) \brief Returns the layer output blob.
opencv_dnn.Blob	getBlob(String outputName)
int	getLayerId(BytePointer layer) \brief Converts string name of the layer to the integer identifier.
int	getLayerId(String layer)
opencv_dnn.Blob	getParam(opencv_dnn.DictValue layer)
opencv_dnn.Blob	getParam(opencv_dnn.DictValue layer, int numParam) \brief Returns parameter blob of the layer.
opencv_dnn.Net	position(long position)
void	setBlob(BytePointer outputName, opencv_dnn.Blob blob) \brief Sets the new value for the layer output blob
void	setBlob(String outputName, opencv_dnn.Blob blob)
void	setNetInputs(opencv_core.StringVector inputBlobNames) \brief Sets ouputs names of the network input pseudo layer.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, hashCode, isNull, limit, limit, maxBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, position, put, setNull, sizeof, toString, totalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

opencv_dnn.Net

public opencv_dnn.Net(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

opencv_dnn.Net

public opencv_dnn.Net(long size)

Native array allocator. Access with Pointer.position(long).

opencv_dnn.Net

public opencv_dnn.Net()

Default constructor.

Method Detail

position

public opencv_dnn.Net position(long position)

Overrides:

position in class Pointer

addLayer

public int addLayer(@opencv_core.Str
           BytePointer name,
           @opencv_core.Str
           BytePointer type,
           @ByRef
           opencv_dnn.LayerParams params)

\brief Adds new layer to the net.

Parameters:

name - unique name of the adding layer.

type - typename of the adding layer (type must be registered in LayerRegister).

params - parameters which will be used to initialize the creating layer.

Returns:

unique identifier of created layer, or -1 if a failure will happen.

addLayer

public int addLayer(@opencv_core.Str
           String name,
           @opencv_core.Str
           String type,
           @ByRef
           opencv_dnn.LayerParams params)

addLayerToPrev

public int addLayerToPrev(@opencv_core.Str
                 BytePointer name,
                 @opencv_core.Str
                 BytePointer type,
                 @ByRef
                 opencv_dnn.LayerParams params)

\brief Adds new layer and connects its first input to the first output of previously added layer.

See Also:

addLayer()

addLayerToPrev

public int addLayerToPrev(@opencv_core.Str
                 String name,
                 @opencv_core.Str
                 String type,
                 @ByRef
                 opencv_dnn.LayerParams params)

getLayerId

public int getLayerId(@opencv_core.Str
             BytePointer layer)

\brief Converts string name of the layer to the integer identifier.

Returns:

id of the layer, or -1 if the layer wasn't found.

getLayerId

public int getLayerId(@opencv_core.Str
             String layer)

deleteLayer

public void deleteLayer(@ByVal@Cast(value="cv::dnn::Net::LayerId*")
               opencv_dnn.DictValue layer)

\brief Delete layer for the network (not implemented yet)

connect

public void connect(@opencv_core.Str
           BytePointer outPin,
           @opencv_core.Str
           BytePointer inpPin)

\brief Connects output of the first layer to input of the second layer.

Parameters:

outPin - descriptor of the first layer output.

inpPin - descriptor of the second layer input. Descriptors have the following template <layer_name>[.input_number]: - the first part of the template layer_name is sting name of the added layer. If this part is empty then the network input pseudo layer will be used; - the second optional part of the template input_number is either number of the layer input, either label one. If this part is omitted then the first layer input will be used.

See Also:

setNetInputs(), Layer::inputNameToIndex(), Layer::outputNameToIndex()

connect

public void connect(@opencv_core.Str
           String outPin,
           @opencv_core.Str
           String inpPin)

connect

public void connect(int outLayerId,
           int outNum,
           int inpLayerId,
           int inpNum)

\brief Connects #\p outNum output of the first layer to #\p inNum input of the second layer.

Parameters:

outLayerId - identifier of the first layer

inpLayerId - identifier of the second layer

outNum - number of the first layer output

inpNum - number of the second layer input

setNetInputs

public void setNetInputs(@Const@ByRef
                opencv_core.StringVector inputBlobNames)

\brief Sets ouputs names of the network input pseudo layer. Each net always has special own the network input pseudo layer with id=0. This layer stores the user blobs only and don't make any computations. In fact, this layer provides the only way to pass user data into the network. As any other layer, this layer can label its outputs and this function provides an easy way to do this.

forward

public void forward()

\brief Runs forward pass for the whole network

forward

public void forward(@ByVal@Cast(value="cv::dnn::Net::LayerId*")
           opencv_dnn.DictValue toLayer)

\brief Runs forward pass to compute output of layer \p toLayer

setBlob

public void setBlob(@opencv_core.Str
           BytePointer outputName,
           @Const@ByRef
           opencv_dnn.Blob blob)

\brief Sets the new value for the layer output blob

Parameters:

outputName - descriptor of the updating layer output blob.

blob - new blob.

See Also:

to know format of the descriptor. \note If updating blob is not empty then \p blob must have the same shape, because network reshaping is not implemented yet.

setBlob

public void setBlob(@opencv_core.Str
           String outputName,
           @Const@ByRef
           opencv_dnn.Blob blob)

getBlob

@ByVal
public opencv_dnn.Blob getBlob(@opencv_core.Str
                            BytePointer outputName)

\brief Returns the layer output blob.

Parameters:

outputName - the descriptor of the returning layer output blob.

See Also:

connect(String, String)

getBlob

@ByVal
public opencv_dnn.Blob getBlob(@opencv_core.Str
                            String outputName)

getParam

@ByVal
public opencv_dnn.Blob getParam(@ByVal@Cast(value="cv::dnn::Net::LayerId*")
                             opencv_dnn.DictValue layer,
                             int numParam)

\brief Returns parameter blob of the layer.

Parameters:

layer - name or id of the layer.

numParam - index of the layer parameter in the Layer::blobs array.

See Also:

Layer::blobs

getParam

@ByVal
public opencv_dnn.Blob getParam(@ByVal@Cast(value="cv::dnn::Net::LayerId*")
                             opencv_dnn.DictValue layer)