OpenCV  4.1.1-pre
Open Source Computer Vision
Looking for a C++ dev who knows OpenCV?
I'm looking for work. Hire me!
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cv::_InputOutputArray Class Reference
Core functionality » Basic structures

#include <opencv2/core/mat.hpp>

Inheritance diagram for cv::_InputOutputArray:
Inheritance graph
[legend]
Collaboration diagram for cv::_InputOutputArray:
Collaboration graph
[legend]

Public Types

enum  DepthMask {
  DEPTH_MASK_8U = 1 << CV_8U,
  DEPTH_MASK_8S = 1 << CV_8S,
  DEPTH_MASK_16U = 1 << CV_16U,
  DEPTH_MASK_16S = 1 << CV_16S,
  DEPTH_MASK_32S = 1 << CV_32S,
  DEPTH_MASK_32F = 1 << CV_32F,
  DEPTH_MASK_64F = 1 << CV_64F,
  DEPTH_MASK_16F = 1 << CV_16F,
  DEPTH_MASK_ALL = (DEPTH_MASK_64F<<1)-1,
  DEPTH_MASK_ALL_BUT_8S = DEPTH_MASK_ALL & ~DEPTH_MASK_8S,
  DEPTH_MASK_ALL_16F = (DEPTH_MASK_16F<<1)-1,
  DEPTH_MASK_FLT = DEPTH_MASK_32F + DEPTH_MASK_64F
}
 
enum  KindFlag {
  KIND_SHIFT = 16,
  FIXED_TYPE = 0x8000 << KIND_SHIFT,
  FIXED_SIZE = 0x4000 << KIND_SHIFT,
  KIND_MASK = 31 << KIND_SHIFT,
  NONE = 0 << KIND_SHIFT,
  MAT = 1 << KIND_SHIFT,
  MATX = 2 << KIND_SHIFT,
  STD_VECTOR = 3 << KIND_SHIFT,
  STD_VECTOR_VECTOR = 4 << KIND_SHIFT,
  STD_VECTOR_MAT = 5 << KIND_SHIFT,
  EXPR = 6 << KIND_SHIFT,
  OPENGL_BUFFER = 7 << KIND_SHIFT,
  CUDA_HOST_MEM = 8 << KIND_SHIFT,
  CUDA_GPU_MAT = 9 << KIND_SHIFT,
  UMAT =10 << KIND_SHIFT,
  STD_VECTOR_UMAT =11 << KIND_SHIFT,
  STD_BOOL_VECTOR =12 << KIND_SHIFT,
  STD_VECTOR_CUDA_GPU_MAT = 13 << KIND_SHIFT,
  STD_ARRAY =14 << KIND_SHIFT,
  STD_ARRAY_MAT =15 << KIND_SHIFT
}
 

Public Member Functions

 _InputOutputArray ()
 
 _InputOutputArray (int _flags, void *_obj)
 
 _InputOutputArray (Mat &m)
 
 _InputOutputArray (std::vector< Mat > &vec)
 
 _InputOutputArray (cuda::GpuMat &d_mat)
 
 _InputOutputArray (ogl::Buffer &buf)
 
 _InputOutputArray (cuda::HostMem &cuda_mem)
 
template<typename _Tp >
 _InputOutputArray (cudev::GpuMat_< _Tp > &m)
 
template<typename _Tp >
 _InputOutputArray (std::vector< _Tp > &vec)
 
 _InputOutputArray (std::vector< bool > &vec)=delete
 
template<typename _Tp >
 _InputOutputArray (std::vector< std::vector< _Tp > > &vec)
 
template<typename _Tp >
 _InputOutputArray (std::vector< Mat_< _Tp > > &vec)
 
template<typename _Tp >
 _InputOutputArray (Mat_< _Tp > &m)
 
template<typename _Tp >
 _InputOutputArray (_Tp *vec, int n)
 
template<typename _Tp , int m, int n>
 _InputOutputArray (Matx< _Tp, m, n > &matx)
 
 _InputOutputArray (UMat &m)
 
 _InputOutputArray (std::vector< UMat > &vec)
 
 _InputOutputArray (const Mat &m)
 
 _InputOutputArray (const std::vector< Mat > &vec)
 
 _InputOutputArray (const cuda::GpuMat &d_mat)
 
 _InputOutputArray (const std::vector< cuda::GpuMat > &d_mat)
 
 _InputOutputArray (const ogl::Buffer &buf)
 
 _InputOutputArray (const cuda::HostMem &cuda_mem)
 
template<typename _Tp >
 _InputOutputArray (const cudev::GpuMat_< _Tp > &m)
 
template<typename _Tp >
 _InputOutputArray (const std::vector< _Tp > &vec)
 
template<typename _Tp >
 _InputOutputArray (const std::vector< std::vector< _Tp > > &vec)
 
template<typename _Tp >
 _InputOutputArray (const std::vector< Mat_< _Tp > > &vec)
 
template<typename _Tp >
 _InputOutputArray (const Mat_< _Tp > &m)
 
template<typename _Tp >
 _InputOutputArray (const _Tp *vec, int n)
 
template<typename _Tp , int m, int n>
 _InputOutputArray (const Matx< _Tp, m, n > &matx)
 
 _InputOutputArray (const UMat &m)
 
 _InputOutputArray (const std::vector< UMat > &vec)
 
template<typename _Tp , std::size_t _Nm>
 _InputOutputArray (std::array< _Tp, _Nm > &arr)
 
template<typename _Tp , std::size_t _Nm>
 _InputOutputArray (const std::array< _Tp, _Nm > &arr)
 
template<std::size_t _Nm>
 _InputOutputArray (std::array< Mat, _Nm > &arr)
 
template<std::size_t _Nm>
 _InputOutputArray (const std::array< Mat, _Nm > &arr)
 
void assign (const UMat &u) const
 
void assign (const Mat &m) const
 
void assign (const std::vector< UMat > &v) const
 
void assign (const std::vector< Mat > &v) const
 
int channels (int i=-1) const
 
void clear () const
 
int cols (int i=-1) const
 
void copyTo (const _OutputArray &arr) const
 
void copyTo (const _OutputArray &arr, const _InputArray &mask) const
 
void create (Size sz, int type, int i=-1, bool allowTransposed=false, _OutputArray::DepthMask fixedDepthMask=static_cast< _OutputArray::DepthMask >(0)) const
 
void create (int rows, int cols, int type, int i=-1, bool allowTransposed=false, _OutputArray::DepthMask fixedDepthMask=static_cast< _OutputArray::DepthMask >(0)) const
 
void create (int dims, const int *size, int type, int i=-1, bool allowTransposed=false, _OutputArray::DepthMask fixedDepthMask=static_cast< _OutputArray::DepthMask >(0)) const
 
void createSameSize (const _InputArray &arr, int mtype) const
 
int depth (int i=-1) const
 
int dims (int i=-1) const
 
bool empty () const
 
bool fixedSize () const
 
bool fixedType () const
 
int getFlags () const
 
cuda::GpuMat getGpuMat () const
 
cuda::GpuMat & getGpuMatRef () const
 
std::vector< cuda::GpuMat > & getGpuMatVecRef () const
 
void getGpuMatVector (std::vector< cuda::GpuMat > &gpumv) const
 
cuda::HostMem & getHostMemRef () const
 
Mat getMat (int idx=-1) const
 
Mat getMat_ (int idx=-1) const
 
Mat & getMatRef (int i=-1) const
 
void getMatVector (std::vector< Mat > &mv) const
 
void * getObj () const
 
ogl::Buffer getOGlBuffer () const
 
ogl::Buffer & getOGlBufferRef () const
 
Size getSz () const
 
UMat getUMat (int idx=-1) const
 
UMat & getUMatRef (int i=-1) const
 
void getUMatVector (std::vector< UMat > &umv) const
 
bool isContinuous (int i=-1) const
 
bool isGpuMat () const
 
bool isGpuMatVector () const
 
bool isMat () const
 
bool isMatVector () const
 
bool isMatx () const
 
bool isSubmatrix (int i=-1) const
 
bool isUMat () const
 
bool isUMatVector () const
 
bool isVector () const
 
_InputArray::KindFlag kind () const
 
void move (UMat &u) const
 
void move (Mat &m) const
 
bool needed () const
 
size_t offset (int i=-1) const
 
template<typename _Tp , std::size_t _Nm>
_InputOutputArray rawInOut (std::array< _Tp, _Nm > &arr)
 
void release () const
 
int rows (int i=-1) const
 
bool sameSize (const _InputArray &arr) const
 
void setTo (const _InputArray &value, const _InputArray &mask=_InputArray()) const
 
Size size (int i=-1) const
 
int sizend (int *sz, int i=-1) const
 
size_t step (int i=-1) const
 
size_t total (int i=-1) const
 
int type (int i=-1) const
 

Static Public Member Functions

template<typename _Tp >
static _InputArray rawIn (const std::vector< _Tp > &vec)
 
template<typename _Tp , std::size_t _Nm>
static _InputArray rawIn (const std::array< _Tp, _Nm > &arr)
 
template<typename _Tp >
static _InputOutputArray rawInOut (std::vector< _Tp > &vec)
 
template<typename _Tp >
static _OutputArray rawOut (std::vector< _Tp > &vec)
 
template<typename _Tp , std::size_t _Nm>
static _OutputArray rawOut (std::array< _Tp, _Nm > &arr)
 

Protected Member Functions

void init (int _flags, const void *_obj)
 
void init (int _flags, const void *_obj, Size _sz)
 

Protected Attributes

int flags
 
void * obj
 
Size sz
 

Member Enumeration Documentation

◆ DepthMask

enum cv::_OutputArray::DepthMask
inherited
Enumerator
DEPTH_MASK_8U 
DEPTH_MASK_8S 
DEPTH_MASK_16U 
DEPTH_MASK_16S 
DEPTH_MASK_32S 
DEPTH_MASK_32F 
DEPTH_MASK_64F 
DEPTH_MASK_16F 
DEPTH_MASK_ALL 
DEPTH_MASK_ALL_BUT_8S 
DEPTH_MASK_ALL_16F 
DEPTH_MASK_FLT 

◆ KindFlag

enum cv::_InputArray::KindFlag
inherited
Enumerator
KIND_SHIFT 
FIXED_TYPE 
FIXED_SIZE 
KIND_MASK 
NONE 
MAT 
MATX 
STD_VECTOR 
STD_VECTOR_VECTOR 
STD_VECTOR_MAT 
EXPR 
OPENGL_BUFFER 
CUDA_HOST_MEM 
CUDA_GPU_MAT 
UMAT 
STD_VECTOR_UMAT 
STD_BOOL_VECTOR 
STD_VECTOR_CUDA_GPU_MAT 
STD_ARRAY 
STD_ARRAY_MAT 

Constructor & Destructor Documentation

◆ _InputOutputArray() [1/36]

cv::_InputOutputArray::_InputOutputArray ( )

◆ _InputOutputArray() [2/36]

cv::_InputOutputArray::_InputOutputArray ( int  _flags,
void *  _obj 
)

◆ _InputOutputArray() [3/36]

cv::_InputOutputArray::_InputOutputArray ( Mat &  m)

◆ _InputOutputArray() [4/36]

cv::_InputOutputArray::_InputOutputArray ( std::vector< Mat > &  vec)

◆ _InputOutputArray() [5/36]

cv::_InputOutputArray::_InputOutputArray ( cuda::GpuMat &  d_mat)

◆ _InputOutputArray() [6/36]

cv::_InputOutputArray::_InputOutputArray ( ogl::Buffer &  buf)

◆ _InputOutputArray() [7/36]

cv::_InputOutputArray::_InputOutputArray ( cuda::HostMem &  cuda_mem)

◆ _InputOutputArray() [8/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( cudev::GpuMat_< _Tp > &  m)

◆ _InputOutputArray() [9/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( std::vector< _Tp > &  vec)

◆ _InputOutputArray() [10/36]

cv::_InputOutputArray::_InputOutputArray ( std::vector< bool > &  vec)
delete

◆ _InputOutputArray() [11/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( std::vector< std::vector< _Tp > > &  vec)

◆ _InputOutputArray() [12/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( std::vector< Mat_< _Tp > > &  vec)

◆ _InputOutputArray() [13/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( Mat_< _Tp > &  m)

◆ _InputOutputArray() [14/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( _Tp *  vec,
int  n 
)

◆ _InputOutputArray() [15/36]

template<typename _Tp , int m, int n>
cv::_InputOutputArray::_InputOutputArray ( Matx< _Tp, m, n > &  matx)

◆ _InputOutputArray() [16/36]

cv::_InputOutputArray::_InputOutputArray ( UMat &  m)

◆ _InputOutputArray() [17/36]

cv::_InputOutputArray::_InputOutputArray ( std::vector< UMat > &  vec)

◆ _InputOutputArray() [18/36]

cv::_InputOutputArray::_InputOutputArray ( const Mat &  m)

◆ _InputOutputArray() [19/36]

cv::_InputOutputArray::_InputOutputArray ( const std::vector< Mat > &  vec)

◆ _InputOutputArray() [20/36]

cv::_InputOutputArray::_InputOutputArray ( const cuda::GpuMat &  d_mat)

◆ _InputOutputArray() [21/36]

cv::_InputOutputArray::_InputOutputArray ( const std::vector< cuda::GpuMat > &  d_mat)

◆ _InputOutputArray() [22/36]

cv::_InputOutputArray::_InputOutputArray ( const ogl::Buffer &  buf)

◆ _InputOutputArray() [23/36]

cv::_InputOutputArray::_InputOutputArray ( const cuda::HostMem &  cuda_mem)

◆ _InputOutputArray() [24/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( const cudev::GpuMat_< _Tp > &  m)

◆ _InputOutputArray() [25/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( const std::vector< _Tp > &  vec)

◆ _InputOutputArray() [26/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( const std::vector< std::vector< _Tp > > &  vec)

◆ _InputOutputArray() [27/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( const std::vector< Mat_< _Tp > > &  vec)

◆ _InputOutputArray() [28/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( const Mat_< _Tp > &  m)

◆ _InputOutputArray() [29/36]

template<typename _Tp >
cv::_InputOutputArray::_InputOutputArray ( const _Tp *  vec,
int  n 
)

◆ _InputOutputArray() [30/36]

template<typename _Tp , int m, int n>
cv::_InputOutputArray::_InputOutputArray ( const Matx< _Tp, m, n > &  matx)

◆ _InputOutputArray() [31/36]

cv::_InputOutputArray::_InputOutputArray ( const UMat &  m)

◆ _InputOutputArray() [32/36]

cv::_InputOutputArray::_InputOutputArray ( const std::vector< UMat > &  vec)

◆ _InputOutputArray() [33/36]

template<typename _Tp , std::size_t _Nm>
cv::_InputOutputArray::_InputOutputArray ( std::array< _Tp, _Nm > &  arr)

◆ _InputOutputArray() [34/36]

template<typename _Tp , std::size_t _Nm>
cv::_InputOutputArray::_InputOutputArray ( const std::array< _Tp, _Nm > &  arr)

◆ _InputOutputArray() [35/36]

template<std::size_t _Nm>
cv::_InputOutputArray::_InputOutputArray ( std::array< Mat, _Nm > &  arr)

◆ _InputOutputArray() [36/36]

template<std::size_t _Nm>
cv::_InputOutputArray::_InputOutputArray ( const std::array< Mat, _Nm > &  arr)

Member Function Documentation

◆ assign() [1/4]

void cv::_OutputArray::assign ( const UMat &  u) const
inherited

◆ assign() [2/4]

void cv::_OutputArray::assign ( const Mat &  m) const
inherited

◆ assign() [3/4]

void cv::_OutputArray::assign ( const std::vector< UMat > &  v) const
inherited

◆ assign() [4/4]

void cv::_OutputArray::assign ( const std::vector< Mat > &  v) const
inherited

◆ channels()

int cv::_InputArray::channels ( int  i = -1) const
inherited

◆ clear()

void cv::_OutputArray::clear ( ) const
inherited

◆ cols()

int cv::_InputArray::cols ( int  i = -1) const
inherited

◆ copyTo() [1/2]

void cv::_InputArray::copyTo ( const _OutputArray &  arr) const
inherited

◆ copyTo() [2/2]

void cv::_InputArray::copyTo ( const _OutputArray &  arr,
const _InputArray &  mask 
) const
inherited

◆ create() [1/3]

void cv::_OutputArray::create ( Size  sz,
int  type,
int  i = -1,
bool  allowTransposed = false,
_OutputArray::DepthMask  fixedDepthMask = static_cast< _OutputArray::DepthMask >(0) 
) const
inherited

◆ create() [2/3]

void cv::_OutputArray::create ( int  rows,
int  cols,
int  type,
int  i = -1,
bool  allowTransposed = false,
_OutputArray::DepthMask  fixedDepthMask = static_cast< _OutputArray::DepthMask >(0) 
) const
inherited

◆ create() [3/3]

void cv::_OutputArray::create ( int  dims,
const int *  size,
int  type,
int  i = -1,
bool  allowTransposed = false,
_OutputArray::DepthMask  fixedDepthMask = static_cast< _OutputArray::DepthMask >(0) 
) const
inherited

◆ createSameSize()

void cv::_OutputArray::createSameSize ( const _InputArray &  arr,
int  mtype 
) const
inherited

◆ depth()

int cv::_InputArray::depth ( int  i = -1) const
inherited

◆ dims()

int cv::_InputArray::dims ( int  i = -1) const
inherited

◆ empty()

bool cv::_InputArray::empty ( ) const
inherited

◆ fixedSize()

bool cv::_OutputArray::fixedSize ( ) const
inherited

◆ fixedType()

bool cv::_OutputArray::fixedType ( ) const
inherited

◆ getFlags()

int cv::_InputArray::getFlags ( ) const
inherited

◆ getGpuMat()

cuda::GpuMat cv::_InputArray::getGpuMat ( ) const
inherited

◆ getGpuMatRef()

cuda::GpuMat& cv::_OutputArray::getGpuMatRef ( ) const
inherited

◆ getGpuMatVecRef()

std::vector<cuda::GpuMat>& cv::_OutputArray::getGpuMatVecRef ( ) const
inherited

◆ getGpuMatVector()

void cv::_InputArray::getGpuMatVector ( std::vector< cuda::GpuMat > &  gpumv) const
inherited

◆ getHostMemRef()

cuda::HostMem& cv::_OutputArray::getHostMemRef ( ) const
inherited

◆ getMat()

Mat cv::_InputArray::getMat ( int  idx = -1) const
inherited
Examples:
samples/cpp/pca.cpp.

◆ getMat_()

Mat cv::_InputArray::getMat_ ( int  idx = -1) const
inherited

◆ getMatRef()

Mat& cv::_OutputArray::getMatRef ( int  i = -1) const
inherited

◆ getMatVector()

void cv::_InputArray::getMatVector ( std::vector< Mat > &  mv) const
inherited

◆ getObj()

void* cv::_InputArray::getObj ( ) const
inherited

◆ getOGlBuffer()

ogl::Buffer cv::_InputArray::getOGlBuffer ( ) const
inherited

◆ getOGlBufferRef()

ogl::Buffer& cv::_OutputArray::getOGlBufferRef ( ) const
inherited

◆ getSz()

Size cv::_InputArray::getSz ( ) const
inherited

◆ getUMat()

UMat cv::_InputArray::getUMat ( int  idx = -1) const
inherited

◆ getUMatRef()

UMat& cv::_OutputArray::getUMatRef ( int  i = -1) const
inherited

◆ getUMatVector()

void cv::_InputArray::getUMatVector ( std::vector< UMat > &  umv) const
inherited

◆ init() [1/2]

void cv::_InputArray::init ( int  _flags,
const void *  _obj 
)
protectedinherited

◆ init() [2/2]

void cv::_InputArray::init ( int  _flags,
const void *  _obj,
Size  _sz 
)
protectedinherited

◆ isContinuous()

bool cv::_InputArray::isContinuous ( int  i = -1) const
inherited

◆ isGpuMat()

bool cv::_InputArray::isGpuMat ( ) const
inherited

◆ isGpuMatVector()

bool cv::_InputArray::isGpuMatVector ( ) const
inherited

◆ isMat()

bool cv::_InputArray::isMat ( ) const
inherited

◆ isMatVector()

bool cv::_InputArray::isMatVector ( ) const
inherited

◆ isMatx()

bool cv::_InputArray::isMatx ( ) const
inherited

◆ isSubmatrix()

bool cv::_InputArray::isSubmatrix ( int  i = -1) const
inherited

◆ isUMat()

bool cv::_InputArray::isUMat ( ) const
inherited

◆ isUMatVector()

bool cv::_InputArray::isUMatVector ( ) const
inherited

◆ isVector()

bool cv::_InputArray::isVector ( ) const
inherited

◆ kind()

_InputArray::KindFlag cv::_InputArray::kind ( ) const
inherited

◆ move() [1/2]

void cv::_OutputArray::move ( UMat &  u) const
inherited

◆ move() [2/2]

void cv::_OutputArray::move ( Mat &  m) const
inherited

◆ needed()

bool cv::_OutputArray::needed ( ) const
inherited

◆ offset()

size_t cv::_InputArray::offset ( int  i = -1) const
inherited

◆ rawIn() [1/2]

template<typename _Tp >
static _InputArray cv::_InputArray::rawIn ( const std::vector< _Tp > &  vec)
staticinherited

◆ rawIn() [2/2]

template<typename _Tp , std::size_t _Nm>
static _InputArray cv::_InputArray::rawIn ( const std::array< _Tp, _Nm > &  arr)
staticinherited

◆ rawInOut() [1/2]

template<typename _Tp >
static _InputOutputArray cv::_InputOutputArray::rawInOut ( std::vector< _Tp > &  vec)
static

◆ rawInOut() [2/2]

template<typename _Tp , std::size_t _Nm>
_InputOutputArray cv::_InputOutputArray::rawInOut ( std::array< _Tp, _Nm > &  arr)

◆ rawOut() [1/2]

template<typename _Tp >
static _OutputArray cv::_OutputArray::rawOut ( std::vector< _Tp > &  vec)
staticinherited

◆ rawOut() [2/2]

template<typename _Tp , std::size_t _Nm>
static _OutputArray cv::_OutputArray::rawOut ( std::array< _Tp, _Nm > &  arr)
staticinherited

◆ release()

void cv::_OutputArray::release ( ) const
inherited

◆ rows()

int cv::_InputArray::rows ( int  i = -1) const
inherited

◆ sameSize()

bool cv::_InputArray::sameSize ( const _InputArray &  arr) const
inherited

◆ setTo()

void cv::_OutputArray::setTo ( const _InputArray &  value,
const _InputArray &  mask = _InputArray() 
) const
inherited

◆ size()

Size cv::_InputArray::size ( int  i = -1) const
inherited

◆ sizend()

int cv::_InputArray::sizend ( int *  sz,
int  i = -1 
) const
inherited

◆ step()

size_t cv::_InputArray::step ( int  i = -1) const
inherited

◆ total()

size_t cv::_InputArray::total ( int  i = -1) const
inherited

◆ type()

int cv::_InputArray::type ( int  i = -1) const
inherited

Member Data Documentation

◆ flags

int cv::_InputArray::flags
protectedinherited

◆ obj

void* cv::_InputArray::obj
protectedinherited

◆ sz

Size cv::_InputArray::sz
protectedinherited
The documentation for this class was generated from the following file: