org.bytedeco.javacpp

Class opencv_dnn.Blob

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.opencv_dnn.Blob

All Implemented Interfaces:

AutoCloseable

Enclosing class:

opencv_dnn

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

\brief This class provides methods for continuous n-dimensional CPU and GPU array processing. The class is realized as a wrapper over \ref cv::Mat and \ref cv::UMat. It will support methods for switching and logical synchronization between CPU and GPU.

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.Blob()
opencv_dnn.Blob(long size) Native array allocator.
opencv_dnn.Blob(opencv_core.Mat image)
opencv_dnn.Blob(opencv_core.Mat image, int dstCn) \brief Constucts 4-dimensional blob (so-called batch) from image or array of images.
opencv_dnn.Blob(opencv_dnn.BlobShape shape)
opencv_dnn.Blob(opencv_dnn.BlobShape shape, int type) \brief Constructs blob with specified \p shape and \p type.
opencv_dnn.Blob(Pointer p) Pointer cast constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	_fill(opencv_dnn.BlobShape shape, int type, Pointer data)
void	_fill(opencv_dnn.BlobShape shape, int type, Pointer data, boolean deepCopy) \brief Creates blob from user data.
int	canonicalAxis(int axis) \brief Converts \p axis index to canonical format (where 0 <= axis < dims()).
int	channels() Returns size of the second axis blob.
int	cols() Returns size of the fourth axis blob.
void	create(opencv_dnn.BlobShape shape)
void	create(opencv_dnn.BlobShape shape, int type) \brief Creates blob with specified \p shape and \p type.
int	dims() \brief Returns number of blob dimensions.
boolean	equalShape(opencv_dnn.Blob other) \brief Checks equality of two blobs shapes.
opencv_core.Mat	getPlane(int n, int cn) \brief Returns slice of first two dimensions.
opencv_core.Mat	matRef() Returns reference to cv::Mat, containing blob data.
opencv_core.Mat	matRefConst() Returns reference to cv::Mat, containing blob data, for read-only purposes.
int	num() Returns size of the first axis blob.
long	offset()
long	offset(int n, int cn, int row, int col) \overload
opencv_dnn.Blob	position(long position)
BytePointer	ptr()
BytePointer	ptr(int n, int cn, int row, int col) \brief Returns pointer to the blob element with the specified position, stored in CPU memory.
FloatPointer	ptrf()
FloatPointer	ptrf(int n, int cn, int row, int col) \overload ptr()
opencv_dnn.Blob	reshape(opencv_dnn.BlobShape shape) \brief Changes shape of the blob without copying the data.
int	rows() Returns size of the thrid axis blob.
opencv_dnn.BlobShape	shape() \brief Returns shape of the blob.
opencv_core.Scalar4i	shape4() Returns shape of first four blob axes.
opencv_dnn.Blob	shareFrom(opencv_dnn.Blob blob) \brief Shares data from other \p blob.
int	size(int axis) \brief Returns the size of the specified \p axis.
opencv_core.Size	size2() Returns cv::Size(cols(), rows())
long	total()
long	total(int startAxis, int endAxis) \brief Computes the product of sizes of axes among the specified axes range [\p startAxis; \p endAxis).
int	type() \brief Returns type of the blob.
opencv_core.UMat	umatRef() Returns reference to cv::UMat, containing blob data (not implemented yet).
opencv_core.UMat	umatRefConst() Returns reference to cv::UMat, containing blob data, for read-only purposes (not implemented yet).
int	xsize(int axis) \brief Returns the size of the specified \p axis.

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.Blob

public opencv_dnn.Blob(Pointer p)

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

opencv_dnn.Blob

public opencv_dnn.Blob(long size)

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

opencv_dnn.Blob

public opencv_dnn.Blob()

opencv_dnn.Blob

public opencv_dnn.Blob(@Const@ByRef
               opencv_dnn.BlobShape shape,
               int type)

\brief Constructs blob with specified \p shape and \p type.

opencv_dnn.Blob

public opencv_dnn.Blob(@Const@ByRef
               opencv_dnn.BlobShape shape)

opencv_dnn.Blob

public opencv_dnn.Blob(@ByVal
               opencv_core.Mat image,
               int dstCn)

\brief Constucts 4-dimensional blob (so-called batch) from image or array of images.

Parameters:

image - 2-dimensional multi-channel or 3-dimensional single-channel image (or array of images)

dstCn - specify size of second axis of ouptut blob

opencv_dnn.Blob

public opencv_dnn.Blob(@ByVal
               opencv_core.Mat image)

Method Detail

position

public opencv_dnn.Blob position(long position)

Overrides:

position in class Pointer

create

public void create(@Const@ByRef
          opencv_dnn.BlobShape shape,
          int type)

\brief Creates blob with specified \p shape and \p type.

create

public void create(@Const@ByRef
          opencv_dnn.BlobShape shape)

_fill

@Name(value="fill")
public void _fill(@Const@ByRef
                   opencv_dnn.BlobShape shape,
                   int type,
                   Pointer data,
                   @Cast(value="bool")
                   boolean deepCopy)

\brief Creates blob from user data. \details If \p deepCopy is false then CPU data will not be allocated.

_fill

@Name(value="fill")
public void _fill(@Const@ByRef
                   opencv_dnn.BlobShape shape,
                   int type,
                   Pointer data)

matRef

@ByRef
public opencv_core.Mat matRef()

Returns reference to cv::Mat, containing blob data.

matRefConst

@Const
@ByRef
public opencv_core.Mat matRefConst()

Returns reference to cv::Mat, containing blob data, for read-only purposes.

umatRef

@ByRef
public opencv_core.UMat umatRef()

Returns reference to cv::UMat, containing blob data (not implemented yet).

umatRefConst

@Const
@ByRef
public opencv_core.UMat umatRefConst()

Returns reference to cv::UMat, containing blob data, for read-only purposes (not implemented yet).

dims

public int dims()

\brief Returns number of blob dimensions.

size

public int size(int axis)

\brief Returns the size of the specified \p axis. Negative \p axis is supported, in this case a counting starts from the last axis, i. e. -1 corresponds to last axis. If non-existing axis was passed then an error will be generated.

xsize

public int xsize(int axis)

\brief Returns the size of the specified \p axis. Does the same thing as size(int) const, but if non-existing axis will be passed then 1 will be returned, therefore this function always finishes successfully.

total

@Cast(value="size_t")
public long total(int startAxis,
                   int endAxis)

\brief Computes the product of sizes of axes among the specified axes range [\p startAxis; \p endAxis).

Parameters:

startAxis - the first axis to include in the range.

endAxis - the first axis to exclude from the range. \details Negative axis indexing can be used.

total

@Cast(value="size_t")
public long total()

canonicalAxis

public int canonicalAxis(int axis)

\brief Converts \p axis index to canonical format (where 0 <= axis < dims()).

shape

@ByVal
public opencv_dnn.BlobShape shape()

\brief Returns shape of the blob.

equalShape

@Cast(value="bool")
public boolean equalShape(@Const@ByRef
                           opencv_dnn.Blob other)

\brief Checks equality of two blobs shapes.

getPlane

@ByVal
public opencv_core.Mat getPlane(int n,
                             int cn)

\brief Returns slice of first two dimensions. \details The behaviour is similar to the following numpy code: blob[n, cn, ...]

cols

public int cols()

Returns size of the fourth axis blob.

rows

public int rows()

Returns size of the thrid axis blob.

channels

public int channels()

Returns size of the second axis blob.

num

public int num()

Returns size of the first axis blob.

size2

@ByVal
public opencv_core.Size size2()

Returns cv::Size(cols(), rows())

shape4

@ByVal
public opencv_core.Scalar4i shape4()

Returns shape of first four blob axes.

offset

@Cast(value="size_t")
public long offset(int n,
                    int cn,
                    int row,
                    int col)

\overload

offset

@Cast(value="size_t")
public long offset()

ptr

@Cast(value="uchar*")
public BytePointer ptr(int n,
                        int cn,
                        int row,
                        int col)

\brief Returns pointer to the blob element with the specified position, stored in CPU memory. \p n correspond to the first axis, \p cn - to the second, etc. If dims() > 4 then unspecified coordinates will be filled by zeros. If dims() < 4 then extra coordinates will be ignored.

ptr

@Cast(value="uchar*")
public BytePointer ptr()

ptrf

public FloatPointer ptrf(int n,
                int cn,
                int row,
                int col)

\overload ptr()

ptrf

public FloatPointer ptrf()

shareFrom

@ByRef
public opencv_dnn.Blob shareFrom(@Const@ByRef
                              opencv_dnn.Blob blob)

\brief Shares data from other \p blob.

Returns:

*this

reshape

@ByRef
public opencv_dnn.Blob reshape(@Const@ByRef
                            opencv_dnn.BlobShape shape)

\brief Changes shape of the blob without copying the data.

Returns:

*this

type

public int type()

\brief Returns type of the blob.