org.bytedeco.javacpp

Class opencv_core.Mat

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.helper.opencv_core.AbstractArray

org.bytedeco.javacpp.helper.opencv_core.AbstractMat

org.bytedeco.javacpp.opencv_core.Mat

Enclosing class:

opencv_core

public static class opencv_core.Mat
extends opencv_core.AbstractMat

The n-dimensional matrix class. The class represents an n-dimensional dense numerical array that can act as a matrix, image, optical flow map, 3-focal tensor etc. It is very similar to CvMat and CvMatND types from earlier versions of OpenCV, and similarly to those types, the matrix can be multi-channel. It also fully supports ROI mechanism. There are many different ways to create cv::Mat object. Here are the some popular ones:

• using cv::Mat::create(nrows, ncols, type) method or the similar constructor cv::Mat::Mat(nrows, ncols, type[, fill_value]) constructor. A new matrix of the specified size and specifed type will be allocated. "type" has the same meaning as in cvCreateMat function, e.g. CV_8UC1 means 8-bit single-channel matrix, CV_32FC2 means 2-channel (i.e. complex) floating-point matrix etc: \code // make 7x7 complex matrix filled with 1+3j. cv::Mat M(7,7,CV_32FC2,Scalar(1,3)); // and now turn M to 100x60 15-channel 8-bit matrix. // The old content will be deallocated M.create(100,60,CV_8UC(15)); \endcode As noted in the introduction of this chapter, Mat::create() will only allocate a new matrix when the current matrix dimensionality or type are different from the specified.
• by using a copy constructor or assignment operator, where on the right side it can be a matrix or expression, see below. Again, as noted in the introduction, matrix assignment is O(1) operation because it only copies the header and increases the reference counter. cv::Mat::clone() method can be used to get a full (a.k.a. deep) copy of the matrix when you need it.
• by constructing a header for a part of another matrix. It can be a single row, single column, several rows, several columns, rectangular region in the matrix (called a minor in algebra) or a diagonal. Such operations are also O(1), because the new header will reference the same data. You can actually modify a part of the matrix using this feature, e.g. \code // add 5-th row, multiplied by 3 to the 3rd row M.row(3) = M.row(3) + M.row(5)*3; // now copy 7-th column to the 1-st column // M.col(1) = M.col(7); // this will not work Mat M1 = M.col(1); M.col(7).copyTo(M1); // create new 320x240 image cv::Mat img(Size(320,240),CV_8UC3); // select a roi cv::Mat roi(img, Rect(10,10,100,100)); // fill the ROI with (0,255,0) (which is green in RGB space); // the original 320x240 image will be modified roi = Scalar(0,255,0); \endcode Thanks to the additional cv::Mat::datastart and cv::Mat::dataend members, it is possible to compute the relative sub-matrix position in the main "container" matrix using cv::Mat::locateROI(): \code Mat A = Mat::eye(10, 10, CV_32S); // extracts A columns, 1 (inclusive) to 3 (exclusive). Mat B = A(Range::all(), Range(1, 3)); // extracts B rows, 5 (inclusive) to 9 (exclusive). // that is, C ~ A(Range(5, 9), Range(1, 3)) Mat C = B(Range(5, 9), Range::all()); Size size; Point ofs; C.locateROI(size, ofs); // size will be (width=10,height=10) and the ofs will be (x=1, y=5) \endcode As in the case of whole matrices, if you need a deep copy, use cv::Mat::clone() method of the extracted sub-matrices.
• by making a header for user-allocated-data. It can be useful for
  1. processing "foreign" data using OpenCV (e.g. when you implement a DirectShow filter or a processing module for gstreamer etc.), e.g. \code void process_video_frame(const unsigned char* pixels, int width, int height, int step) { cv::Mat img(height, width, CV_8UC3, pixels, step); cv::GaussianBlur(img, img, cv::Size(7,7), 1.5, 1.5); } \endcode
  2. for quick initialization of small matrices and/or super-fast element access \code double m[3][3] = {{a, b, c}, {d, e, f}, {g, h, i}}; cv::Mat M = cv::Mat(3, 3, CV_64F, m).inv(); \endcode
  partial yet very common cases of this "user-allocated data" case are conversions from CvMat and IplImage to cv::Mat. For this purpose there are special constructors taking pointers to CvMat or IplImage and the optional flag indicating whether to copy the data or not. Backward conversion from cv::Mat to CvMat or IplImage is provided via cast operators cv::Mat::operator CvMat() an cv::Mat::operator IplImage(). The operators do not copy the data. \code IplImage* img = cvLoadImage("greatwave.jpg", 1); Mat mtx(img); // convert IplImage* -> cv::Mat CvMat oldmat = mtx; // convert cv::Mat -> CvMat CV_Assert(oldmat.cols == img->width && oldmat.rows == img->height && oldmat.data.ptr == (uchar*)img->imageData && oldmat.step == img->widthStep); \endcode
• by using MATLAB-style matrix initializers, cv::Mat::zeros(), cv::Mat::ones(), cv::Mat::eye(), e.g.: \code // create a double-precision identity martix and add it to M. M += Mat::eye(M.rows, M.cols, CV_64F); \endcode
• by using comma-separated initializer: \code // create 3x3 double-precision identity matrix Mat M = (Mat_(3,3) << 1, 0, 0, 0, 1, 0, 0, 0, 1); \endcode here we first call constructor of cv::Mat_ class (that we describe further) with the proper matrix, and then we just put "<<" operator followed by comma-separated values that can be constants, variables, expressions etc. Also, note the extra parentheses that are needed to avoid compiler errors.

Once matrix is created, it will be automatically managed by using reference-counting mechanism (unless the matrix header is built on top of user-allocated data, in which case you should handle the data by yourself). The matrix data will be deallocated when no one points to it; if you want to release the data pointed by a matrix header before the matrix destructor is called, use cv::Mat::release(). The next important thing to learn about the matrix class is element access. Here is how the matrix is stored. The elements are stored in row-major order (row by row). The cv::Mat::data member points to the first element of the first row, cv::Mat::rows contains the number of matrix rows and cv::Mat::cols - the number of matrix columns. There is yet another member, cv::Mat::step that is used to actually compute address of a matrix element. cv::Mat::step is needed because the matrix can be a part of another matrix or because there can some padding space in the end of each row for a proper alignment. \image html roi.png Given these parameters, address of the matrix element M_{ij} is computed as following: addr(M_{ij})=M.data + M.step*i + j*M.elemSize() if you know the matrix element type, e.g. it is float, then you can use cv::Mat::at() method: addr(M_{ij})=&M.at(i,j) (where & is used to convert the reference returned by cv::Mat::at() to a pointer). if you need to process a whole row of matrix, the most efficient way is to get the pointer to the row first, and then just use plain C operator []: \code // compute sum of positive matrix elements // (assuming that M is double-precision matrix) double sum=0; for(int i = 0; i < M.rows; i++) { const double* Mi = M.ptr(i); for(int j = 0; j < M.cols; j++) sum += std::max(Mi[j], 0.); } \endcode Some operations, like the above one, do not actually depend on the matrix shape, they just process elements of a matrix one by one (or elements from multiple matrices that are sitting in the same place, e.g. matrix addition). Such operations are called element-wise and it makes sense to check whether all the input/output matrices are continuous, i.e. have no gaps in the end of each row, and if yes, process them as a single long row: \code // compute sum of positive matrix elements, optimized variant double sum=0; int cols = M.cols, rows = M.rows; if(M.isContinuous()) { cols *= rows; rows = 1; } for(int i = 0; i < rows; i++) { const double* Mi = M.ptr(i); for(int j = 0; j < cols; j++) sum += std::max(Mi[j], 0.); } \endcode in the case of continuous matrix the outer loop body will be executed just once, so the overhead will be smaller, which will be especially noticeable in the case of small matrices. Finally, there are STL-style iterators that are smart enough to skip gaps between successive rows: \code // compute sum of positive matrix elements, iterator-based variant double sum=0; MatConstIterator_ it = M.begin(), it_end = M.end(); for(; it != it_end; ++it) sum += std::max(*it, 0.); \endcode The matrix iterators are random-access iterators, so they can be passed to any STL algorithm, including std::sort().

Nested Class Summary

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

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_STEP enum cv::Mat::
static int	CONTINUOUS_FLAG enum cv::Mat::
static int	MAGIC_VAL enum cv::Mat::
static int	SUBMATRIX_FLAG enum cv::Mat::

Fields inherited from class org.bytedeco.javacpp.helper.opencv_core.AbstractMat

EMPTY

Fields inherited from class org.bytedeco.javacpp.helper.opencv_core.AbstractArray

bufferedImage, gamma22, gamma22inv

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
opencv_core.Mat() default constructor
opencv_core.Mat(BytePointer p, boolean signed)
opencv_core.Mat(DoublePointer p)
opencv_core.Mat(FloatPointer p)
opencv_core.Mat(int size)
opencv_core.Mat(int ndims, int[] sizes, int type)
opencv_core.Mat(int ndims, int[] sizes, int type, opencv_core.Scalar s)
opencv_core.Mat(int ndims, int[] sizes, int type, Pointer data)
opencv_core.Mat(int ndims, int[] sizes, int type, Pointer data, SizeTPointer steps)
opencv_core.Mat(int ndims, IntBuffer sizes, int type)
opencv_core.Mat(int ndims, IntBuffer sizes, int type, opencv_core.Scalar s)
opencv_core.Mat(int ndims, IntBuffer sizes, int type, Pointer data)
opencv_core.Mat(int ndims, IntBuffer sizes, int type, Pointer data, SizeTPointer steps)
opencv_core.Mat(int rows, int cols, int type) constructs 2D matrix of the specified size and type // (_type is CV_8UC1, CV_64FC3, CV_32SC(12) etc.)
opencv_core.Mat(int rows, int cols, int type, opencv_core.Scalar s) constucts 2D matrix and fills it with the specified value _s.
opencv_core.Mat(int rows, int cols, int type, Pointer data)
opencv_core.Mat(int rows, int cols, int type, Pointer data, long step) constructor for matrix headers pointing to user-allocated data
opencv_core.Mat(int ndims, IntPointer sizes, int type) constructs n-dimensional matrix
opencv_core.Mat(int ndims, IntPointer sizes, int type, opencv_core.Scalar s)
opencv_core.Mat(int ndims, IntPointer sizes, int type, Pointer data)
opencv_core.Mat(int ndims, IntPointer sizes, int type, Pointer data, SizeTPointer steps)
opencv_core.Mat(IntPointer p)
opencv_core.Mat(opencv_core.CvMat m)
opencv_core.Mat(opencv_core.CvMat m, boolean copyData) converts old-style CvMat to the new matrix; the data is not copied by default
opencv_core.Mat(opencv_core.CvMatND m)
opencv_core.Mat(opencv_core.CvMatND m, boolean copyData) converts old-style CvMatND to the new matrix; the data is not copied by default
opencv_core.Mat(opencv_core.GpuMat m) download data from GpuMat
opencv_core.Mat(opencv_core.IplImage img)
opencv_core.Mat(opencv_core.IplImage img, boolean copyData) converts old-style IplImage to the new matrix; the data is not copied by default
opencv_core.Mat(opencv_core.Mat m) copy constructor
opencv_core.Mat(opencv_core.Mat m, opencv_core.Range rowRange)
opencv_core.Mat(opencv_core.Mat m, opencv_core.Range rowRange, opencv_core.Range colRange) creates a matrix header for a part of the bigger matrix
opencv_core.Mat(opencv_core.Mat m, opencv_core.Rect roi)
opencv_core.Mat(opencv_core.Size size, int type)
opencv_core.Mat(opencv_core.Size size, int type, opencv_core.Scalar s)
opencv_core.Mat(opencv_core.Size size, int type, Pointer data)
opencv_core.Mat(opencv_core.Size size, int type, Pointer data, long step)
opencv_core.Mat(Pointer p)
opencv_core.Mat(ShortPointer p, boolean signed)

Method Summary

Methods

Modifier and Type	Method and Description
void	_deallocate() deallocates the matrix data
void	addref() increases the reference counter; use with care to avoid memleaks
opencv_core.Mat	adjustROI(int dtop, int dbottom, int dleft, int dright) moves/resizes the current matrix ROI inside the parent matrix.
opencv_core.MatAllocator	allocator() custom allocator
opencv_core.Mat	allocator(opencv_core.MatAllocator allocator)
opencv_core.Mat	apply(opencv_core.Range ranges)
opencv_core.Mat	apply(opencv_core.Range rowRange, opencv_core.Range colRange) extracts a rectangular sub-matrix // (this is a generalized form of row, rowRange etc.)
opencv_core.Mat	apply(opencv_core.Rect roi)
opencv_core.CvMat	asCvMat() converts header to CvMat; no data is copied
opencv_core.CvMatND	asCvMatND() converts header to CvMatND; no data is copied
opencv_core.IplImage	asIplImage() converts header to IplImage; no data is copied
void	assignTo(opencv_core.Mat m)
void	assignTo(opencv_core.Mat m, int type)
int	channels() returns element type, similar to CV_MAT_CN(cvmat->type)
int	checkVector(int elemChannels)
int	checkVector(int elemChannels, int depth, boolean requireContinuous) returns N if the matrix is 1-channel (N x ptdim) or ptdim-channel (1 x N) or (N x 1); negative number otherwise
opencv_core.Mat	clone() returns deep copy of the matrix, i.e.
opencv_core.Mat	col(int x) returns a new matrix header for the specified column
opencv_core.Mat	colRange(int startcol, int endcol) ...
opencv_core.Mat	colRange(opencv_core.Range r)
int	cols()
opencv_core.Mat	cols(int cols)
void	convertTo(opencv_core.Mat m, int rtype)
void	convertTo(opencv_core.Mat m, int rtype, double alpha, double beta) converts matrix to another datatype with optional scalng.
void	copySize(opencv_core.Mat m) internal use function; properly re-allocates _size, _step arrays
void	copyTo(opencv_core.Mat m) copies the matrix content to "m".
void	copyTo(opencv_core.Mat m, opencv_core.Mat mask) copies those matrix elements to "m" that are marked with non-zero mask elements.
void	create(int ndims, int[] sizes, int type)
void	create(int ndims, IntBuffer sizes, int type)
void	create(int rows, int cols, int type) allocates new matrix data unless the matrix already has specified size and type.
void	create(int ndims, IntPointer sizes, int type)
void	create(opencv_core.Size size, int type)
opencv_core.Mat	cross(opencv_core.Mat m) computes cross-product of 2 3D vectors
BytePointer	data() pointer to the data
opencv_core.Mat	data(BytePointer data)
BytePointer	dataend()
opencv_core.Mat	dataend(BytePointer dataend)
BytePointer	datalimit()
opencv_core.Mat	datalimit(BytePointer datalimit)
BytePointer	datastart() helper fields used in locateROI and adjustROI
opencv_core.Mat	datastart(BytePointer datastart)
int	depth() returns element type, similar to CV_MAT_DEPTH(cvmat->type)
opencv_core.Mat	diag()
opencv_core.Mat	diag(int d) ...
static opencv_core.Mat	diag(opencv_core.Mat d) constructs a square diagonal matrix which main diagonal is vector "d"
int	dims() the matrix dimensionality, >= 2
opencv_core.Mat	dims(int dims)
double	dot(opencv_core.Mat m) computes dot-product
long	elemSize() returns element size in bytes, // similar to CV_ELEM_SIZE(cvmat->type)
long	elemSize1() returns the size of element channel in bytes.
boolean	empty() returns true if matrix data is NULL
static opencv_core.MatExpr	eye(int rows, int cols, int type)
static opencv_core.MatExpr	eye(opencv_core.Size size, int type)
int	flags() includes several bit-fields: - the magic signature - continuity flag - depth - number of channels
opencv_core.Mat	flags(int flags)
opencv_core.MatExpr	inv()
opencv_core.MatExpr	inv(int method) matrix inversion by means of matrix expressions
boolean	isContinuous() returns true iff the matrix data is continuous // (i.e.
boolean	isSubmatrix() returns true if the matrix is a submatrix of another matrix
void	locateROI(opencv_core.Size wholeSize, opencv_core.Point ofs) locates matrix header within a parent matrix.
opencv_core.MatExpr	mul(opencv_core.Mat m)
opencv_core.MatExpr	mul(opencv_core.Mat m, double scale) per-element matrix multiplication by means of matrix expressions
static opencv_core.MatExpr	ones(int rows, int cols, int type)
static opencv_core.MatExpr	ones(opencv_core.Size size, int type)
void	pop_back()
void	pop_back(long nelems) removes several hyper-planes from bottom of the matrix
opencv_core.Mat	position(int position)
BytePointer	ptr()
BytePointer	ptr(int i0) returns pointer to i0-th submatrix along the dimension #0
byte[]	ptr(int[] idx)
ByteBuffer	ptr(IntBuffer idx)
BytePointer	ptr(int i0, int i1) returns pointer to (i0,i1) submatrix along the dimensions #0 and #1
BytePointer	ptr(int i0, int i1, int i2) returns pointer to (i0,i1,i3) submatrix along the dimensions #0, #1, #2
BytePointer	ptr(IntPointer idx) returns pointer to the matrix element
void	push_back_(Pointer elem) internal function
void	push_back(opencv_core.Mat m) adds element to the end of 1d matrix (or possibly multiple elements when _Tp=Mat)
opencv_core.Mat	put(opencv_core.Mat m) assignment operators
opencv_core.Mat	put(opencv_core.MatExpr expr)
opencv_core.Mat	put(opencv_core.Scalar s) sets every matrix element to s
IntPointer	refcount() pointer to the reference counter; // when matrix points to user-allocated data, the pointer is NULL
opencv_core.Mat	refcount(IntPointer refcount)
void	release() decreases reference counter; // deallocates the data when reference counter reaches 0.
void	reserve(long sz) reserves enough space to fit sz hyper-planes
opencv_core.Mat	reshape(int cn)
opencv_core.Mat	reshape(int cn, int rows) creates alternative matrix header for the same data, with different // number of channels and/or different number of rows.
opencv_core.Mat	reshape(int cn, int newndims, int[] newsz)
opencv_core.Mat	reshape(int cn, int newndims, IntBuffer newsz)
opencv_core.Mat	reshape(int cn, int newndims, IntPointer newsz)
void	resize(long sz) resizes matrix to the specified number of hyper-planes
void	resize(long sz, opencv_core.Scalar s) resizes matrix to the specified number of hyper-planes; initializes the newly added elements
opencv_core.Mat	row(int y) returns a new matrix header for the specified row
opencv_core.Mat	rowRange(int startrow, int endrow) ...
opencv_core.Mat	rowRange(opencv_core.Range r)
int	rows() the number of rows and columns or (-1, -1) when the matrix has more than 2 dimensions
opencv_core.Mat	rows(int rows)
opencv_core.Mat	setTo(opencv_core.Mat value)
opencv_core.Mat	setTo(opencv_core.Mat value, opencv_core.Mat mask) sets some of the matrix elements to s, according to the mask
opencv_core.Size	size()
int	size(int i)
long	step()
int	step(int i)
long	step1()
long	step1(int i) returns step/elemSize1()
opencv_core.MatExpr	t() matrix transposition by means of matrix expressions
long	total() returns the total number of matrix elements
int	type() returns element type, similar to CV_MAT_TYPE(cvmat->type)
static opencv_core.MatExpr	zeros(int rows, int cols, int type) Matlab-style matrix initialization
static opencv_core.MatExpr	zeros(opencv_core.Size size, int type)

Methods inherited from class org.bytedeco.javacpp.helper.opencv_core.AbstractMat

arrayChannels, arrayData, arrayDepth, arrayHeight, arrayOrigin, arrayOrigin, arrayROI, arraySize, arrayStep, arrayWidth, copyFrom, createFrom, createFrom, createFrom

Methods inherited from class org.bytedeco.javacpp.helper.opencv_core.AbstractArray

applyGamma, cloneBufferedImage, copyFrom, copyFrom, copyFrom, copyTo, copyTo, copyTo, copyTo, cvSize, decodeGamma22, encodeGamma22, flipCopyWithGamma, flipCopyWithGamma, flipCopyWithGamma, flipCopyWithGamma, flipCopyWithGamma, getBufferedImage, getBufferedImage, getBufferedImage, getBufferedImage, getBufferedImageType, getByteBuffer, getByteBuffer, getDoubleBuffer, getDoubleBuffer, getFloatBuffer, getFloatBuffer, getIntBuffer, getIntBuffer, getShortBuffer, getShortBuffer, highValue, toString

Methods inherited from class org.bytedeco.javacpp.Pointer

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

Methods inherited from class java.lang.Object

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

Field Detail

MAGIC_VAL

public static final int MAGIC_VAL

enum cv::Mat::

See Also:

Constant Field Values

AUTO_STEP

public static final int AUTO_STEP

enum cv::Mat::

See Also:

Constant Field Values

CONTINUOUS_FLAG

public static final int CONTINUOUS_FLAG

enum cv::Mat::

See Also:

Constant Field Values

SUBMATRIX_FLAG

public static final int SUBMATRIX_FLAG

enum cv::Mat::

See Also:

Constant Field Values

Constructor Detail

opencv_core.Mat

public opencv_core.Mat(Pointer p)

opencv_core.Mat

public opencv_core.Mat(int size)

opencv_core.Mat

public opencv_core.Mat()

default constructor

opencv_core.Mat

public opencv_core.Mat(int rows,
               int cols,
               int type)

constructs 2D matrix of the specified size and type // (_type is CV_8UC1, CV_64FC3, CV_32SC(12) etc.)

opencv_core.Mat

public opencv_core.Mat(opencv_core.Size size,
               int type)

opencv_core.Mat

public opencv_core.Mat(int rows,
               int cols,
               int type,
               opencv_core.Scalar s)

constucts 2D matrix and fills it with the specified value _s.

opencv_core.Mat

public opencv_core.Mat(opencv_core.Size size,
               int type,
               opencv_core.Scalar s)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               IntPointer sizes,
               int type)

constructs n-dimensional matrix

opencv_core.Mat

public opencv_core.Mat(int ndims,
               IntBuffer sizes,
               int type)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               int[] sizes,
               int type)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               IntPointer sizes,
               int type,
               opencv_core.Scalar s)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               IntBuffer sizes,
               int type,
               opencv_core.Scalar s)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               int[] sizes,
               int type,
               opencv_core.Scalar s)

opencv_core.Mat

public opencv_core.Mat(opencv_core.Mat m)

copy constructor

opencv_core.Mat

public opencv_core.Mat(int rows,
               int cols,
               int type,
               Pointer data,
               long step)

constructor for matrix headers pointing to user-allocated data

opencv_core.Mat

public opencv_core.Mat(int rows,
               int cols,
               int type,
               Pointer data)

opencv_core.Mat

public opencv_core.Mat(BytePointer p,
               boolean signed)

opencv_core.Mat

public opencv_core.Mat(ShortPointer p,
               boolean signed)

opencv_core.Mat

public opencv_core.Mat(IntPointer p)

opencv_core.Mat

public opencv_core.Mat(FloatPointer p)

opencv_core.Mat

public opencv_core.Mat(DoublePointer p)

opencv_core.Mat

public opencv_core.Mat(opencv_core.Size size,
               int type,
               Pointer data,
               long step)

opencv_core.Mat

public opencv_core.Mat(opencv_core.Size size,
               int type,
               Pointer data)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               IntPointer sizes,
               int type,
               Pointer data,
               SizeTPointer steps)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               IntPointer sizes,
               int type,
               Pointer data)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               IntBuffer sizes,
               int type,
               Pointer data,
               SizeTPointer steps)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               IntBuffer sizes,
               int type,
               Pointer data)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               int[] sizes,
               int type,
               Pointer data,
               SizeTPointer steps)

opencv_core.Mat

public opencv_core.Mat(int ndims,
               int[] sizes,
               int type,
               Pointer data)

opencv_core.Mat

public opencv_core.Mat(opencv_core.Mat m,
               opencv_core.Range rowRange,
               opencv_core.Range colRange)

creates a matrix header for a part of the bigger matrix

opencv_core.Mat

public opencv_core.Mat(opencv_core.Mat m,
               opencv_core.Range rowRange)

opencv_core.Mat

public opencv_core.Mat(opencv_core.Mat m,
               opencv_core.Rect roi)

opencv_core.Mat

public opencv_core.Mat(opencv_core.CvMat m,
               boolean copyData)

converts old-style CvMat to the new matrix; the data is not copied by default

opencv_core.Mat

public opencv_core.Mat(opencv_core.CvMat m)

opencv_core.Mat

public opencv_core.Mat(opencv_core.CvMatND m,
               boolean copyData)

converts old-style CvMatND to the new matrix; the data is not copied by default

opencv_core.Mat

public opencv_core.Mat(opencv_core.CvMatND m)

opencv_core.Mat

public opencv_core.Mat(opencv_core.IplImage img,
               boolean copyData)

converts old-style IplImage to the new matrix; the data is not copied by default

opencv_core.Mat

public opencv_core.Mat(opencv_core.IplImage img)

opencv_core.Mat

public opencv_core.Mat(opencv_core.GpuMat m)

download data from GpuMat

Method Detail

position

public opencv_core.Mat position(int position)

Overrides:

position in class Pointer

put

public opencv_core.Mat put(opencv_core.Mat m)

assignment operators

put

public opencv_core.Mat put(opencv_core.MatExpr expr)

row

public opencv_core.Mat row(int y)

returns a new matrix header for the specified row

col

public opencv_core.Mat col(int x)

returns a new matrix header for the specified column

rowRange

public opencv_core.Mat rowRange(int startrow,
                       int endrow)

... for the specified row span

rowRange

public opencv_core.Mat rowRange(opencv_core.Range r)

colRange

public opencv_core.Mat colRange(int startcol,
                       int endcol)

... for the specified column span

colRange

public opencv_core.Mat colRange(opencv_core.Range r)

diag

public opencv_core.Mat diag(int d)

... for the specified diagonal // (d=0 - the main diagonal, // >0 - a diagonal from the lower half, // <0 - a diagonal from the upper half)

diag

public opencv_core.Mat diag()

diag

public static opencv_core.Mat diag(opencv_core.Mat d)

constructs a square diagonal matrix which main diagonal is vector "d"

clone

public opencv_core.Mat clone()

returns deep copy of the matrix, i.e. the data is copied

