OpenCV  3.3.1-dev
Open Source Computer Vision
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
cv::Mat Class Reference

n-dimensional dense array class More...

#include "mat.hpp"

Inheritance diagram for cv::Mat:
cv::Mat_< _Tp > cv::Mat_< double > cv::Mat_< float > cv::Mat_< uchar > cv::Mat_< unsigned char >

Public Types

enum  {
  MAGIC_VAL = 0x42FF0000,
  AUTO_STEP = 0,
  CONTINUOUS_FLAG = CV_MAT_CONT_FLAG,
  SUBMATRIX_FLAG = CV_SUBMAT_FLAG
}
 
enum  {
  MAGIC_MASK = 0xFFFF0000,
  TYPE_MASK = 0x00000FFF,
  DEPTH_MASK = 7
}
 

Public Member Functions

 Mat ()
 
 Mat (int rows, int cols, int type)
 
 Mat (Size size, int type)
 
 Mat (int rows, int cols, int type, const Scalar &s)
 
 Mat (Size size, int type, const Scalar &s)
 
 Mat (int ndims, const int *sizes, int type)
 
 Mat (const std::vector< int > &sizes, int type)
 
 Mat (int ndims, const int *sizes, int type, const Scalar &s)
 
 Mat (const std::vector< int > &sizes, int type, const Scalar &s)
 
 Mat (const Mat &m)
 
 Mat (int rows, int cols, int type, void *data, size_t step=AUTO_STEP)
 
 Mat (Size size, int type, void *data, size_t step=AUTO_STEP)
 
 Mat (int ndims, const int *sizes, int type, void *data, const size_t *steps=0)
 
 Mat (const std::vector< int > &sizes, int type, void *data, const size_t *steps=0)
 
 Mat (const Mat &m, const Range &rowRange, const Range &colRange=Range::all())
 
 Mat (const Mat &m, const Rect &roi)
 
 Mat (const Mat &m, const Range *ranges)
 
 Mat (const Mat &m, const std::vector< Range > &ranges)
 
template<typename _Tp >
 Mat (const std::vector< _Tp > &vec, bool copyData=false)
 
template<typename _Tp , int n>
 Mat (const Vec< _Tp, n > &vec, bool copyData=true)
 
template<typename _Tp , int m, int n>
 Mat (const Matx< _Tp, m, n > &mtx, bool copyData=true)
 
template<typename _Tp >
 Mat (const Point_< _Tp > &pt, bool copyData=true)
 
template<typename _Tp >
 Mat (const Point3_< _Tp > &pt, bool copyData=true)
 
template<typename _Tp >
 Mat (const MatCommaInitializer_< _Tp > &commaInitializer)
 
 Mat (const cuda::GpuMat &m)
 download data from GpuMat More...
 
 ~Mat ()
 destructor - calls release() More...
 
void addref ()
 Increments the reference counter. More...
 
MatadjustROI (int dtop, int dbottom, int dleft, int dright)
 Adjusts a submatrix size and position within the parent matrix. More...
 
void assignTo (Mat &m, int type=-1) const
 Provides a functional form of convertTo. More...
 
template<typename _Tp >
_Tp & at (int i0=0)
 Returns a reference to the specified array element. More...
 
template<typename _Tp >
const _Tp & at (int i0=0) const
 
template<typename _Tp >
_Tp & at (int row, int col)
 
template<typename _Tp >
const _Tp & at (int row, int col) const
 
template<typename _Tp >
_Tp & at (int i0, int i1, int i2)
 
template<typename _Tp >
const _Tp & at (int i0, int i1, int i2) const
 
template<typename _Tp >
_Tp & at (const int *idx)
 
template<typename _Tp >
const _Tp & at (const int *idx) const
 
template<typename _Tp , int n>
_Tp & at (const Vec< int, n > &idx)
 
template<typename _Tp , int n>
const _Tp & at (const Vec< int, n > &idx) const
 
template<typename _Tp >
_Tp & at (Point pt)
 
template<typename _Tp >
const _Tp & at (Point pt) const
 
template<typename _Tp >
MatIterator_< _Tp > begin ()
 Returns the matrix iterator and sets it to the first matrix element. More...
 
template<typename _Tp >
MatConstIterator_< _Tp > begin () const
 
int channels () const
 Returns the number of matrix channels. More...
 
int checkVector (int elemChannels, int depth=-1, bool requireContinuous=true) const
 returns N if the matrix is 1-channel (N x ptdim) or ptdim-channel (1 x N) or (N x 1); negative number otherwise More...
 
Mat clone () const
 Creates a full copy of the array and the underlying data. More...
 
Mat col (int x) const
 Creates a matrix header for the specified matrix column. More...
 
Mat colRange (int startcol, int endcol) const
 Creates a matrix header for the specified column span. More...
 
Mat colRange (const Range &r) const
 
void convertTo (OutputArray m, int rtype, double alpha=1, double beta=0) const
 Converts an array to another data type with optional scaling. More...
 
void copySize (const Mat &m)
 internal use function; properly re-allocates _size, _step arrays More...
 
void copyTo (OutputArray m) const
 Copies the matrix to another one. More...
 
void copyTo (OutputArray m, InputArray mask) const
 
void create (int rows, int cols, int type)
 Allocates new array data if needed. More...
 
void create (Size size, int type)
 
void create (int ndims, const int *sizes, int type)
 
void create (const std::vector< int > &sizes, int type)
 
Mat cross (InputArray m) const
 Computes a cross-product of two 3-element vectors. More...
 
void deallocate ()
 internal use function, consider to use 'release' method instead; deallocates the matrix data More...
 
int depth () const
 Returns the depth of a matrix element. More...
 
Mat diag (int d=0) const
 Extracts a diagonal from a matrix. More...
 
double dot (InputArray m) const
 Computes a dot-product of two vectors. More...
 
size_t elemSize () const
 Returns the matrix element size in bytes. More...
 
size_t elemSize1 () const
 Returns the size of each matrix element channel in bytes. More...
 
bool empty () const
 Returns true if the array has no elements. More...
 
template<typename _Tp >
MatIterator_< _Tp > end ()
 Returns the matrix iterator and sets it to the after-last matrix element. More...
 
template<typename _Tp >
MatConstIterator_< _Tp > end () const
 
template<typename _Tp , typename Functor >
void forEach (const Functor &operation)
 Runs the given functor over all matrix elements in parallel. More...
 
template<typename _Tp , typename Functor >
void forEach (const Functor &operation) const
 
UMat getUMat (int accessFlags, UMatUsageFlags usageFlags=USAGE_DEFAULT) const
 retrieve UMat from Mat More...
 
MatExpr inv (int method=DECOMP_LU) const
 Inverses a matrix. More...
 
bool isContinuous () const
 Reports whether the matrix is continuous or not. More...
 
bool isSubmatrix () const
 returns true if the matrix is a submatrix of another matrix More...
 
void locateROI (Size &wholeSize, Point &ofs) const
 Locates the matrix header within a parent matrix. More...
 
MatExpr mul (InputArray m, double scale=1) const
 Performs an element-wise multiplication or division of the two matrices. More...
 
template<typename _Tp , int m, int n>
 operator Matx< _Tp, m, n > () const
 
template<typename _Tp >
 operator std::vector< _Tp > () const
 
template<typename _Tp , int n>
 operator Vec< _Tp, n > () const
 
Mat operator() (Range rowRange, Range colRange) const
 Extracts a rectangular submatrix. More...
 
Mat operator() (const Rect &roi) const
 
Mat operator() (const Range *ranges) const
 
Mat operator() (const std::vector< Range > &ranges) const
 
Matoperator= (const Mat &m)
 assignment operators More...
 
Matoperator= (const MatExpr &expr)
 
Matoperator= (const Scalar &s)
 Sets all or some of the array elements to the specified value. More...
 
void pop_back (size_t nelems=1)
 Removes elements from the bottom of the matrix. More...
 
ucharptr (int i0=0)
 Returns a pointer to the specified matrix row. More...
 
const ucharptr (int i0=0) const
 
ucharptr (int row, int col)
 
const ucharptr (int row, int col) const
 
ucharptr (int i0, int i1, int i2)
 
const ucharptr (int i0, int i1, int i2) const
 
ucharptr (const int *idx)
 
const ucharptr (const int *idx) const
 
template<int n>
ucharptr (const Vec< int, n > &idx)
 
template<int n>
const ucharptr (const Vec< int, n > &idx) const
 
template<typename _Tp >
_Tp * ptr (int i0=0)
 
template<typename _Tp >
const _Tp * ptr (int i0=0) const
 
template<typename _Tp >
_Tp * ptr (int row, int col)
 
template<typename _Tp >
const _Tp * ptr (int row, int col) const
 
template<typename _Tp >
_Tp * ptr (int i0, int i1, int i2)
 
template<typename _Tp >
const _Tp * ptr (int i0, int i1, int i2) const
 
template<typename _Tp >
_Tp * ptr (const int *idx)
 
template<typename _Tp >
const _Tp * ptr (const int *idx) const
 
template<typename _Tp , int n>
_Tp * ptr (const Vec< int, n > &idx)
 
template<typename _Tp , int n>
const _Tp * ptr (const Vec< int, n > &idx) const
 
template<typename _Tp >
void push_back (const _Tp &elem)
 Adds elements to the bottom of the matrix. More...
 
template<typename _Tp >
void push_back (const Mat_< _Tp > &elem)
 
template<typename _Tp >
void push_back (const std::vector< _Tp > &elem)
 
void push_back (const Mat &m)
 
void push_back_ (const void *elem)
 internal function More...
 
void release ()
 Decrements the reference counter and deallocates the matrix if needed. More...
 
void reserve (size_t sz)
 Reserves space for the certain number of rows. More...
 
void reserveBuffer (size_t sz)
 Reserves space for the certain number of bytes. More...
 
Mat reshape (int cn, int rows=0) const
 Changes the shape and/or the number of channels of a 2D matrix without copying the data. More...
 
Mat reshape (int cn, int newndims, const int *newsz) const
 
Mat reshape (int cn, const std::vector< int > &newshape) const
 
void resize (size_t sz)
 Changes the number of matrix rows. More...
 
void resize (size_t sz, const Scalar &s)
 
Mat row (int y) const
 Creates a matrix header for the specified matrix row. More...
 
Mat rowRange (int startrow, int endrow) const
 Creates a matrix header for the specified row span. More...
 
Mat rowRange (const Range &r) const
 
MatsetTo (InputArray value, InputArray mask=noArray())
 Sets all or some of the array elements to the specified value. More...
 
size_t step1 (int i=0) const
 Returns a normalized step. More...
 
MatExpr t () const
 Transposes a matrix. More...
 
size_t total () const
 Returns the total number of array elements. More...
 
size_t total (int startDim, int endDim=INT_MAX) const
 Returns the total number of array elements. More...
 
int type () const
 Returns the type of a matrix element. More...
 

Static Public Member Functions

static Mat diag (const Mat &d)
 creates a diagonal matrix More...
 
static MatExpr eye (int rows, int cols, int type)
 Returns an identity matrix of the specified size and type. More...
 
static MatExpr eye (Size size, int type)
 
static MatAllocatorgetDefaultAllocator ()
 
static MatAllocatorgetStdAllocator ()
 and the standard allocator More...
 
static MatExpr ones (int rows, int cols, int type)
 Returns an array of all 1's of the specified size and type. More...
 
static MatExpr ones (Size size, int type)
 
static MatExpr ones (int ndims, const int *sz, int type)
 
static void setDefaultAllocator (MatAllocator *allocator)
 
static MatExpr zeros (int rows, int cols, int type)
 Returns a zero array of the specified size and type. More...
 
static MatExpr zeros (Size size, int type)
 
static MatExpr zeros (int ndims, const int *sz, int type)
 

Public Attributes

MatAllocatorallocator
 custom allocator More...
 
int cols
 
uchardata
 pointer to the data More...
 
const uchardataend
 
const uchardatalimit
 
const uchardatastart
 helper fields used in locateROI and adjustROI More...
 
int dims
 the matrix dimensionality, >= 2 More...
 
int flags
 
int rows
 the number of rows and columns or (-1, -1) when the matrix has more than 2 dimensions More...
 
MatSize size
 
MatStep step
 
UMatDatau
 interaction with UMat More...
 

Protected Member Functions

template<typename _Tp , typename Functor >
void forEach_impl (const Functor &operation)
 

Detailed Description

n-dimensional dense array class

The class Mat represents an n-dimensional dense numerical single-channel or multi-channel array. It can be used to store real or complex-valued vectors and matrices, grayscale or color images, voxel volumes, vector fields, point clouds, tensors, histograms (though, very high-dimensional histograms may be better stored in a SparseMat ). The data layout of the array M is defined by the array M.step[], so that the address of element \((i_0,...,i_{M.dims-1})\), where \(0\leq i_k<M.size[k]\), is computed as:

\[addr(M_{i_0,...,i_{M.dims-1}}) = M.data + M.step[0]*i_0 + M.step[1]*i_1 + ... + M.step[M.dims-1]*i_{M.dims-1}\]

In case of a 2-dimensional array, the above formula is reduced to:

\[addr(M_{i,j}) = M.data + M.step[0]*i + M.step[1]*j\]

Note that M.step[i] >= M.step[i+1] (in fact, M.step[i] >= M.step[i+1]*M.size[i+1] ). This means that 2-dimensional matrices are stored row-by-row, 3-dimensional matrices are stored plane-by-plane, and so on. M.step[M.dims-1] is minimal and always equal to the element size M.elemSize() .

So, the data layout in Mat is fully compatible with CvMat, IplImage, and CvMatND types from OpenCV 1.x. It is also compatible with the majority of dense array types from the standard toolkits and SDKs, such as Numpy (ndarray), Win32 (independent device bitmaps), and others, that is, with any array that uses steps (or strides) to compute the position of a pixel. Due to this compatibility, it is possible to make a Mat header for user-allocated data and process it in-place using OpenCV functions.

There are many different ways to create a Mat object. The most popular options are listed below:

Once the array is created, it is automatically managed via a reference-counting mechanism. If the array header is built on top of user-allocated data, you should handle the data by yourself. The array data is deallocated when no one points to it. If you want to release the data pointed by a array header before the array destructor is called, use Mat::release().

The next important thing to learn about the array class is element access. This manual already described how to compute an address of each array element. Normally, you are not required to use the formula directly in the code. If you know the array element type (which can be retrieved using the method Mat::type() ), you can access the element \(M_{ij}\) of a 2-dimensional array as:

M.at<double>(i,j) += 1.f;

assuming that M is a double-precision floating-point array. There are several variants of the method at for a different number of dimensions.

If you need to process a whole row of a 2D array, the most efficient way is to get the pointer to the row first, and then just use the plain C operator [] :

// compute sum of positive matrix elements
// (assuming that M is a double-precision matrix)
double sum=0;
for(int i = 0; i < M.rows; i++)
{
const double* Mi = M.ptr<double>(i);
for(int j = 0; j < M.cols; j++)
sum += std::max(Mi[j], 0.);
}

Some operations, like the one above, do not actually depend on the array shape. They just process elements of an array one by one (or elements from multiple arrays that have the same coordinates, for example, array addition). Such operations are called element-wise. It makes sense to check whether all the input/output arrays are continuous, namely, have no gaps at the end of each row. If yes, process them as a long single row:

// compute the 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<double>(i);
for(int j = 0; j < cols; j++)
sum += std::max(Mi[j], 0.);
}

In case of the continuous matrix, the outer loop body is executed just once. So, the overhead is smaller, which is especially noticeable in case of small matrices.

Finally, there are STL-style iterators that are smart enough to skip gaps between successive rows:

// compute sum of positive matrix elements, iterator-based variant
double sum=0;
MatConstIterator_<double> it = M.begin<double>(), it_end = M.end<double>();
for(; it != it_end; ++it)
sum += std::max(*it, 0.);

The matrix iterators are random-access iterators, so they can be passed to any STL algorithm, including std::sort().

Note
Matrix Expressions and arithmetic see MatExpr
Examples:
AddingImagesTrackbar.cpp, camshiftdemo.cpp, cloning_demo.cpp, contours2.cpp, convexhull.cpp, copyMakeBorder_demo.cpp, cout_mat.cpp, demhist.cpp, distrans.cpp, Drawing_1.cpp, Drawing_2.cpp, edge.cpp, facedetect.cpp, falsecolor.cpp, ffilldemo.cpp, filestorage.cpp, fitellipse.cpp, fld_lines.cpp, grabcut.cpp, hog.cpp, houghcircles.cpp, houghlines.cpp, image_alignment.cpp, kalman.cpp, kmeans.cpp, laplace.cpp, lkdemo.cpp, lsd_lines.cpp, MatchTemplate_Demo.cpp, minarea.cpp, morphology2.cpp, Morphology_1.cpp, npr_demo.cpp, pca.cpp, peopledetect.cpp, polar_transforms.cpp, Pyramids.cpp, segment_objects.cpp, shape_example.cpp, Smoothing.cpp, Sobel_Demo.cpp, train_HOG.cpp, videowriter_basic.cpp, warpPerspective_demo.cpp, and watershed.cpp.

Member Enumeration Documentation

§ anonymous enum

anonymous enum
Enumerator
MAGIC_VAL 
AUTO_STEP 
CONTINUOUS_FLAG 
SUBMATRIX_FLAG 

§ anonymous enum

anonymous enum
Enumerator
MAGIC_MASK 
TYPE_MASK 
DEPTH_MASK 

Constructor & Destructor Documentation

§ Mat() [1/25]

cv::Mat::Mat ( )

These are various constructors that form a matrix. As noted in the AutomaticAllocation, often the default constructor is enough, and the proper matrix will be allocated by an OpenCV function. The constructed matrix can further be assigned to another matrix or matrix expression or can be allocated with Mat::create . In the former case, the old content is de-referenced.

§ Mat() [2/25]

cv::Mat::Mat ( int  rows,
int  cols,
int  type 
)

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

Parameters
rowsNumber of rows in a 2D array.
colsNumber of columns in a 2D array.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.

§ Mat() [3/25]

cv::Mat::Mat ( Size  size,
int  type 
)

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

Parameters
size2D array size: Size(cols, rows) . In the Size() constructor, the number of rows and the number of columns go in the reverse order.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.

§ Mat() [4/25]

cv::Mat::Mat ( int  rows,
int  cols,
int  type,
const Scalar s 
)

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

Parameters
rowsNumber of rows in a 2D array.
colsNumber of columns in a 2D array.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.
sAn optional value to initialize each matrix element with. To set all the matrix elements to the particular value after the construction, use the assignment operator Mat::operator=(const Scalar& value) .

§ Mat() [5/25]

cv::Mat::Mat ( Size  size,
int  type,
const Scalar s 
)

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

Parameters
size2D array size: Size(cols, rows) . In the Size() constructor, the number of rows and the number of columns go in the reverse order.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.
sAn optional value to initialize each matrix element with. To set all the matrix elements to the particular value after the construction, use the assignment operator Mat::operator=(const Scalar& value) .

§ Mat() [6/25]

cv::Mat::Mat ( int  ndims,
const int *  sizes,
int  type 
)

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

Parameters
ndimsArray dimensionality.
sizesArray of integers specifying an n-dimensional array shape.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.

§ Mat() [7/25]

cv::Mat::Mat ( const std::vector< int > &  sizes,
int  type 
)

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

Parameters
sizesArray of integers specifying an n-dimensional array shape.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.

§ Mat() [8/25]

cv::Mat::Mat ( int  ndims,
const int *  sizes,
int  type,
const Scalar s 
)

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

Parameters
ndimsArray dimensionality.
sizesArray of integers specifying an n-dimensional array shape.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.
sAn optional value to initialize each matrix element with. To set all the matrix elements to the particular value after the construction, use the assignment operator Mat::operator=(const Scalar& value) .

§ Mat() [9/25]

cv::Mat::Mat ( const std::vector< int > &  sizes,
int  type,
const Scalar s 
)

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

Parameters
sizesArray of integers specifying an n-dimensional array shape.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.
sAn optional value to initialize each matrix element with. To set all the matrix elements to the particular value after the construction, use the assignment operator Mat::operator=(const Scalar& value) .

§ Mat() [10/25]

cv::Mat::Mat ( const Mat m)

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

Parameters
mArray that (as a whole or partly) is assigned to the constructed matrix. No data is copied by these constructors. Instead, the header pointing to m data or its sub-array is constructed and associated with it. The reference counter, if any, is incremented. So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . If you want to have an independent copy of the sub-array, use Mat::clone() .

§ Mat() [11/25]

cv::Mat::Mat ( int  rows,
int  cols,
int  type,
void *  data,
size_t  step = AUTO_STEP 
)

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

Parameters
rowsNumber of rows in a 2D array.
colsNumber of columns in a 2D array.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.
dataPointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. This operation is very efficient and can be used to process external data using OpenCV functions. The external data is not automatically deallocated, so you should take care of it.
stepNumber of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any. If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize(). See Mat::elemSize.

§ Mat() [12/25]

cv::Mat::Mat ( Size  size,
int  type,
void *  data,
size_t  step = AUTO_STEP 
)

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

Parameters
size2D array size: Size(cols, rows) . In the Size() constructor, the number of rows and the number of columns go in the reverse order.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.
dataPointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. This operation is very efficient and can be used to process external data using OpenCV functions. The external data is not automatically deallocated, so you should take care of it.
stepNumber of bytes each matrix row occupies. The value should include the padding bytes at the end of each row, if any. If the parameter is missing (set to AUTO_STEP ), no padding is assumed and the actual step is calculated as cols*elemSize(). See Mat::elemSize.

§ Mat() [13/25]

cv::Mat::Mat ( int  ndims,
const int *  sizes,
int  type,
void *  data,
const size_t *  steps = 0 
)

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

Parameters
ndimsArray dimensionality.
sizesArray of integers specifying an n-dimensional array shape.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.
dataPointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. This operation is very efficient and can be used to process external data using OpenCV functions. The external data is not automatically deallocated, so you should take care of it.
stepsArray of ndims-1 steps in case of a multi-dimensional array (the last step is always set to the element size). If not specified, the matrix is assumed to be continuous.

§ Mat() [14/25]

cv::Mat::Mat ( const std::vector< int > &  sizes,
int  type,
void *  data,
const size_t *  steps = 0 
)

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

Parameters
sizesArray of integers specifying an n-dimensional array shape.
typeArray type. Use CV_8UC1, ..., CV_64FC4 to create 1-4 channel matrices, or CV_8UC(n), ..., CV_64FC(n) to create multi-channel (up to CV_CN_MAX channels) matrices.
dataPointer to the user data. Matrix constructors that take data and step parameters do not allocate matrix data. Instead, they just initialize the matrix header that points to the specified data, which means that no data is copied. This operation is very efficient and can be used to process external data using OpenCV functions. The external data is not automatically deallocated, so you should take care of it.
stepsArray of ndims-1 steps in case of a multi-dimensional array (the last step is always set to the element size). If not specified, the matrix is assumed to be continuous.

§ Mat() [15/25]

cv::Mat::Mat ( const Mat m,
const Range rowRange,
const Range colRange = Range::all() 
)

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

Parameters
mArray that (as a whole or partly) is assigned to the constructed matrix. No data is copied by these constructors. Instead, the header pointing to m data or its sub-array is constructed and associated with it. The reference counter, if any, is incremented. So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . If you want to have an independent copy of the sub-array, use Mat::clone() .
rowRangeRange of the m rows to take. As usual, the range start is inclusive and the range end is exclusive. Use Range::all() to take all the rows.
colRangeRange of the m columns to take. Use Range::all() to take all the columns.

§ Mat() [16/25]

cv::Mat::Mat ( const Mat m,
const Rect roi 
)

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

Parameters
mArray that (as a whole or partly) is assigned to the constructed matrix. No data is copied by these constructors. Instead, the header pointing to m data or its sub-array is constructed and associated with it. The reference counter, if any, is incremented. So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . If you want to have an independent copy of the sub-array, use Mat::clone() .
roiRegion of interest.

§ Mat() [17/25]

cv::Mat::Mat ( const Mat m,
const Range ranges 
)

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

Parameters
mArray that (as a whole or partly) is assigned to the constructed matrix. No data is copied by these constructors. Instead, the header pointing to m data or its sub-array is constructed and associated with it. The reference counter, if any, is incremented. So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . If you want to have an independent copy of the sub-array, use Mat::clone() .
rangesArray of selected ranges of m along each dimensionality.

§ Mat() [18/25]

cv::Mat::Mat ( const Mat m,
const std::vector< Range > &  ranges 
)

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

Parameters
mArray that (as a whole or partly) is assigned to the constructed matrix. No data is copied by these constructors. Instead, the header pointing to m data or its sub-array is constructed and associated with it. The reference counter, if any, is incremented. So, when you modify the matrix formed using such a constructor, you also modify the corresponding elements of m . If you want to have an independent copy of the sub-array, use Mat::clone() .
rangesArray of selected ranges of m along each dimensionality.

§ Mat() [19/25]

template<typename _Tp >
cv::Mat::Mat ( const std::vector< _Tp > &  vec,
bool  copyData = false 
)
explicit

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

Parameters
vecSTL vector whose elements form the matrix. The matrix has a single column and the number of rows equal to the number of vector elements. Type of the matrix matches the type of vector elements. The constructor can handle arbitrary types, for which there is a properly declared DataType . This means that the vector elements must be primitive numbers or uni-type numerical tuples of numbers. Mixed-type structures are not supported. The corresponding constructor is explicit. Since STL vectors are not automatically converted to Mat instances, you should write Mat(vec) explicitly. Unless you copy the data into the matrix ( copyData=true ), no new elements will be added to the vector because it can potentially yield vector data reallocation, and, thus, the matrix data pointer will be invalid.
copyDataFlag to specify whether the underlying data of the STL vector should be copied to (true) or shared with (false) the newly constructed matrix. When the data is copied, the allocated buffer is managed using Mat reference counting mechanism. While the data is shared, the reference counter is NULL, and you should not deallocate the data until the matrix is not destructed.

