OpenCV453
公開型 | 公開メンバ関数 | 静的公開メンバ関数 | 全メンバ一覧
cv::Mat_< _Tp > クラステンプレート

Template matrix class derived from Mat [詳解]

#include <mat.hpp>

cv::Matを継承しています。

公開型

typedef _Tp value_type
 
typedef DataType< _Tp >::channel_type channel_type
 
typedef MatIterator_< _Tp > iterator
 
typedef MatConstIterator_< _Tp > const_iterator
 
- 基底クラス cv::Mat に属する継承公開型
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 }
 

公開メンバ関数

 Mat_ () CV_NOEXCEPT
 default constructor
 
 Mat_ (int _rows, int _cols)
 equivalent to Mat(_rows, _cols, DataType<_Tp>::type)
 
 Mat_ (int _rows, int _cols, const _Tp &value)
 constructor that sets each matrix element to specified value
 
 Mat_ (Size _size)
 equivalent to Mat(_size, DataType<_Tp>::type)
 
 Mat_ (Size _size, const _Tp &value)
 constructor that sets each matrix element to specified value
 
 Mat_ (int _ndims, const int *_sizes)
 n-dim array constructor
 
 Mat_ (int _ndims, const int *_sizes, const _Tp &value)
 n-dim array constructor that sets each matrix element to specified value
 
 Mat_ (const Mat &m)
 copy/conversion constructor. If m is of different type, it's converted
 
 Mat_ (const Mat_ &m)
 copy constructor
 
 Mat_ (int _rows, int _cols, _Tp *_data, size_t _step=AUTO_STEP)
 constructs a matrix on top of user-allocated data. step is in bytes(!!!), regardless of the type
 
 Mat_ (int _ndims, const int *_sizes, _Tp *_data, const size_t *_steps=0)
 constructs n-dim matrix on top of user-allocated data. steps are in bytes(!!!), regardless of the type
 
 Mat_ (const Mat_ &m, const Range &rowRange, const Range &colRange=Range::all())
 selects a submatrix
 
 Mat_ (const Mat_ &m, const Rect &roi)
 selects a submatrix
 
 Mat_ (const Mat_ &m, const Range *ranges)
 selects a submatrix, n-dim version
 
 Mat_ (const Mat_ &m, const std::vector< Range > &ranges)
 selects a submatrix, n-dim version
 
 Mat_ (const MatExpr &e)
 from a matrix expression
 
 Mat_ (const std::vector< _Tp > &vec, bool copyData=false)
 makes a matrix out of Vec, std::vector, Point_ or Point3_. The matrix will have a single column
 
template<int n>
 Mat_ (const Vec< typename DataType< _Tp >::channel_type, n > &vec, bool copyData=true)
 
template<int m, int n>
 Mat_ (const Matx< typename DataType< _Tp >::channel_type, m, n > &mtx, bool copyData=true)
 
 Mat_ (const Point_< typename DataType< _Tp >::channel_type > &pt, bool copyData=true)
 
 Mat_ (const Point3_< typename DataType< _Tp >::channel_type > &pt, bool copyData=true)
 
 Mat_ (const MatCommaInitializer_< _Tp > &commaInitializer)
 
 Mat_ (std::initializer_list< _Tp > values)
 
 Mat_ (const std::initializer_list< int > sizes, const std::initializer_list< _Tp > values)
 
template<std::size_t _Nm>
 Mat_ (const std::array< _Tp, _Nm > &arr, bool copyData=false)
 
Mat_operator= (const Mat &m)
 
Mat_operator= (const Mat_ &m)
 
Mat_operator= (const _Tp &s)
 set all the elements to s.
 
Mat_operator= (const MatExpr &e)
 assign a matrix expression
 
iterator begin ()
 iterators; they are smart enough to skip gaps in the end of rows
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
std::reverse_iterator< iteratorrbegin ()
 
std::reverse_iterator< iteratorrend ()
 
std::reverse_iterator< const_iteratorrbegin () const
 
