Options
All
• Public
• Public/Protected
• All

# Class Mat

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*i_0 + M.step*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*i + M.step*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 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:

Use the create(nrows, ncols, type) method or the similar Mat(nrows, ncols, type[, fillValue]) constructor. A new array of the specified size and type is allocated. type has the same meaning as in the cvCreateMat method. For example, CV_8UC1 means a 8-bit single-channel array, CV_32FC2 means a 2-channel (complex) floating-point array, and so on.

// make a 7x7 complex matrix filled with 1+3j.
Mat M(7,7,CV_32FC2,Scalar(1,3));
// and now turn M to a 100x60 15-channel 8-bit matrix.
// The old content will be deallocated
M.create(100,60,CV_8UC(15));

As noted in the introduction to this chapter, create() allocates only a new array when the shape or type of the current array are different from the specified ones. Create a multi-dimensional array:

// create a 100x100x100 8-bit array
int sz[] = {100, 100, 100};
Mat bigCube(3, sz, CV_8U, Scalar::all(0));

It passes the number of dimensions =1 to the Mat constructor but the created array will be 2-dimensional with the number of columns set to 1. So, Mat::dims is always >= 2 (can also be 0 when the array is empty). Use a copy constructor or assignment operator where there can be an array or expression on the right side (see below). As noted in the introduction, the array assignment is an O(1) operation because it only copies the header and increases the reference counter. The Mat::clone() method can be used to get a full (deep) copy of the array when you need it. Construct a header for a part of another array. It can be a single row, single column, several rows, several columns, rectangular region in the array (called a minor in algebra) or a diagonal. Such operations are also O(1) because the new header references the same data. You can actually modify a part of the array using this feature, for example:

// add the 5-th row, multiplied by 3 to the 3rd row
M.row(3) = M.row(3) + M.row(5)*3;
// now copy the 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 a new 320x240 image
Mat img(Size(320,240),CV_8UC3);
// select a ROI
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);

Due to the additional datastart and dataend members, it is possible to compute a relative sub-array position in the main container array using locateROI():

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)

As in case of whole matrices, if you need a deep copy, use the [clone()](#d3/d63/classcv_1_1Mat_1adff2ea98da45eae0833e73582dd4a660}) method of the extracted sub-matrices. Make a header for user-allocated data. It can be useful to do the following:

Process "foreign" data using OpenCV (for example, when you implement a DirectShow* filter or a processing module for gstreamer, and so on). For example:

void process_video_frame(const unsigned char* pixels,
int width, int height, int step)
{
Mat img(height, width, CV_8UC3, pixels, step);
GaussianBlur(img, img, Size(7,7), 1.5, 1.5);
}

Quickly initialize small matrices and/or get a super-fast element access.

double m = {{a, b, c}, {d, e, f}, {g, h, i}};
Mat M = Mat(3, 3, CV_64F, m).inv();

Use MATLAB-style array initializers, zeros(), ones(), eye(), for example:

// create a double-precision identity matrix and add it to M.
M += Mat::eye(M.rows, M.cols, CV_64F);

Use a comma-separated initializer:

// create a 3x3 double-precision identity matrix
Mat M = (Mat_<double>(3,3) << 1, 0, 0, 0, 1, 0, 0, 0, 1);

With this approach, you first call a constructor of the Mat class with the proper parameters, and then you just put << operator followed by comma-separated values that can be constants, variables, expressions, and so on. Also, note the extra parentheses required to avoid compilation errors.

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().

Matrix Expressions and arithmetic see MatExpr

Source: opencv2/core/mat.hpp.

## Constructors

### constructor

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

#### Returns Mat

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

#### Parameters

• ##### rows: int

Number of rows in a 2D array.

• ##### cols: int

Number of columns in a 2D array.

• ##### type: int

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

#### Returns Mat

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

#### Parameters

• ##### size: Size

2D array size: Size(cols, rows) . In the Size() constructor, the number of rows and the number of columns go in the reverse order.

• ##### type: int

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

#### Returns Mat

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

#### Parameters

• ##### rows: int

Number of rows in a 2D array.

• ##### cols: int

Number of columns in a 2D array.

• ##### type: int

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

• ##### s: Scalar

An 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) .

#### Returns Mat

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

#### Parameters