Overrides:

clone in class Object

copyTo

public void copyTo(opencv_core.Mat m)

copies the matrix content to "m". // It calls m.create(this->size(), this->type()).

copyTo

public void copyTo(opencv_core.Mat m,
          opencv_core.Mat mask)

copies those matrix elements to "m" that are marked with non-zero mask elements.

convertTo

public void convertTo(opencv_core.Mat m,
             int rtype,
             double alpha,
             double beta)

converts matrix to another datatype with optional scalng. See cvConvertScale.

convertTo

public void convertTo(opencv_core.Mat m,
             int rtype)

assignTo

public void assignTo(opencv_core.Mat m,
            int type)

assignTo

public void assignTo(opencv_core.Mat m)

put

public opencv_core.Mat put(opencv_core.Scalar s)

sets every matrix element to s

setTo

public opencv_core.Mat setTo(opencv_core.Mat value,
                    opencv_core.Mat mask)

sets some of the matrix elements to s, according to the mask

setTo

public opencv_core.Mat setTo(opencv_core.Mat value)

reshape

public opencv_core.Mat reshape(int cn,
                      int rows)

creates alternative matrix header for the same data, with different // number of channels and/or different number of rows. see cvReshape.

reshape

public opencv_core.Mat reshape(int cn)

reshape

public opencv_core.Mat reshape(int cn,
                      int newndims,
                      IntPointer newsz)

reshape

public opencv_core.Mat reshape(int cn,
                      int newndims,
                      IntBuffer newsz)

reshape

public opencv_core.Mat reshape(int cn,
                      int newndims,
                      int[] newsz)

t

public opencv_core.MatExpr t()

matrix transposition by means of matrix expressions

inv

public opencv_core.MatExpr inv(int method)

matrix inversion by means of matrix expressions

inv

public opencv_core.MatExpr inv()

mul

public opencv_core.MatExpr mul(opencv_core.Mat m,
                      double scale)

per-element matrix multiplication by means of matrix expressions

mul

public opencv_core.MatExpr mul(opencv_core.Mat m)

cross

public opencv_core.Mat cross(opencv_core.Mat m)

computes cross-product of 2 3D vectors

dot

public double dot(opencv_core.Mat m)

computes dot-product

zeros

public static opencv_core.MatExpr zeros(int rows,
                        int cols,
                        int type)

Matlab-style matrix initialization

zeros

public static opencv_core.MatExpr zeros(opencv_core.Size size,
                        int type)

ones

public static opencv_core.MatExpr ones(int rows,
                       int cols,
                       int type)

ones

public static opencv_core.MatExpr ones(opencv_core.Size size,
                       int type)

eye

public static opencv_core.MatExpr eye(int rows,
                      int cols,
                      int type)

eye

public static opencv_core.MatExpr eye(opencv_core.Size size,
                      int type)

create

public void create(int rows,
          int cols,
          int type)

allocates new matrix data unless the matrix already has specified size and type. // previous data is unreferenced if needed.

Specified by:

create in class opencv_core.AbstractMat

create

public void create(opencv_core.Size size,
          int type)

create

public void create(int ndims,
          IntPointer sizes,
          int type)

create

public void create(int ndims,
          IntBuffer sizes,
          int type)

create

public void create(int ndims,
          int[] sizes,
          int type)

addref

public void addref()

increases the reference counter; use with care to avoid memleaks

release

public void release()

decreases reference counter; // deallocates the data when reference counter reaches 0.

Specified by:

release in class opencv_core.AbstractMat

_deallocate

public void _deallocate()

deallocates the matrix data

copySize

public void copySize(opencv_core.Mat m)

internal use function; properly re-allocates _size, _step arrays

reserve

public void reserve(long sz)

reserves enough space to fit sz hyper-planes

resize

public void resize(long sz)

resizes matrix to the specified number of hyper-planes

resize

public void resize(long sz,
          opencv_core.Scalar s)

resizes matrix to the specified number of hyper-planes; initializes the newly added elements

push_back_

public void push_back_(Pointer elem)

internal function

push_back

public void push_back(opencv_core.Mat m)

adds element to the end of 1d matrix (or possibly multiple elements when _Tp=Mat)

pop_back

public void pop_back(long nelems)

removes several hyper-planes from bottom of the matrix

pop_back

public void pop_back()

locateROI

public void locateROI(opencv_core.Size wholeSize,
             opencv_core.Point ofs)

locates matrix header within a parent matrix. See below

adjustROI

public opencv_core.Mat adjustROI(int dtop,
                        int dbottom,
                        int dleft,
                        int dright)

moves/resizes the current matrix ROI inside the parent matrix.

apply

public opencv_core.Mat apply(opencv_core.Range rowRange,
                    opencv_core.Range colRange)

extracts a rectangular sub-matrix // (this is a generalized form of row, rowRange etc.)

apply

public opencv_core.Mat apply(opencv_core.Rect roi)

apply

public opencv_core.Mat apply(opencv_core.Range ranges)

asCvMat

public opencv_core.CvMat asCvMat()

converts header to CvMat; no data is copied

asCvMatND

public opencv_core.CvMatND asCvMatND()

converts header to CvMatND; no data is copied

asIplImage

public opencv_core.IplImage asIplImage()

converts header to IplImage; no data is copied

isContinuous

public boolean isContinuous()

returns true iff the matrix data is continuous // (i.e. when there are no gaps between successive rows). // similar to CV_IS_MAT_CONT(cvmat->type)

isSubmatrix

public boolean isSubmatrix()

returns true if the matrix is a submatrix of another matrix

elemSize

public long elemSize()

returns element size in bytes, // similar to CV_ELEM_SIZE(cvmat->type)

elemSize1

public long elemSize1()

returns the size of element channel in bytes.

type

public int type()

returns element type, similar to CV_MAT_TYPE(cvmat->type)

Specified by:

type in class opencv_core.AbstractMat

depth

public int depth()

returns element type, similar to CV_MAT_DEPTH(cvmat->type)

Specified by:

depth in class opencv_core.AbstractMat

channels

public int channels()

returns element type, similar to CV_MAT_CN(cvmat->type)

Specified by:

channels in class opencv_core.AbstractMat

step1

public long step1(int i)

returns step/elemSize1()

step1

public long step1()

empty

public boolean empty()

returns true if matrix data is NULL

total

public long total()

returns the total number of matrix elements

checkVector

public int checkVector(int elemChannels,
              int depth,
              boolean requireContinuous)

returns N if the matrix is 1-channel (N x ptdim) or ptdim-channel (1 x N) or (N x 1); negative number otherwise

checkVector

public int checkVector(int elemChannels)

ptr

public BytePointer ptr(int i0)

returns pointer to i0-th submatrix along the dimension #0

ptr

public BytePointer ptr()

ptr

public BytePointer ptr(int i0,
              int i1)

returns pointer to (i0,i1) submatrix along the dimensions #0 and #1

ptr

public BytePointer ptr(int i0,
              int i1,
              int i2)

returns pointer to (i0,i1,i3) submatrix along the dimensions #0, #1, #2

ptr

public BytePointer ptr(IntPointer idx)

returns pointer to the matrix element

ptr

public ByteBuffer ptr(IntBuffer idx)

ptr

public byte[] ptr(int[] idx)

flags

public int flags()

includes several bit-fields: - the magic signature - continuity flag - depth - number of channels

flags

public opencv_core.Mat flags(int flags)

dims

public int dims()

the matrix dimensionality, >= 2

dims

public opencv_core.Mat dims(int dims)

rows

public int rows()

the number of rows and columns or (-1, -1) when the matrix has more than 2 dimensions

Specified by:

rows in class opencv_core.AbstractMat

rows

public opencv_core.Mat rows(int rows)

cols

public int cols()

Specified by:

cols in class opencv_core.AbstractMat

cols

public opencv_core.Mat cols(int cols)

data

public BytePointer data()

pointer to the data

Specified by:

data in class opencv_core.AbstractMat

data

public opencv_core.Mat data(BytePointer data)

refcount

public IntPointer refcount()

pointer to the reference counter; // when matrix points to user-allocated data, the pointer is NULL

refcount

public opencv_core.Mat refcount(IntPointer refcount)

datastart

public BytePointer datastart()

helper fields used in locateROI and adjustROI

datastart

public opencv_core.Mat datastart(BytePointer datastart)

dataend

public BytePointer dataend()

dataend

public opencv_core.Mat dataend(BytePointer dataend)

datalimit

public BytePointer datalimit()

datalimit

public opencv_core.Mat datalimit(BytePointer datalimit)

allocator

public opencv_core.MatAllocator allocator()

custom allocator

allocator

public opencv_core.Mat allocator(opencv_core.MatAllocator allocator)

size

public opencv_core.Size size()

size

public int size(int i)

Specified by:

size in class opencv_core.AbstractMat

step

public long step()

step

public int step(int i)

Specified by:

step in class opencv_core.AbstractMat