std::reverse_iterator< const_iteratorrend () const
 
template<typename Functor >
void forEach (const Functor &operation)
 template methods for for operation over all matrix elements.
 
template<typename Functor >
void forEach (const Functor &operation) const
 
void create (int _rows, int _cols)
 equivalent to Mat::create(_rows, _cols, DataType<_Tp>::type)
 
void create (Size _size)
 equivalent to Mat::create(_size, DataType<_Tp>::type)
 
void create (int _ndims, const int *_sizes)
 equivalent to Mat::create(_ndims, _sizes, DatType<_Tp>::type)
 
void release ()
 equivalent to Mat::release()
 
Mat_ cross (const Mat_ &m) const
 cross-product
 
template<typename T2 >
 operator Mat_< T2 > () const
 data type conversion
 
Mat_ row (int y) const
 overridden forms of Mat::row() etc.
 
Mat_ col (int x) const
 
Mat_ diag (int d=0) const
 
Mat_ clone () const CV_NODISCARD
 
size_t elemSize () const
 overridden forms of Mat::elemSize() etc.
 
size_t elemSize1 () const
 
int type () const
 
int depth () const
 
int channels () const
 
size_t step1 (int i=0) const
 
size_t stepT (int i=0) const
 returns step()/sizeof(_Tp)
 
Mat_adjustROI (int dtop, int dbottom, int dleft, int dright)
 some more overridden methods
 
Mat_ operator() (const Range &rowRange, const Range &colRange) const
 
Mat_ operator() (const Rect &roi) const
 
Mat_ operator() (const Range *ranges) const
 
Mat_ operator() (const std::vector< Range > &ranges) const
 
_Tp * operator[] (int y)
 more convenient forms of row and element access operators
 
const _Tp * operator[] (int y) const
 
_Tp & operator() (const int *idx)
 returns reference to the specified element
 
const _Tp & operator() (const int *idx) const
 returns read-only reference to the specified element
 
template<int n>
_Tp & operator() (const Vec< int, n > &idx)
 returns reference to the specified element
 
template<int n>
const _Tp & operator() (const Vec< int, n > &idx) const
 returns read-only reference to the specified element
 
_Tp & operator() (int idx0)
 returns reference to the specified element (1D case)
 
const _Tp & operator() (int idx0) const
 returns read-only reference to the specified element (1D case)
 
_Tp & operator() (int row, int col)
 returns reference to the specified element (2D case)
 
const _Tp & operator() (int row, int col) const
 returns read-only reference to the specified element (2D case)
 
_Tp & operator() (int idx0, int idx1, int idx2)
 returns reference to the specified element (3D case)
 
const _Tp & operator() (int idx0, int idx1, int idx2) const
 returns read-only reference to the specified element (3D case)
 
_Tp & operator() (Point pt)
 
const _Tp & operator() (Point pt) const
 
 operator std::vector< _Tp > () const
 conversion to vector.
 
template<std::size_t _Nm>
 operator std::array< _Tp, _Nm > () const
 conversion to array.
 
template<int n>
 operator Vec< typename DataType< _Tp >::channel_type, n > () const
 conversion to Vec
 
template<int m, int n>
 operator Matx< typename DataType< _Tp >::channel_type, m, n > () const
 conversion to Matx
 
 Mat_ (Mat_ &&m)
 
Mat_operator= (Mat_ &&m)
 
 Mat_ (Mat &&m)
 
Mat_operator= (Mat &&m)
 
 Mat_ (MatExpr &&e)
 
- 基底クラス cv::Mat に属する継承公開メンバ関数
 Mat () CV_NOEXCEPT
 
 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 , typename = typename std::enable_if<std::is_arithmetic<_Tp>::value>::type>
 Mat (const std::initializer_list< _Tp > list)
 
template<typename _Tp >
 Mat (const std::initializer_list< int > sizes, const std::initializer_list< _Tp > list)
 