§ Mat() [20/25]

template<typename _Tp , int n>
cv::Mat::Mat ( const Vec< _Tp, n > &  vec,
bool  copyData = true 
)
explicit

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

§ Mat() [21/25]

template<typename _Tp , int m, int n>
cv::Mat::Mat ( const Matx< _Tp, m, n > &  mtx,
bool  copyData = true 
)
explicit

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

§ Mat() [22/25]

template<typename _Tp >
cv::Mat::Mat ( const Point_< _Tp > &  pt,
bool  copyData = true 
)
explicit

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

§ Mat() [23/25]

template<typename _Tp >
cv::Mat::Mat ( const Point3_< _Tp > &  pt,
bool  copyData = true 
)
explicit

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

§ Mat() [24/25]

template<typename _Tp >
cv::Mat::Mat ( const MatCommaInitializer_< _Tp > &  commaInitializer)
explicit

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

§ Mat() [25/25]

cv::Mat::Mat ( const cuda::GpuMat m)
explicit

download data from GpuMat

§ ~Mat()

cv::Mat::~Mat ( )

destructor - calls release()

Member Function Documentation

§ addref()

void cv::Mat::addref ( )

Increments the reference counter.

The method increments the reference counter associated with the matrix data. If the matrix header points to an external data set (see Mat::Mat ), the reference counter is NULL, and the method has no effect in this case. Normally, to avoid memory leaks, the method should not be called explicitly. It is called implicitly by the matrix assignment operator. The reference counter increment is an atomic operation on the platforms that support it. Thus, it is safe to operate on the same matrices asynchronously in different threads.

§ adjustROI()

Mat& cv::Mat::adjustROI ( int  dtop,
int  dbottom,
int  dleft,
int  dright 
)

Adjusts a submatrix size and position within the parent matrix.

The method is complimentary to Mat::locateROI . The typical use of these functions is to determine the submatrix position within the parent matrix and then shift the position somehow. Typically, it can be required for filtering operations when pixels outside of the ROI should be taken into account. When all the method parameters are positive, the ROI needs to grow in all directions by the specified amount, for example:

A.adjustROI(2, 2, 2, 2);

In this example, the matrix size is increased by 4 elements in each direction. The matrix is shifted by 2 elements to the left and 2 elements up, which brings in all the necessary pixels for the filtering with the 5x5 kernel.

adjustROI forces the adjusted ROI to be inside of the parent matrix that is boundaries of the adjusted ROI are constrained by boundaries of the parent matrix. For example, if the submatrix A is located in the first row of a parent matrix and you called A.adjustROI(2, 2, 2, 2) then A will not be increased in the upward direction.

The function is used internally by the OpenCV filtering functions, like filter2D , morphological operations, and so on.

Parameters
dtopShift of the top submatrix boundary upwards.
dbottomShift of the bottom submatrix boundary downwards.
dleftShift of the left submatrix boundary to the left.
drightShift of the right submatrix boundary to the right.
See also
copyMakeBorder

§ assignTo()

void cv::Mat::assignTo ( Mat m,
int  type = -1 
) const

Provides a functional form of convertTo.

This is an internally used method called by the MatrixExpressions engine.

Parameters
mDestination array.
typeDesired destination array depth (or -1 if it should be the same as the source type).

§ at() [1/12]

template<typename _Tp >
_Tp& cv::Mat::at ( int  i0 = 0)

Returns a reference to the specified array element.

The template methods return a reference to the specified array element. For the sake of higher performance, the index range checks are only performed in the Debug configuration.

Note that the variants with a single index (i) can be used to access elements of single-row or single-column 2-dimensional arrays. That is, if, for example, A is a 1 x N floating-point matrix and B is an M x 1 integer matrix, you can simply write A.at<float>(k+4) and B.at<int>(2*i+1) instead of A.at<float>(0,k+4) and B.at<int>(2*i+1,0), respectively.

The example below initializes a Hilbert matrix:

Mat H(100, 100, CV_64F);
for(int i = 0; i < H.rows; i++)
for(int j = 0; j < H.cols; j++)
H.at<double>(i,j)=1./(i+j+1);

Keep in mind that the size identifier used in the at operator cannot be chosen at random. It depends on the image from which you are trying to retrieve the data. The table below gives a better insight in this:

  • If matrix is of type CV_8U then use Mat.at<uchar>(y,x).
  • If matrix is of type CV_8S then use Mat.at<schar>(y,x).
  • If matrix is of type CV_16U then use Mat.at<ushort>(y,x).
  • If matrix is of type CV_16S then use Mat.at<short>(y,x).
  • If matrix is of type CV_32S then use Mat.at<int>(y,x).
  • If matrix is of type CV_32F then use Mat.at<float>(y,x).
  • If matrix is of type CV_64F then use Mat.at<double>(y,x).
Parameters
i0Index along the dimension 0
Examples:
camshiftdemo.cpp, cout_mat.cpp, demhist.cpp, fitellipse.cpp, image_alignment.cpp, kalman.cpp, kmeans.cpp, and train_HOG.cpp.

§ at() [2/12]

template<typename _Tp >
const _Tp& cv::Mat::at ( int  i0 = 0) const

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

Parameters
i0Index along the dimension 0

§ at() [3/12]

template<typename _Tp >
_Tp& cv::Mat::at ( int  row,
int  col 
)

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

Parameters
rowIndex along the dimension 0
colIndex along the dimension 1

§ at() [4/12]

template<typename _Tp >
const _Tp& cv::Mat::at ( int  row,
int  col 
) const

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

Parameters
rowIndex along the dimension 0
colIndex along the dimension 1

§ at() [5/12]

template<typename _Tp >
_Tp& cv::Mat::at ( int  i0,
int  i1,
int  i2 
)

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

Parameters
i0Index along the dimension 0
i1Index along the dimension 1
i2Index along the dimension 2

§ at() [6/12]

template<typename _Tp >
const _Tp& cv::Mat::at ( int  i0,
int  i1,
int  i2 
) const

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

Parameters
i0Index along the dimension 0
i1Index along the dimension 1
i2Index along the dimension 2

§ at() [7/12]

template<typename _Tp >
_Tp& cv::Mat::at ( const int *  idx)

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

Parameters
idxArray of Mat::dims indices.

§ at() [8/12]

template<typename _Tp >
const _Tp& cv::Mat::at ( const int *  idx) const

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

Parameters
idxArray of Mat::dims indices.

§ at() [9/12]

template<typename _Tp , int n>
_Tp& cv::Mat::at ( const Vec< int, n > &  idx)

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

§ at() [10/12]

template<typename _Tp , int n>
const _Tp& cv::Mat::at ( const Vec< int, n > &  idx) const

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

§ at() [11/12]

template<typename _Tp >
_Tp& cv::Mat::at ( Point  pt)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. special versions for 2D arrays (especially convenient for referencing image pixels)

Parameters
ptElement position specified as Point(j,i) .

§ at() [12/12]

template<typename _Tp >
const _Tp& cv::Mat::at ( Point  pt) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. special versions for 2D arrays (especially convenient for referencing image pixels)

Parameters
ptElement position specified as Point(j,i) .

§ begin() [1/2]

template<typename _Tp >
MatIterator_<_Tp> cv::Mat::begin ( )

Returns the matrix iterator and sets it to the first matrix element.

The methods return the matrix read-only or read-write iterators. The use of matrix iterators is very similar to the use of bi-directional STL iterators. In the example below, the alpha blending function is rewritten using the matrix iterators:

template<typename T>
void alphaBlendRGBA(const Mat& src1, const Mat& src2, Mat& dst)
{
typedef Vec<T, 4> VT;
const float alpha_scale = (float)std::numeric_limits<T>::max(),
inv_scale = 1.f/alpha_scale;
CV_Assert( src1.type() == src2.type() &&
src1.type() == traits::Type<VT>::value &&
src1.size() == src2.size());
Size size = src1.size();
dst.create(size, src1.type());
MatConstIterator_<VT> it1 = src1.begin<VT>(), it1_end = src1.end<VT>();
MatConstIterator_<VT> it2 = src2.begin<VT>();
MatIterator_<VT> dst_it = dst.begin<VT>();
for( ; it1 != it1_end; ++it1, ++it2, ++dst_it )
{
VT pix1 = *it1, pix2 = *it2;
float alpha = pix1[3]*inv_scale, beta = pix2[3]*inv_scale;
*dst_it = VT(saturate_cast<T>(pix1[0]*alpha + pix2[0]*beta),
saturate_cast<T>(pix1[1]*alpha + pix2[1]*beta),
saturate_cast<T>(pix1[2]*alpha + pix2[2]*beta),
saturate_cast<T>((1 - (1-alpha)*(1-beta))*alpha_scale));
}
}

§ begin() [2/2]

template<typename _Tp >
MatConstIterator_<_Tp> cv::Mat::begin ( ) const

§ channels()

int cv::Mat::channels ( ) const

Returns the number of matrix channels.

The method returns the number of matrix channels.

Examples:
pca.cpp.

§ checkVector()

int cv::Mat::checkVector ( int  elemChannels,
int  depth = -1,
bool  requireContinuous = true 
) const

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

§ clone()

Mat cv::Mat::clone ( ) const

Creates a full copy of the array and the underlying data.

The method creates a full copy of the array. The original step[] is not taken into account. So, the array copy is a continuous array occupying total()*elemSize() bytes.

Examples:
facedetect.cpp, houghlines.cpp, Smoothing.cpp, train_HOG.cpp, and warpPerspective_demo.cpp.

§ col()

Mat cv::Mat::col ( int  x) const

Creates a matrix header for the specified matrix column.

The method makes a new header for the specified matrix column and returns it. This is an O(1) operation, regardless of the matrix size. The underlying data of the new matrix is shared with the original matrix. See also the Mat::row description.

Parameters
xA 0-based column index.

§ colRange() [1/2]

Mat cv::Mat::colRange ( int  startcol,
int  endcol 
) const

Creates a matrix header for the specified column span.

The method makes a new header for the specified column span of the matrix. Similarly to Mat::row and Mat::col , this is an O(1) operation.

Parameters
startcolAn inclusive 0-based start index of the column span.
endcolAn exclusive 0-based ending index of the column span.

§ colRange() [2/2]

Mat cv::Mat::colRange ( const Range r) const

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

Parameters
rRange structure containing both the start and the end indices.

§ convertTo()

void cv::Mat::convertTo ( OutputArray  m,
int  rtype,
double  alpha = 1,
double  beta = 0 
) const

Converts an array to another data type with optional scaling.

The method converts source pixel values to the target data type. saturate_cast<> is applied at the end to avoid possible overflows:

\[m(x,y) = saturate \_ cast<rType>( \alpha (*this)(x,y) + \beta )\]

Parameters
moutput matrix; if it does not have a proper size or type before the operation, it is reallocated.
rtypedesired output matrix type or, rather, the depth since the number of channels are the same as the input has; if rtype is negative, the output matrix will have the same type as the input.
alphaoptional scale factor.
betaoptional delta added to the scaled values.
Examples:
demhist.cpp, distrans.cpp, fitellipse.cpp, and pca.cpp.

§ copySize()

void cv::Mat::copySize ( const Mat m)

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

§ copyTo() [1/2]

void cv::Mat::copyTo ( OutputArray  m) const

Copies the matrix to another one.

The method copies the matrix data to another matrix. Before copying the data, the method invokes :

m.create(this->size(), this->type());

so that the destination matrix is reallocated if needed. While m.copyTo(m); works flawlessly, the function does not handle the case of a partial overlap between the source and the destination matrices.

When the operation mask is specified, if the Mat::create call shown above reallocates the matrix, the newly allocated matrix is initialized with all zeros before copying the data.

Parameters
mDestination matrix. If it does not have a proper size or type before the operation, it is reallocated.
Examples:
camshiftdemo.cpp, edge.cpp, grabcut.cpp, hog.cpp, image_alignment.cpp, lkdemo.cpp, and MatchTemplate_Demo.cpp.

§ copyTo() [2/2]

void cv::Mat::copyTo ( OutputArray  m,
InputArray  mask 
) const

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

Parameters
mDestination matrix. If it does not have a proper size or type before the operation, it is reallocated.
maskOperation mask of the same size as *this. Its non-zero elements indicate which matrix elements need to be copied. The mask has to be of type CV_8U and can have 1 or multiple channels.

§ create() [1/4]

void cv::Mat::create ( int  rows,
int  cols,
int  type 
)

Allocates new array data if needed.

This is one of the key Mat methods. Most new-style OpenCV functions and methods that produce arrays call this method for each output array. The method uses the following algorithm:

  1. If the current array shape and the type match the new ones, return immediately. Otherwise, de-reference the previous data by calling Mat::release.
  2. Initialize the new header.
  3. Allocate the new data of total()*elemSize() bytes.
  4. Allocate the new, associated with the data, reference counter and set it to 1.

Such a scheme makes the memory management robust and efficient at the same time and helps avoid extra typing for you. This means that usually there is no need to explicitly allocate output arrays. That is, instead of writing:

Mat color;
...
Mat gray(color.rows, color.cols, color.depth());
cvtColor(color, gray, COLOR_BGR2GRAY);

you can simply write:

Mat color;
...
Mat gray;
cvtColor(color, gray, COLOR_BGR2GRAY);

because cvtColor, as well as the most of OpenCV functions, calls Mat::create() for the output array internally.

Parameters
rowsNew number of rows.
colsNew number of columns.
typeNew matrix type.
Examples:
camshiftdemo.cpp, edge.cpp, ffilldemo.cpp, grabcut.cpp, and MatchTemplate_Demo.cpp.

§ create() [2/4]

void cv::Mat::create ( Size  size,
int  type 
)

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

Parameters
sizeAlternative new matrix size specification: Size(cols, rows)
typeNew matrix type.

§ create() [3/4]

void cv::Mat::create ( int  ndims,
const int *  sizes,
int  type 
)

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

Parameters
ndimsNew array dimensionality.
sizesArray of integers specifying a new array shape.
typeNew matrix type.

§ create() [4/4]

void cv::Mat::create ( const std::vector< int > &  sizes,
int  type 
)

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

Parameters
sizesArray of integers specifying a new array shape.
typeNew matrix type.

§ cross()

Mat cv::Mat::cross ( InputArray  m) const

Computes a cross-product of two 3-element vectors.

The method computes a cross-product of two 3-element vectors. The vectors must be 3-element floating-point vectors of the same shape and size. The result is another 3-element vector of the same shape and type as operands.

Parameters
mAnother cross-product operand.

§ deallocate()

void cv::Mat::deallocate ( )

internal use function, consider to use 'release' method instead; deallocates the matrix data

§ depth()

int cv::Mat::depth ( ) const

Returns the depth of a matrix element.

The method returns the identifier of the matrix element depth (the type of each individual channel). For example, for a 16-bit signed element array, the method returns CV_16S . A complete list of matrix types contains the following values:

  • CV_8U - 8-bit unsigned integers ( 0..255 )
  • CV_8S - 8-bit signed integers ( -128..127 )
  • CV_16U - 16-bit unsigned integers ( 0..65535 )
  • CV_16S - 16-bit signed integers ( -32768..32767 )
  • CV_32S - 32-bit signed integers ( -2147483648..2147483647 )
  • CV_32F - 32-bit floating-point numbers ( -FLT_MAX..FLT_MAX, INF, NAN )
  • CV_64F - 64-bit floating-point numbers ( -DBL_MAX..DBL_MAX, INF, NAN )
Examples:
camshiftdemo.cpp.

§ diag() [1/2]

Mat cv::Mat::diag ( int  d = 0) const

Extracts a diagonal from a matrix.

The method makes a new header for the specified matrix diagonal. The new matrix is represented as a single-column matrix. Similarly to Mat::row and Mat::col, this is an O(1) operation.

Parameters
dindex of the diagonal, with the following values:
  • d=0 is the main diagonal.
  • d<0 is a diagonal from the lower half. For example, d=-1 means the diagonal is set immediately below the main one.
  • d>0 is a diagonal from the upper half. For example, d=1 means the diagonal is set immediately above the main one. For example:
    Mat m = (Mat_<int>(3,3) <<
    1,2,3,
    4,5,6,
    7,8,9);
    Mat d0 = m.diag(0);
    Mat d1 = m.diag(1);
    Mat d_1 = m.diag(-1);
    The resulting matrices are
    d0 =
    [1;
    5;
    9]
    d1 =
    [2;
    6]
    d_1 =
    [4;
    8]

§ diag() [2/2]

static Mat cv::Mat::diag ( const Mat d)
static

creates a diagonal matrix

The method creates a square diagonal matrix from specified main diagonal.

Parameters
dOne-dimensional matrix that represents the main diagonal.

§ dot()

double cv::Mat::dot ( InputArray  m) const

Computes a dot-product of two vectors.

The method computes a dot-product of two matrices. If the matrices are not single-column or single-row vectors, the top-to-bottom left-to-right scan ordering is used to treat them as 1D vectors. The vectors must have the same size and type. If the matrices have more than one channel, the dot products from all the channels are summed together.

Parameters
manother dot-product operand.

§ elemSize()

size_t cv::Mat::elemSize ( ) const

Returns the matrix element size in bytes.

The method returns the matrix element size in bytes. For example, if the matrix type is CV_16SC3 , the method returns 3*sizeof(short) or 6.

§ elemSize1()

size_t cv::Mat::elemSize1 ( ) const

Returns the size of each matrix element channel in bytes.

The method returns the matrix element channel size in bytes, that is, it ignores the number of channels. For example, if the matrix type is CV_16SC3 , the method returns sizeof(short) or 2.

§ empty()

bool cv::Mat::empty ( ) const

§ end() [1/2]

template<typename _Tp >
MatIterator_<_Tp> cv::Mat::end ( )

Returns the matrix iterator and sets it to the after-last matrix element.

The methods return the matrix read-only or read-write iterators, set to the point following the last matrix element.

§ end() [2/2]

template<typename _Tp >
MatConstIterator_<_Tp> cv::Mat::end ( ) const

§ eye() [1/2]

static MatExpr cv::Mat::eye ( int  rows,
int  cols,
int  type 
)
static

Returns an identity matrix of the specified size and type.

The method returns a Matlab-style identity matrix initializer, similarly to Mat::zeros. Similarly to Mat::ones, you can use a scale operation to create a scaled identity matrix efficiently:

// make a 4x4 diagonal matrix with 0.1's on the diagonal.
Mat A = Mat::eye(4, 4, CV_32F)*0.1;
Parameters
rowsNumber of rows.
colsNumber of columns.
typeCreated matrix type.
Examples:
image_alignment.cpp.

§ eye() [2/2]

static MatExpr cv::Mat::eye ( Size  size,
int  type 
)
static

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

Parameters
sizeAlternative matrix size specification as Size(cols, rows) .
typeCreated matrix type.

§ forEach() [1/2]

template<typename _Tp , typename Functor >
void cv::Mat::forEach ( const Functor &  operation)

Runs the given functor over all matrix elements in parallel.

The operation passed as argument has to be a function pointer, a function object or a lambda(C++11).

Example 1. All of the operations below put 0xFF the first channel of all matrix elements:

Mat image(1920, 1080, CV_8UC3);
typedef cv::Point3_<uint8_t> Pixel;
// first. raw pointer access.
for (int r = 0; r < image.rows; ++r) {
Pixel* ptr = image.ptr<Pixel>(r, 0);
const Pixel* ptr_end = ptr + image.cols;
for (; ptr != ptr_end; ++ptr) {
ptr->x = 255;
}
}
// Using MatIterator. (Simple but there are a Iterator's overhead)
for (Pixel &p : cv::Mat_<Pixel>(image)) {
p.x = 255;
}
// Parallel execution with function object.
struct Operator {
void operator ()(Pixel &pixel, const int * position) {
pixel.x = 255;
}
};
image.forEach<Pixel>(Operator());
// Parallel execution using C++11 lambda.
image.forEach<Pixel>([](Pixel &p, const int * position) -> void {
p.x = 255;
});

Example 2. Using the pixel's position:

// Creating 3D matrix (255 x 255 x 255) typed uint8_t
// and initialize all elements by the value which equals elements position.
// i.e. pixels (x,y,z) = (1,2,3) is (b,g,r) = (1,2,3).
int sizes[] = { 255, 255, 255 };
typedef cv::Point3_<uint8_t> Pixel;
Mat_<Pixel> image = Mat::zeros(3, sizes, CV_8UC3);
image.forEach<Pixel>([&](Pixel& pixel, const int position[]) -> void {
pixel.x = position[0];
pixel.y = position[1];
pixel.z = position[2];
});

§ forEach() [2/2]

template<typename _Tp , typename Functor >
void cv::Mat::forEach ( const Functor &  operation) const

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

§ getDefaultAllocator()

static MatAllocator* cv::Mat::getDefaultAllocator ( )
static

§ getStdAllocator()

static MatAllocator* cv::Mat::getStdAllocator ( )
static

and the standard allocator

§ getUMat()

UMat cv::Mat::getUMat ( int  accessFlags,
UMatUsageFlags  usageFlags = USAGE_DEFAULT 
) const

retrieve UMat from Mat

§ inv()

MatExpr cv::Mat::inv ( int  method = DECOMP_LU) const

Inverses a matrix.

The method performs a matrix inversion by means of matrix expressions. This means that a temporary matrix inversion object is returned by the method and can be used further as a part of more complex matrix expressions or can be assigned to a matrix.

Parameters
methodMatrix inversion method. One of cv::DecompTypes

§ isContinuous()

bool cv::Mat::isContinuous ( ) const

Reports whether the matrix is continuous or not.

The method returns true if the matrix elements are stored continuously without gaps at the end of each row. Otherwise, it returns false. Obviously, 1x1 or 1xN matrices are always continuous. Matrices created with Mat::create are always continuous. But if you extract a part of the matrix using Mat::col, Mat::diag, and so on, or constructed a matrix header for externally allocated data, such matrices may no longer have this property.

The continuity flag is stored as a bit in the Mat::flags field and is computed automatically when you construct a matrix header. Thus, the continuity check is a very fast operation, though theoretically it could be done as follows:

// alternative implementation of Mat::isContinuous()
bool myCheckMatContinuity(const Mat& m)
{
//return (m.flags & Mat::CONTINUOUS_FLAG) != 0;
return m.rows == 1 || m.step == m.cols*m.elemSize();
}

The method is used in quite a few of OpenCV functions. The point is that element-wise operations (such as arithmetic and logical operations, math functions, alpha blending, color space transformations, and others) do not depend on the image geometry. Thus, if all the input and output arrays are continuous, the functions can process them as very long single-row vectors. The example below illustrates how an alpha-blending function can be implemented:

template<typename T>
void alphaBlendRGBA(const Mat& src1, const Mat& src2, Mat& dst)
{
const float alpha_scale = (float)std::numeric_limits<T>::max(),
inv_scale = 1.f/alpha_scale;
CV_Assert( src1.type() == src2.type() &&
src1.type() == CV_MAKETYPE(traits::Depth<T>::value, 4) &&
src1.size() == src2.size());
Size size = src1.size();
dst.create(size, src1.type());
// here is the idiom: check the arrays for continuity and,
// if this is the case,
// treat the arrays as 1D vectors
if( src1.isContinuous() && src2.isContinuous() && dst.isContinuous() )
{
size.width *= size.height;
size.height = 1;
}
size.width *= 4;
for( int i = 0; i < size.height; i++ )
{
// when the arrays are continuous,
// the outer loop is executed only once
const T* ptr1 = src1.ptr<T>(i);
const T* ptr2 = src2.ptr<T>(i);
T* dptr = dst.ptr<T>(i);
for( int j = 0; j < size.width; j += 4 )
{
float alpha = ptr1[j+3]*inv_scale, beta = ptr2[j+3]*inv_scale;
dptr[j] = saturate_cast<T>(ptr1[j]*alpha + ptr2[j]*beta);
dptr[j+1] = saturate_cast<T>(ptr1[j+1]*alpha + ptr2[j+1]*beta);
dptr[j+2] = saturate_cast<T>(ptr1[j+2]*alpha + ptr2[j+2]*beta);
dptr[j+3] = saturate_cast<T>((1 - (1-alpha)*(1-beta))*alpha_scale);
}
}
}

This approach, while being very simple, can boost the performance of a simple element-operation by 10-20 percents, especially if the image is rather small and the operation is quite simple.

Another OpenCV idiom in this function, a call of Mat::create for the destination array, that allocates the destination array unless it already has the proper size and type. And while the newly allocated arrays are always continuous, you still need to check the destination array because Mat::create does not always allocate a new matrix.

§ isSubmatrix()

bool cv::Mat::isSubmatrix ( ) const

returns true if the matrix is a submatrix of another matrix

§ locateROI()

void cv::Mat::locateROI ( Size wholeSize,
Point ofs 
) const

Locates the matrix header within a parent matrix.

After you extracted a submatrix from a matrix using Mat::row, Mat::col, Mat::rowRange, Mat::colRange, and others, the resultant submatrix points just to the part of the original big matrix. However, each submatrix contains information (represented by datastart and dataend fields) that helps reconstruct the original matrix size and the position of the extracted submatrix within the original matrix. The method locateROI does exactly that.

Parameters
wholeSizeOutput parameter that contains the size of the whole matrix containing this as a part.
ofsOutput parameter that contains an offset of this inside the whole matrix.

§ mul()

MatExpr cv::Mat::mul ( InputArray  m,
double  scale = 1 
) const

Performs an element-wise multiplication or division of the two matrices.

The method returns a temporary object encoding per-element array multiplication, with optional scale. Note that this is not a matrix multiplication that corresponds to a simpler "\*" operator.

Example:

Mat C = A.mul(5/B); // equivalent to divide(A, B, C, 5)
Parameters
mAnother array of the same type and the same size as *this, or a matrix expression.
scaleOptional scale factor.

§ ones() [1/3]

static MatExpr cv::Mat::ones ( int  rows,
int  cols,
int  type 
)
static

Returns an array of all 1's of the specified size and type.

The method returns a Matlab-style 1's array initializer, similarly to Mat::zeros. Note that using this method you can initialize an array with an arbitrary value, using the following Matlab idiom:

Mat A = Mat::ones(100, 100, CV_8U)*3; // make 100x100 matrix filled with 3.

The above operation does not form a 100x100 matrix of 1's and then multiply it by 3. Instead, it just remembers the scale factor (3 in this case) and use it when actually invoking the matrix initializer.

Parameters
rowsNumber of rows.
colsNumber of columns.
typeCreated matrix type.
Examples:
demhist.cpp.

§ ones() [2/3]

static MatExpr cv::Mat::ones ( Size  size,
int  type 
)
static

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

Parameters
sizeAlternative to the matrix size specification Size(cols, rows) .
typeCreated matrix type.

§ ones() [3/3]

static MatExpr cv::Mat::ones ( int  ndims,
const int *  sz,
int  type 
)
static

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

Parameters
ndimsArray dimensionality.
szArray of integers specifying the array shape.
typeCreated matrix type.

§ operator Matx< _Tp, m, n >()

template<typename _Tp , int m, int n>
cv::Mat::operator Matx< _Tp, m, n > ( ) const

§ operator std::vector< _Tp >()

template<typename _Tp >
cv::Mat::operator std::vector< _Tp > ( ) const

§ operator Vec< _Tp, n >()

template<typename _Tp , int n>
cv::Mat::operator Vec< _Tp, n > ( ) const

§ operator()() [1/4]

Mat cv::Mat::operator() ( Range  rowRange,
Range  colRange 
) const

Extracts a rectangular submatrix.

The operators make a new header for the specified sub-array of *this . They are the most generalized forms of Mat::row, Mat::col, Mat::rowRange, and Mat::colRange . For example, A(Range(0, 10), Range::all()) is equivalent to A.rowRange(0, 10). Similarly to all of the above, the operators are O(1) operations, that is, no matrix data is copied.

Parameters
rowRangeStart and end row of the extracted submatrix. The upper boundary is not included. To select all the rows, use Range::all().
colRangeStart and end column of the extracted submatrix. The upper boundary is not included. To select all the columns, use Range::all().

§ operator()() [2/4]

Mat cv::Mat::operator() ( const Rect roi) const

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

Parameters
roiExtracted submatrix specified as a rectangle.

§ operator()() [3/4]

Mat cv::Mat::operator() ( const Range ranges) const

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

Parameters
rangesArray of selected ranges along each array dimension.

§ operator()() [4/4]

Mat cv::Mat::operator() ( const std::vector< Range > &  ranges) const

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

Parameters
rangesArray of selected ranges along each array dimension.

§ operator=() [1/3]

Mat& cv::Mat::operator= ( const Mat m)

assignment operators

These are available assignment operators. Since they all are very different, make sure to read the operator parameters description.

Parameters
mAssigned, right-hand-side matrix. Matrix assignment is an O(1) operation. This means that no data is copied but the data is shared and the reference counter, if any, is incremented. Before assigning new data, the old data is de-referenced via Mat::release .

§ operator=() [2/3]

Mat& cv::Mat::operator= ( const MatExpr expr)

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

Parameters
exprAssigned matrix expression object. As opposite to the first form of the assignment operation, the second form can reuse already allocated matrix if it has the right size and type to fit the matrix expression result. It is automatically handled by the real function that the matrix expressions is expanded to. For example, C=A+B is expanded to add(A, B, C), and add takes care of automatic C reallocation.

§ operator=() [3/3]

Mat& cv::Mat::operator= ( const Scalar s)

Sets all or some of the array elements to the specified value.

Parameters
sAssigned scalar converted to the actual array type.

§ pop_back()

void cv::Mat::pop_back ( size_t  nelems = 1)

Removes elements from the bottom of the matrix.

The method removes one or more rows from the bottom of the matrix.

Parameters
nelemsNumber of removed rows. If it is greater than the total number of rows, an exception is thrown.

§ ptr() [1/20]

uchar* cv::Mat::ptr ( int  i0 = 0)

Returns a pointer to the specified matrix row.

The methods return uchar* or typed pointer to the specified matrix row. See the sample in Mat::isContinuous to know how to use these methods.

Parameters
i0A 0-based row index.
Examples:
image_alignment.cpp, and train_HOG.cpp.

§ ptr() [2/20]

const uchar* cv::Mat::ptr ( int  i0 = 0) const

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

§ ptr() [3/20]

uchar* cv::Mat::ptr ( int  row,
int  col 
)

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

Parameters
rowIndex along the dimension 0
colIndex along the dimension 1

§ ptr() [4/20]

const uchar* cv::Mat::ptr ( int  row,
int  col 
) const

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

Parameters
rowIndex along the dimension 0
colIndex along the dimension 1

§ ptr() [5/20]

uchar* cv::Mat::ptr ( int  i0,
int  i1,
int  i2 
)

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

§ ptr() [6/20]

const uchar* cv::Mat::ptr ( int  i0,
int  i1,
int  i2 
) const

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

§ ptr() [7/20]

uchar* cv::Mat::ptr ( const int *  idx)

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

§ ptr() [8/20]

const uchar* cv::Mat::ptr ( const int *  idx) const

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

§ ptr() [9/20]

template<int n>
uchar* cv::Mat::ptr ( const Vec< int, n > &  idx)

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

§ ptr() [10/20]

template<int n>
const uchar* cv::Mat::ptr ( const Vec< int, n > &  idx) const

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

§ ptr() [11/20]

template<typename _Tp >
_Tp* cv::Mat::ptr ( int  i0 = 0)

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

§ ptr() [12/20]

template<typename _Tp >
const _Tp* cv::Mat::ptr ( int  i0 = 0) const

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

§ ptr() [13/20]

template<typename _Tp >
_Tp* cv::Mat::ptr ( int  row,
int  col 
)

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

Parameters
rowIndex along the dimension 0
colIndex along the dimension 1

§ ptr() [14/20]

template<typename _Tp >
const _Tp* cv::Mat::ptr ( int  row,
int  col 
) const

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

Parameters
rowIndex along the dimension 0
colIndex along the dimension 1

§ ptr() [15/20]

template<typename _Tp >
_Tp* cv::Mat::ptr ( int  i0,
int  i1,
int  i2 
)

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

§ ptr() [16/20]

template<typename _Tp >
const _Tp* cv::Mat::ptr ( int  i0,
int  i1,
int  i2 
) const

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

§ ptr() [17/20]

template<typename _Tp >
_Tp* cv::Mat::ptr ( const int *  idx)

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

§ ptr() [18/20]

template<typename _Tp >
const _Tp* cv::Mat::ptr ( const int *  idx) const

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

§ ptr() [19/20]

template<typename _Tp , int n>
_Tp* cv::Mat::ptr ( const Vec< int, n > &  idx)

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

§ ptr() [20/20]

template<typename _Tp , int n>
const _Tp* cv::Mat::ptr ( const Vec< int, n > &  idx) const

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

§ push_back() [1/4]

template<typename _Tp >
void cv::Mat::push_back ( const _Tp &  elem)

Adds elements to the bottom of the matrix.

The methods add one or more elements to the bottom of the matrix. They emulate the corresponding method of the STL vector class. When elem is Mat , its type and the number of columns must be the same as in the container matrix.

Parameters
elemAdded element(s).

§ push_back() [2/4]

template<typename _Tp >
void cv::Mat::push_back ( const Mat_< _Tp > &  elem)

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

Parameters
elemAdded element(s).

§ push_back() [3/4]

template<typename _Tp >
void cv::Mat::push_back ( const std::vector< _Tp > &  elem)

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

Parameters
elemAdded element(s).

§ push_back() [4/4]

void cv::Mat::push_back ( const Mat m)

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

Parameters
mAdded line(s).

§ push_back_()

void cv::Mat::push_back_ ( const void *  elem)

internal function

§ release()

void cv::Mat::release ( )

Decrements the reference counter and deallocates the matrix if needed.

The method decrements the reference counter associated with the matrix data. When the reference counter reaches 0, the matrix data is deallocated and the data and the reference counter pointers are set to NULL's. If the matrix header points to an external data set (see Mat::Mat ), the reference counter is NULL, and the method has no effect in this case.

This method can be called manually to force the matrix data deallocation. But since this method is automatically called in the destructor, or by any other method that changes the data pointer, it is usually not needed. The reference counter decrement and check for 0 is an atomic operation on the platforms that support it. Thus, it is safe to operate on the same matrices asynchronously in different threads.

Examples:
peopledetect.cpp.

§ reserve()

void cv::Mat::reserve ( size_t  sz)

Reserves space for the certain number of rows.

The method reserves space for sz rows. If the matrix already has enough space to store sz rows, nothing happens. If the matrix is reallocated, the first Mat::rows rows are preserved. The method emulates the corresponding method of the STL vector class.

Parameters
szNumber of rows.

§ reserveBuffer()

void cv::Mat::reserveBuffer ( size_t  sz)

Reserves space for the certain number of bytes.

The method reserves space for sz bytes. If the matrix already has enough space to store sz bytes, nothing happens. If matrix has to be reallocated its previous content could be lost.

Parameters
szNumber of bytes.

§ reshape() [1/3]

Mat cv::Mat::reshape ( int  cn,
int  rows = 0 
) const

Changes the shape and/or the number of channels of a 2D matrix without copying the data.

The method makes a new matrix header for *this elements. The new matrix may have a different size and/or different number of channels. Any combination is possible if:

  • No extra elements are included into the new matrix and no elements are excluded. Consequently, the product rows*cols*channels() must stay the same after the transformation.
  • No data is copied. That is, this is an O(1) operation. Consequently, if you change the number of rows, or the operation changes the indices of elements row in some other way, the matrix must be continuous. See Mat::isContinuous .

For example, if there is a set of 3D points stored as an STL vector, and you want to represent the points as a 3xN matrix, do the following:

std::vector<Point3f> vec;
...
Mat pointMat = Mat(vec). // convert vector to Mat, O(1) operation
reshape(1). // make Nx3 1-channel matrix out of Nx1 3-channel.
// Also, an O(1) operation
t(); // finally, transpose the Nx3 matrix.
// This involves copying all the elements
Parameters
cnNew number of channels. If the parameter is 0, the number of channels remains the same.
rowsNew number of rows. If the parameter is 0, the number of rows remains the same.
Examples:
pca.cpp.

§ reshape() [2/3]

Mat cv::Mat::reshape ( int  cn,
int  newndims,
const int *  newsz 
) const

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

§ reshape() [3/3]

Mat cv::Mat::reshape ( int  cn,
const std::vector< int > &  newshape 
) const

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

§ resize() [1/2]

void cv::Mat::resize ( size_t  sz)

Changes the number of matrix rows.

The methods change the number of matrix rows. If the matrix is reallocated, the first min(Mat::rows, sz) rows are preserved. The methods emulate the corresponding methods of the STL vector class.

Parameters
szNew number of rows.

§ resize() [2/2]

void cv::Mat::resize ( size_t  sz,
const Scalar s 
)

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

Parameters
szNew number of rows.
sValue assigned to the newly added elements.

§ row()

Mat cv::Mat::row ( int  y) const

Creates a matrix header for the specified matrix row.

The method makes a new header for the specified matrix row and returns it. This is an O(1) operation, regardless of the matrix size. The underlying data of the new matrix is shared with the original matrix. Here is the example of one of the classical basic matrix processing operations, axpy, used by LU and many other algorithms:

inline void matrix_axpy(Mat& A, int i, int j, double alpha)
{
A.row(i) += A.row(j)*alpha;
}
Note
In the current implementation, the following code does not work as expected:
Mat A;
...
A.row(i) = A.row(j); // will not work
This happens because A.row(i) forms a temporary header that is further assigned to another header. Remember that each of these operations is O(1), that is, no data is copied. Thus, the above assignment is not true if you may have expected the j-th row to be copied to the i-th row. To achieve that, you should either turn this simple assignment into an expression or use the Mat::copyTo method:
Mat A;
...
// works, but looks a bit obscure.
A.row(i) = A.row(j) + 0;
// this is a bit longer, but the recommended method.
A.row(j).copyTo(A.row(i));
Parameters
yA 0-based row index.
Examples:
pca.cpp, and train_HOG.cpp.

§ rowRange() [1/2]

Mat cv::Mat::rowRange ( int  startrow,
int  endrow 
) const

Creates a matrix header for the specified row span.

The method makes a new header for the specified row span of the matrix. Similarly to Mat::row and Mat::col , this is an O(1) operation.

Parameters
startrowAn inclusive 0-based start index of the row span.
endrowAn exclusive 0-based ending index of the row span.
Examples:
kmeans.cpp.

§ rowRange() [2/2]

Mat cv::Mat::rowRange ( const Range r) const

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

Parameters
rRange structure containing both the start and the end indices.

§ setDefaultAllocator()

static void cv::Mat::setDefaultAllocator ( MatAllocator allocator)
static

§ setTo()

Mat& cv::Mat::setTo ( InputArray  value,
InputArray  mask = noArray() 
)

Sets all or some of the array elements to the specified value.

This is an advanced variant of the Mat::operator=(const Scalar& s) operator.

Parameters
valueAssigned scalar converted to the actual array type.
maskOperation mask of the same size as *this. Its non-zero elements indicate which matrix elements need to be copied. The mask has to be of type CV_8U and can have 1 or multiple channels

§ step1()

size_t cv::Mat::step1 ( int  i = 0) const

Returns a normalized step.

The method returns a matrix step divided by Mat::elemSize1() . It can be useful to quickly access an arbitrary matrix element.

§ t()

MatExpr cv::Mat::t ( ) const

Transposes a matrix.

The method performs matrix transposition by means of matrix expressions. It does not perform the actual transposition but returns a temporary matrix transposition object that can be further used as a part of more complex matrix expressions or can be assigned to a matrix:

Mat A1 = A + Mat::eye(A.size(), A.type())*lambda;
Mat C = A1.t()*A1; // compute (A + lambda*I)^t * (A + lamda*I)

§ total() [1/2]

size_t cv::Mat::total ( ) const

Returns the total number of array elements.

The method returns the number of array elements (a number of pixels if the array represents an image).

Examples:
train_HOG.cpp.

§ total() [2/2]

size_t cv::Mat::total ( int  startDim,
int  endDim = INT_MAX 
) const

Returns the total number of array elements.

The method returns the number of elements within a certain sub-array slice with startDim <= dim < endDim

§ type()

int cv::Mat::type ( ) const

Returns the type of a matrix element.

The method returns a matrix element type. This is an identifier compatible with the CvMat type system, like CV_16SC3 or 16-bit signed 3-channel array, and so on.

Examples:
grabcut.cpp, image_alignment.cpp, Smoothing.cpp, and train_HOG.cpp.

§ zeros() [1/3]

static MatExpr cv::Mat::zeros ( int  rows,
int  cols,
int  type 
)
static

Returns a zero array of the specified size and type.

The method returns a Matlab-style zero array initializer. It can be used to quickly form a constant array as a function parameter, part of a matrix expression, or as a matrix initializer. :

Mat A;
A = Mat::zeros(3, 3, CV_32F);

In the example above, a new matrix is allocated only if A is not a 3x3 floating-point matrix. Otherwise, the existing matrix A is filled with zeros.

Parameters
rowsNumber of rows.
colsNumber of columns.
typeCreated matrix type.
Examples:
camshiftdemo.cpp, contours2.cpp, Drawing_1.cpp, Drawing_2.cpp, falsecolor.cpp, fitellipse.cpp, and kalman.cpp.

§ zeros() [2/3]

static MatExpr cv::Mat::zeros ( Size  size,
int  type 
)
static

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

Parameters
sizeAlternative to the matrix size specification Size(cols, rows) .
typeCreated matrix type.

§ zeros() [3/3]

static MatExpr cv::Mat::zeros ( int  ndims,
const int *  sz,
int  type 
)
static

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

Parameters
ndimsArray dimensionality.
szArray of integers specifying the array shape.
typeCreated matrix type.

Member Data Documentation

§ allocator

MatAllocator* cv::Mat::allocator

custom allocator

§ cols

int cv::Mat::cols

§ data

uchar* cv::Mat::data

pointer to the data

§ dataend

const uchar* cv::Mat::dataend

§ datalimit

const uchar* cv::Mat::datalimit

§ datastart

const uchar* cv::Mat::datastart

helper fields used in locateROI and adjustROI

§ dims

int cv::Mat::dims

the matrix dimensionality, >= 2

§ flags

int cv::Mat::flags

includes several bit-fields:

  • the magic signature
  • continuity flag
  • depth
  • number of channels

§ rows

int cv::Mat::rows

§ size

MatSize cv::Mat::size

§ step

MatStep cv::Mat::step

§ u

UMatData* cv::Mat::u

interaction with UMat


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