• ##### size: Size

2D array size: Size(cols, rows) . In the Size() constructor, the number of rows and the number of columns go in the reverse order.

• ##### type: int

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

• ##### s: Scalar

An 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) .

#### Returns Mat

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

#### Parameters

• ##### ndims: int

Array dimensionality.

• ##### sizes: any

Array of integers specifying an n-dimensional array shape.

• ##### type: int

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

#### Returns Mat

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

#### Parameters

• ##### sizes: any

Array of integers specifying an n-dimensional array shape.

• ##### type: int

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

#### Returns Mat

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

#### Parameters

• ##### ndims: int

Array dimensionality.

• ##### sizes: any

Array of integers specifying an n-dimensional array shape.

• ##### type: int

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

• ##### s: Scalar

An 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) .

#### Returns Mat

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

#### Parameters

• ##### sizes: any

Array of integers specifying an n-dimensional array shape.

• ##### type: int

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

• ##### s: Scalar

An 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) .

#### Returns Mat

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

#### Parameters

• ##### m: Mat

Array 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() .

#### Returns Mat

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

#### Parameters

• ##### rows: int

Number of rows in a 2D array.

• ##### cols: int

Number of columns in a 2D array.

• ##### type: int

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

• ##### data: any

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

• ##### Optional step: size_t

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

#### Returns Mat

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

#### Parameters

• ##### size: Size

2D array size: Size(cols, rows) . In the Size() constructor, the number of rows and the number of columns go in the reverse order.

• ##### type: int

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

• ##### data: any

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

• ##### Optional step: size_t

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

#### Returns Mat

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

#### Parameters

• ##### ndims: int

Array dimensionality.

• ##### sizes: any

Array of integers specifying an n-dimensional array shape.

• ##### type: int

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

• ##### data: any

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

• ##### Optional steps: any

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

#### Returns Mat

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

#### Parameters

• ##### sizes: any

Array of integers specifying an n-dimensional array shape.

• ##### type: int

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

• ##### data: any

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

• ##### Optional steps: any

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

#### Returns Mat

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

#### Parameters

• ##### m: Mat

Array 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() .

• ##### rowRange: Range

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

• ##### Optional colRange: Range

Range of the m columns to take. Use Range::all() to take all the columns.

#### Returns Mat

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

#### Parameters

• ##### m: Mat

Array 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() .

• ##### roi: Rect

Region of interest.

#### Returns Mat

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

#### Parameters

• ##### m: Mat

Array 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() .

• ##### ranges: Range

Array of selected ranges of m along each dimensionality.

#### Returns Mat

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

#### Parameters

• ##### m: Mat

Array 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() .

• ##### ranges: Range

Array of selected ranges of m along each dimensionality.

#### Returns Mat

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

#### Parameters

• ##### vec: any

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

• ##### Optional copyData: bool

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

#### Returns Mat

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

#### Returns Mat

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

#### Parameters

• ##### sizes: any

Array of integers specifying an n-dimensional array shape.

#### Returns Mat

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

#### Parameters

• ##### Optional copyData: bool

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

#### Returns Mat

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

#### Parameters

• ##### vec: Vec

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

• ##### Optional copyData: bool

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

#### Returns Mat

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

#### Parameters

• ##### m: int

Array 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() .

• ##### Optional copyData: bool

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

#### Returns Mat

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

#### Parameters

• ##### Optional copyData: bool

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

#### Returns Mat

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

#### Parameters

• ##### Optional copyData: bool

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

#### Returns Mat

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

#### Parameters

• ##### m: any

Array 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() .

#### Parameters

• ##### m: Mat

Array 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() .

## Properties

### allocator

allocator: MatAllocator

cols: int

data: uchar

### data16S

data16S: Int16Array

### data16U

data16U: Uint16Array

### data32F

data32F: Float32Array

### data32S

data32S: Int32Array

### data32U

data32U: Uint32Array

### data64F

data64F: Float64Array

### data8S

data8S: Int8Array

### data8U

data8U: Uint8Array

dataend: uchar

datalimit: uchar

datastart: uchar

dims: int

### flags

flags: int

includes several bit-fields:

the magic signature continuity flag depth number of channels

rows: int

size: MatSize

step: MatStep

## Methods

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

#### Returns void

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

[copyMakeBorder]

#### Parameters

• ##### dtop: int

Shift of the top submatrix boundary upwards.

• ##### dbottom: int

Shift of the bottom submatrix boundary downwards.

• ##### dleft: int

Shift of the left submatrix boundary to the left.

• ##### dright: int

Shift of the right submatrix boundary to the right.

### begin

• 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*inv_scale, beta = pix2*inv_scale;
dst_it = VT(saturate_cast<T>(pix1*alpha + pix2*beta),
saturate_cast<T>(pix1*alpha + pix2*beta),
saturate_cast<T>(pix1*alpha + pix2*beta),
saturate_cast<T>((1 - (1-alpha)*(1-beta))*alpha_scale));
}
}

### channels

• channels(): int
• The method returns the number of matrix channels.

### charAt

• charAt(i: any): any

### charPtr

• charPtr(i: any, j: any): any

### checkVector

• checkVector(elemChannels: int, depth?: int, requireContinuous?: bool): int
• -1 if the requirement is not satisfied. Otherwise, it returns the number of elements in the matrix. Note that an element may have multiple channels. The following code demonstrates its usage for a 2-d matrix:

      cv::Mat mat(20, 1, CV_32FC2);
int n = mat.checkVector(2);
CV_Assert(n == 20); // mat has 20 elements

mat.create(20, 2, CV_32FC1);
n = mat.checkVector(1);
CV_Assert(n == -1); // mat is neither a column nor a row vector

n = mat.checkVector(2);
CV_Assert(n == 20); // the 2 columns are considered as 1 element

The following code demonstrates its usage for a 3-d matrix:

      int dims[] = {1, 3, 5}; // 1 plane, every plane has 3 rows and 5 columns
mat.create(3, dims, CV_32FC1); // for 3-d mat, it MUST have only 1 channel
n = mat.checkVector(5); // the 5 columns are considered as 1 element
CV_Assert(n == 3);

int dims2[] = {3, 1, 5}; // 3 planes, every plane has 1 row and 5 columns
mat.create(3, dims2, CV_32FC1);
n = mat.checkVector(5); // the 5 columns are considered as 1 element
CV_Assert(n == 3);

#### Parameters

• ##### elemChannels: int

Number of channels or number of columns the matrix should have. For a 2-D matrix, when the matrix has only 1 column, then it should have elemChannels channels; When the matrix has only 1 channel, then it should have elemChannels columns. For a 3-D matrix, it should have only one channel. Furthermore, if the number of planes is not one, then the number of rows within every plane has to be 1; if the number of rows within every plane is not 1, then the number of planes has to be 1.

• ##### Optional depth: int

The depth the matrix should have. Set it to -1 when any depth is fine.

• ##### Optional requireContinuous: bool

Set it to true to require the matrix to be continuous

### clone

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

### col

• 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

• ##### x: int

A 0-based column index.

### colRange

• colRange(startcol: int, endcol: int): Mat
• colRange(r: Range): Mat
• 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

• ##### startcol: int

An inclusive 0-based start index of the column span.

• ##### endcol: int

An exclusive 0-based ending index of the column span.

#### Returns Mat

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

#### Parameters

• ##### r: Range

Range structure containing both the start and the end indices.

### convertTo

• convertTo(m: OutputArray, rtype: int, alpha?: double, beta?: double): OutputArray
• 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

• ##### m: OutputArray

output matrix; if it does not have a proper size or type before the operation, it is reallocated.

• ##### rtype: int

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

• ##### Optional alpha: double

optional scale factor.

• ##### Optional beta: double

optional delta added to the scaled values.

### copyTo

• copyTo(m: OutputArray): OutputArray
• copyTo(m: OutputArray, mask: InputArray): OutputArray
• 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

• ##### m: OutputArray

Destination matrix. If it does not have a proper size or type before the operation, it is reallocated.

#### Returns OutputArray

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

#### Parameters

• ##### m: OutputArray

Destination matrix. If it does not have a proper size or type before the operation, it is reallocated.

Operation 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

• create(rows: int, cols: int, type: int): void
• create(size: Size, type: int): Size
• create(ndims: int, sizes: any, type: int): void
• create(sizes: any, type: int): void
• 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:

If the current array shape and the type match the new ones, return immediately. Otherwise, de-reference the previous data by calling [Mat::release]. Initialize the new header. Allocate the new data of [total()]*elemSize() bytes. 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

• ##### rows: int

New number of rows.

• ##### cols: int

New number of columns.

• ##### type: int

New matrix type.

#### Returns void

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

#### Parameters

• ##### size: Size

Alternative new matrix size specification: Size(cols, rows)

• ##### type: int

New matrix type.

#### Returns Size

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

#### Parameters

• ##### ndims: int

New array dimensionality.

• ##### sizes: any

Array of integers specifying a new array shape.

• ##### type: int

New matrix type.

#### Returns void

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

#### Parameters

• ##### sizes: any

Array of integers specifying a new array shape.

• ##### type: int

New matrix type.

### cross

• cross(m: InputArray): Mat
• 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

• ##### m: InputArray

Another cross-product operand.

### deallocate

• deallocate(): void

### delete

• delete(): void
• delete(): void

### deleteLater

• deleteLater(...a: any[]): any

### depth

• 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 )

### diag

• 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

• ##### Optional d: int

index 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: Matm=(Mat_(3,3)<< 1,2,3, 4,5,6, 7,8,9); Matd0=m.diag(0); Matd1=m.diag(1); Matd_1=m.diag(-1); The resulting matrices are d0= [1; 5; 9] d1= [2; 6] d_1= [4; 8]

### dot

• dot(m: InputArray): InputArray
• 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

• ##### m: InputArray

another dot-product operand.

### doublePtr

• doublePtr(i: any, j: any): any

### elemSize

• 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

• 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

• The method returns true if [Mat::total()] is 0 or if [Mat::data] is NULL. Because of [pop_back()] and [resize()] methods [M.total()] == 0 does not imply that M.data == NULL.

### end

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

### floatPtr

• floatPtr(i: any, j: any): any

### forEach

• forEach(arg29: any, arg30: any, operation: any): any
• forEach(arg31: any, arg32: any, operation: any): any
• 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;
pixel.y = position;
pixel.z = position;
});

#### Returns any

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

### get

• get(i: number): Mat
• get(i: number, j: number, data: any): Mat

### intPtr

• intPtr(i: any, j: any): any
• intPtr(i: any, j: any): any

### inv

• 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

• ##### Optional method: int

Matrix inversion method. One of cv::DecompTypes

### isAliasOf

• isAliasOf(...a: any[]): any

### isContinuous

• isContinuous(): bool
• 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.

### isDeleted

• isDeleted(...a: any[]): any

### locateROI

• 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

• ##### wholeSize: Size

Output parameter that contains the size of the whole matrix containing this as a part.

• ##### ofs: Point

Output parameter that contains an offset of this inside the whole matrix.

### mul

• 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

• ##### m: InputArray

Another array of the same type and the same size as *this, or a matrix expression.

• ##### Optional scale: double

Optional scale factor.

### pop_back

• pop_back(nelems?: size_t): void
• The method removes one or more rows from the bottom of the matrix.

#### Parameters

• ##### Optional nelems: size_t

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

### ptr

• 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

• ##### Optional i0: int

A 0-based row index.

#### Returns uchar

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

#### Returns uchar

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

#### Parameters

• ##### row: int

Index along the dimension 0

• ##### col: int

Index along the dimension 1

#### Returns uchar

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

#### Parameters

• ##### row: int

Index along the dimension 0

• ##### col: int

Index along the dimension 1

#### Returns uchar

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

#### Returns uchar

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

#### Returns uchar

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

#### Returns uchar

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

#### Returns uchar

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

#### Returns uchar

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

#### Returns uchar

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

#### Returns any

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

#### Returns any

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

#### Parameters

• ##### row: int

Index along the dimension 0

• ##### col: int

Index along the dimension 1

#### Returns any

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

#### Parameters

• ##### row: int

Index along the dimension 0

• ##### col: int

Index along the dimension 1

#### Returns any

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

#### Returns any

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

#### Returns any

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

#### Returns any

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

#### Returns any

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

#### Returns Vec

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

### push_back

• push_back(arg47: any, elem: any): any
• push_back(arg48: any, elem: Mat_): Mat_
• push_back(arg49: any, elem: any): any
• push_back(m: Mat): Mat
• 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.

#### Returns any

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

#### Returns Mat_

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

#### Returns any

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

### push_back_

• push_back_(elem: any): void

### put

• put(i: number, j: number, data: any): any

### release

• release(): void
• 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.

### reserve

• 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

• ##### sz: size_t

Number of rows.

### reserveBuffer

• reserveBuffer(sz: size_t): void
• 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

• ##### sz: size_t

Number of bytes.

### reshape

• reshape(cn: int, rows?: int): Mat
• reshape(cn: int, newndims: int, newsz: any): Mat
• reshape(cn: int, newshape: any): Mat
• 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 rowscolschannels() 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

• ##### cn: int

New number of channels. If the parameter is 0, the number of channels remains the same.

• ##### Optional rows: int

New number of rows. If the parameter is 0, the number of rows remains the same.

#### Returns Mat

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

#### Returns Mat

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

### resize

• 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

• ##### sz: size_t

New number of rows.

#### Returns void

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

#### Parameters

• ##### sz: size_t

New number of rows.

• ##### s: Scalar

Value assigned to the newly added elements.

### roi

• Sometimes, you will have to play with certain region of images. For eye detection in images, first face detection is done all over the image and when face is obtained, we select the face region alone and search for eyes inside it instead of searching whole image. It improves accuracy (because eyes are always on faces) and performance (because we search for a small area).

Heads up : in JS seems only one argument is expected.

### 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;
}

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

• ##### y: int

A 0-based row index.

### rowRange

• rowRange(startrow: int, endrow: int): Mat
• rowRange(r: Range): Mat
• 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

• ##### startrow: int

An inclusive 0-based start index of the row span.

• ##### endrow: int

An exclusive 0-based ending index of the row span.

#### Returns Mat

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

#### Parameters

• ##### r: Range

Range structure containing both the start and the end indices.

### set

• set(i: number, t: Mat): void

### setTo

• setTo(value: InputArray | Scalar, mask?: InputArray): Mat
• This is an advanced variant of the [Mat::operator=(const Scalar& s)] operator.

#### Parameters

• ##### value: InputArray | Scalar

Assigned scalar converted to the actual array type.

Operation 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

### shortPtr

• shortPtr(i: any, j: any): any

### step1

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

### t

• 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

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

#### Returns size_t

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

### type

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

### ucharAt

• ucharAt(i: any): any

### ucharPtr

• ucharPtr(i: any, j: any): any

### updateContinuityFlag

• updateContinuityFlag(): void

### ushortPtr

• ushortPtr(i: any, j: any): any

### Static diag

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

#### Parameters

• ##### d: Mat

One-dimensional matrix that represents the main diagonal.

### Static eye

• 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;

In case of multi-channels type, identity matrix will be initialized only for the first channel, the others will be set to 0's

#### Parameters

• ##### rows: int

Number of rows.

• ##### cols: int

Number of columns.

• ##### type: int

Created matrix type.

#### Returns MatExpr

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

#### Parameters

• ##### size: Size

Alternative matrix size specification as Size(cols, rows) .

• ##### type: int

Created matrix type.

### Static ones

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

In case of multi-channels type, only the first channel will be initialized with 1's, the others will be set to 0's.

#### Parameters

• ##### rows: int

Number of rows.

• ##### cols: int

Number of columns.

• ##### type: int

Created matrix type.

#### Returns MatExpr

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

#### Parameters

• ##### size: Size

Alternative to the matrix size specification Size(cols, rows) .

• ##### type: int

Created matrix type.

#### Returns MatExpr

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

#### Parameters

• ##### ndims: int

Array dimensionality.

• ##### sz: any

Array of integers specifying the array shape.

• ##### type: int

Created matrix type.

### Static zeros

• 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

• ##### rows: int

Number of rows.

• ##### cols: int

Number of columns.

• ##### type: int

Created matrix type.

#### Returns MatExpr

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

#### Parameters

• ##### size: Size

Alternative to the matrix size specification Size(cols, rows) .

• ##### type: int

Created matrix type.

#### Returns MatExpr

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

#### Parameters

• ##### ndims: int

Array dimensionality.

• ##### sz: any

Array of integers specifying the array shape.

• ##### type: int

Created matrix type.

#### Returns MatExpr

Generated using TypeDoc