template<typename _Tp , size_t _Nm>
 Mat (const std::array< _Tp, _Nm > &arr, 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
 
 ~Mat ()
 destructor - calls release()
 
Matoperator= (const Mat &m)
 assignment operators [詳解]
 
Matoperator= (const MatExpr &expr)
 
UMat getUMat (AccessFlag accessFlags, UMatUsageFlags usageFlags=USAGE_DEFAULT) const
 retrieve UMat from Mat
 
Mat row (int y) const
 Creates a matrix header for the specified matrix row. [詳解]
 
Mat col (int x) const
 Creates a matrix header for the specified matrix column. [詳解]
 
Mat rowRange (int startrow, int endrow) const
 Creates a matrix header for the specified row span. [詳解]
 
Mat rowRange (const Range &r) const
 
Mat colRange (int startcol, int endcol) const
 Creates a matrix header for the specified column span. [詳解]
 
Mat colRange (const Range &r) const
 
Mat diag (int d=0) const
 Extracts a diagonal from a matrix [詳解]
 
Mat clone () const CV_NODISCARD
 Creates a full copy of the array and the underlying data. [詳解]
 
void copyTo (OutputArray m) const
 Copies the matrix to another one. [詳解]
 
void copyTo (OutputArray m, InputArray mask) const
 
void convertTo (OutputArray m, int rtype, double alpha=1, double beta=0) const
 Converts an array to another data type with optional scaling. [詳解]
 
void assignTo (Mat &m, int type=-1) const
 Provides a functional form of convertTo. [詳解]
 
Matoperator= (const Scalar &s)
 Sets all or some of the array elements to the specified value. [詳解]
 
MatsetTo (InputArray value, InputArray mask=noArray())
 Sets all or some of the array elements to the specified value. [詳解]
 
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. [詳解]
 
Mat reshape (int cn, int newndims, const int *newsz) const
 
Mat reshape (int cn, const std::vector< int > &newshape) const
 
MatExpr t () const
 Transposes a matrix. [詳解]
 
MatExpr inv (int method=DECOMP_LU) const
 Inverses a matrix. [詳解]
 
MatExpr mul (InputArray m, double scale=1) const
 Performs an element-wise multiplication or division of the two matrices. [詳解]
 
Mat cross (InputArray m) const
 Computes a cross-product of two 3-element vectors. [詳解]
 
double dot (InputArray m) const
 Computes a dot-product of two vectors. [詳解]
 
void create (int rows, int cols, int type)
 Allocates new array data if needed. [詳解]
 
void create (Size size, int type)
 
void create (int ndims, const int *sizes, int type)
 
void create (const std::vector< int > &sizes, int type)
 
void addref ()
 Increments the reference counter. [詳解]
 
void release ()
 Decrements the reference counter and deallocates the matrix if needed. [詳解]
 
void deallocate ()
 internal use function, consider to use 'release' method instead; deallocates the matrix data
 
void copySize (const Mat &m)
 internal use function; properly re-allocates _size, _step arrays
 
void reserve (size_t sz)
 Reserves space for the certain number of rows. [詳解]
 
void reserveBuffer (size_t sz)
 Reserves space for the certain number of bytes. [詳解]
 
void resize (size_t sz)
 Changes the number of matrix rows. [詳解]
 
void resize (size_t sz, const Scalar &s)
 
void push_back_ (const void *elem)
 internal function
 
template<typename _Tp >
void push_back (const _Tp &elem)
 Adds elements to the bottom of the matrix. [詳解]
 
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 pop_back (size_t nelems=1)
 Removes elements from the bottom of the matrix. [詳解]
 
void locateROI (Size &wholeSize, Point &ofs) const
 Locates the matrix header within a parent matrix. [詳解]
 
MatadjustROI (int dtop, int dbottom, int dleft, int dright)
 Adjusts a submatrix size and position within the parent matrix. [詳解]
 
Mat operator() (Range rowRange, Range colRange) const
 Extracts a rectangular submatrix. [詳解]
 
Mat operator() (const Rect &roi) const
 
Mat operator() (const Range *ranges) const
 
Mat operator() (const std::vector< Range > &ranges) const
 
template<typename _Tp >
 operator std::vector< _Tp > () const
 
template<typename _Tp , int n>
 operator Vec< _Tp, n > () const
 
template<typename _Tp , int m, int n>
 operator Matx< _Tp, m, n > () const
 
template<typename _Tp , std::size_t _Nm>
 operator std::array< _Tp, _Nm > () const
 
bool isContinuous () const
 Reports whether the matrix is continuous or not. [詳解]
 
bool isSubmatrix () const
 returns true if the matrix is a submatrix of another matrix
 
size_t elemSize () const
 Returns the matrix element size in bytes. [詳解]
 
size_t elemSize1 () const
 Returns the size of each matrix element channel in bytes. [詳解]
 
int type () const
 Returns the type of a matrix element. [詳解]
 
int depth () const
 Returns the depth of a matrix element. [詳解]
 
int channels () const
 Returns the number of matrix channels. [詳解]
 
size_t step1 (int i=0) const
 Returns a normalized step. [詳解]
 
bool empty () const
 Returns true if the array has no elements. [詳解]
 
size_t total () const
 Returns the total number of array elements. [詳解]
 
size_t total (int startDim, int endDim=INT_MAX) const
 Returns the total number of array elements. [詳解]
 
int checkVector (int elemChannels, int depth=-1, bool requireContinuous=true) const
 
uchar * ptr (int i0=0)
 Returns a pointer to the specified matrix row. [詳解]
 
const uchar * ptr (int i0=0) const
 
uchar * ptr (int row, int col)
 
const uchar * ptr (int row, int col) const
 
uchar * ptr (int i0, int i1, int i2)
 
const uchar * ptr (int i0, int i1, int i2) const
 
uchar * ptr (const int *idx)
 
const uchar * ptr (const int *idx) const
 
template<int n>
uchar * ptr (const Vec< int, n > &idx)
 
template<int n>
const uchar * ptr (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 >
_Tp & at (int i0=0)
 Returns a reference to the specified array element. [詳解]
 
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. [詳解]
 
template<typename _Tp >
MatConstIterator_< _Tp > begin () const
 
template<typename _Tp >
std::reverse_iterator< MatIterator_< _Tp > > rbegin ()
 Same as begin() but for inverse traversal
 
template<typename _Tp >
std::reverse_iterator< MatConstIterator_< _Tp > > rbegin () const
 
template<typename _Tp >
MatIterator_< _Tp > end ()
 Returns the matrix iterator and sets it to the after-last matrix element. [詳解]
 
template<typename _Tp >
MatConstIterator_< _Tp > end () const
 
template<typename _Tp >
std::reverse_iterator< MatIterator_< _Tp > > rend ()
 Same as end() but for inverse traversal
 
template<typename _Tp >
std::reverse_iterator< MatConstIterator_< _Tp > > rend () const
 
template<typename _Tp , typename Functor >
void forEach (const Functor &operation)
 Runs the given functor over all matrix elements in parallel. [詳解]
 
template<typename _Tp , typename Functor >
void forEach (const Functor &operation) const
 
 Mat (Mat &&m)
 
Matoperator= (Mat &&m)
 
void updateContinuityFlag ()
 internal use method: updates the continuity flag
 

静的公開メンバ関数

static MatExpr zeros (int rows, int cols)
 overridden forms of Mat::zeros() etc. Data type is omitted, of course
 
static MatExpr zeros (Size size)
 
static MatExpr zeros (int _ndims, const int *_sizes)
 
static MatExpr ones (int rows, int cols)
 
static MatExpr ones (Size size)
 
static MatExpr ones (int _ndims, const int *_sizes)
 
static MatExpr eye (int rows, int cols)
 
static MatExpr eye (Size size)
 
- 基底クラス cv::Mat に属する継承静的公開メンバ関数
static Mat diag (const Mat &d)
 creates a diagonal matrix [詳解]
 
static MatExpr zeros (int rows, int cols, int type)
 Returns a zero array of the specified size and type. [詳解]
 
static MatExpr zeros (Size size, int type)
 
static MatExpr zeros (int ndims, const int *sz, int type)
 
static MatExpr ones (int rows, int cols, int type)
 Returns an array of all 1's of the specified size and type. [詳解]
 
static MatExpr ones (Size size, int type)
 
static MatExpr ones (int ndims, const int *sz, int type)
 
static MatExpr eye (int rows, int cols, int type)
 Returns an identity matrix of the specified size and type. [詳解]
 
static MatExpr eye (Size size, int type)
 
static MatAllocatorgetStdAllocator ()
 and the standard allocator
 
static MatAllocatorgetDefaultAllocator ()
 
static void setDefaultAllocator (MatAllocator *allocator)
 

その他の継承メンバ

- 基底クラス cv::Mat に属する継承公開変数類
int flags
 
int dims
 the matrix dimensionality, >= 2
 
int rows
 the number of rows and columns or (-1, -1) when the matrix has more than 2 dimensions
 
int cols
 
uchar * data
 pointer to the data
 
const uchar * datastart
 helper fields used in locateROI and adjustROI
 
const uchar * dataend
 
const uchar * datalimit
 
MatAllocatorallocator
 custom allocator
 
UMatDatau
 interaction with UMat
 
MatSize size
 
MatStep step
 
- 基底クラス cv::Mat に属する継承限定公開メンバ関数
template<typename _Tp , typename Functor >
void forEach_impl (const Functor &operation)
 

詳解

template<typename _Tp>
class cv::Mat_< _Tp >

Template matrix class derived from Mat

template<typename _Tp> class Mat_ : public Mat
{
public:
// ... some specific methods
// and
// no new extra fields
};
Mat_() CV_NOEXCEPT
default constructor
Mat() CV_NOEXCEPT

The class Mat_<_Tp> is a thin template wrapper on top of the Mat class. It does not have any extra data fields. Nor this class nor Mat has any virtual methods. Thus, references or pointers to these two classes can be freely but carefully converted one to another. For example:

// create a 100x100 8-bit matrix
Mat M(100,100,CV_8U);
// this will be compiled fine. no any data conversion will be done.
Mat_<float>& M1 = (Mat_<float>&)M;
// the program is likely to crash at the statement below
M1(99,99) = 1.f;

While Mat is sufficient in most cases, Mat_ can be more convenient if you use a lot of element access operations and if you know matrix type at the compilation time. Note that Mat::at(int y,int x) and Mat_::operator()(int y,int x) do absolutely the same and run at the same speed, but the latter is certainly shorter:

Mat_<double> M(20,20);
for(int i = 0; i < M.rows; i++)
for(int j = 0; j < M.cols; j++)
M(i,j) = 1./(i+j+1);
Mat E, V;
eigen(M,E,V);
cout << E.at<double>(0,0)/E.at<double>(M.rows-1,0);
CV_EXPORTS_W bool eigen(InputArray src, OutputArray eigenvalues, OutputArray eigenvectors=noArray())
Calculates eigenvalues and eigenvectors of a symmetric matrix.

To use Mat_ for multi-channel images/matrices, pass Vec as a Mat_ parameter:

// allocate a 320x240 color image and fill it with green (in RGB space)
Mat_<Vec3b> img(240, 320, Vec3b(0,255,0));
// now draw a diagonal white line
for(int i = 0; i < 100; i++)
img(i,i)=Vec3b(255,255,255);
// and now scramble the 2nd (red) channel of each pixel
for(int i = 0; i < img.rows; i++)
for(int j = 0; j < img.cols; j++)
img(i,j)[2] ^= (uchar)(i ^ j);

Mat_ is fully compatible with C++11 range-based for loop. For example such loop can be used to safely apply look-up table:

void applyTable(Mat_<uchar>& I, const uchar* const table)
{
for(auto& pixel : I)
{
pixel = table[pixel];
}
}

このクラス詳解は次のファイルから抽出されました: