This type is very similar to InputArray except that it is used for input/output and output function parameters. More...

#include "mat.hpp"

Inheritance diagram for cv::_OutputArray:

Collaboration diagram for cv::_OutputArray:

Public Types
enum	{ 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 }

enum	{ 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_ALL = (DEPTH_MASK_64F<<1)-1, DEPTH_MASK_ALL_BUT_8S = DEPTH_MASK_ALL & ~DEPTH_MASK_8S, DEPTH_MASK_FLT = DEPTH_MASK_32F + DEPTH_MASK_64F }

Public Member Functions
	_OutputArray ()

	_OutputArray (int _flags, void *_obj)

	_OutputArray (Mat &m)

	_OutputArray (std::vector< Mat > &vec)

	_OutputArray (cuda::GpuMat &d_mat)

	_OutputArray (std::vector< cuda::GpuMat > &d_mat)

	_OutputArray (ogl::Buffer &buf)

	_OutputArray (cuda::HostMem &cuda_mem)

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

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

	_OutputArray (std::vector< bool > &vec)

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

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

template<typename _Tp >
	_OutputArray (Mat_< _Tp > &m)

template<typename _Tp >
	_OutputArray (_Tp *vec, int n)

template<typename _Tp , int m, int n>
	_OutputArray (Matx< _Tp, m, n > &matx)

	_OutputArray (UMat &m)

	_OutputArray (std::vector< UMat > &vec)

	_OutputArray (const Mat &m)

	_OutputArray (const std::vector< Mat > &vec)

	_OutputArray (const cuda::GpuMat &d_mat)

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

	_OutputArray (const ogl::Buffer &buf)

	_OutputArray (const cuda::HostMem &cuda_mem)

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

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

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

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

template<typename _Tp >
	_OutputArray (const Mat_< _Tp > &m)

template<typename _Tp >
	_OutputArray (const _Tp *vec, int n)

template<typename _Tp , int m, int n>
	_OutputArray (const Matx< _Tp, m, n > &matx)

	_OutputArray (const UMat &m)

	_OutputArray (const std::vector< UMat > &vec)

void	assign (const UMat &u) const

void	assign (const Mat &m) 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, int fixedDepthMask=0) const

void	create (int rows, int cols, int type, int i=-1, bool allowTransposed=false, int fixedDepthMask=0) const

void	create (int dims, const int *size, int type, int i=-1, bool allowTransposed=false, int fixedDepthMask=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	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

int	kind () const

bool	needed () const

size_t	offset (int i=-1) const

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

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

Detailed Description

This type is very similar to InputArray except that it is used for input/output and output function parameters.

Just like with InputArray, OpenCV users should not care about OutputArray, they just pass Mat, vector<T> etc. to the functions. The same limitation as for InputArray: Do not explicitly create OutputArray instances applies here too.

If you want to make your function polymorphic (i.e. accept different arrays as output parameters), it is also not very difficult. Take the sample above as the reference. Note that _OutputArray::create() needs to be called before _OutputArray::getMat(). This way you guarantee that the output array is properly allocated.

Optional output parameters. If you do not need certain output array to be computed and returned to you, pass cv::noArray(), just like you would in the case of optional input array. At the implementation level, use _OutputArray::needed() to check if certain output array needs to be computed or not.

There are several synonyms for OutputArray that are used to assist automatic Python/Java/... wrapper generators:

typedef OutputArray OutputArrayOfArrays;
typedef OutputArray InputOutputArray;
typedef OutputArray InputOutputArrayOfArrays;

Member Enumeration Documentation

anonymous enum

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

anonymous enum

Enumerator
DEPTH_MASK_8U
DEPTH_MASK_8S
DEPTH_MASK_16U
DEPTH_MASK_16S
DEPTH_MASK_32S
DEPTH_MASK_32F
DEPTH_MASK_64F
DEPTH_MASK_ALL
DEPTH_MASK_ALL_BUT_8S
DEPTH_MASK_FLT

Constructor & Destructor Documentation

cv::_OutputArray::_OutputArray ( )

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

cv::_OutputArray::_OutputArray ( Mat & m )

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

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

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

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

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

template<typename _Tp >

cv::_OutputArray::_OutputArray ( cudev::GpuMat_< _Tp > & m )

template<typename _Tp >

cv::_OutputArray::_OutputArray ( std::vector< _Tp > & vec )

cv::_OutputArray::_OutputArray ( std::vector< bool > & vec )

template<typename _Tp >

cv::_OutputArray::_OutputArray ( std::vector< std::vector< _Tp > > & vec )

template<typename _Tp >

cv::_OutputArray::_OutputArray ( std::vector< Mat_< _Tp > > & vec )

template<typename _Tp >

cv::_OutputArray::_OutputArray ( Mat_< _Tp > & m )

template<typename _Tp >

cv::_OutputArray::_OutputArray	(	_Tp *	vec,
		int	n
	)

template<typename _Tp , int m, int n>

cv::_OutputArray::_OutputArray ( Matx< _Tp, m, n > & matx )

cv::_OutputArray::_OutputArray ( UMat & m )

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

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

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

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

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

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

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

template<typename _Tp >

cv::_OutputArray::_OutputArray ( const cudev::GpuMat_< _Tp > & m )

template<typename _Tp >

cv::_OutputArray::_OutputArray ( const std::vector< _Tp > & vec )

template<typename _Tp >

cv::_OutputArray::_OutputArray ( const std::vector< std::vector< _Tp > > & vec )

template<typename _Tp >

cv::_OutputArray::_OutputArray ( const std::vector< Mat_< _Tp > > & vec )

template<typename _Tp >

cv::_OutputArray::_OutputArray ( const Mat_< _Tp > & m )

template<typename _Tp >

cv::_OutputArray::_OutputArray	(	const _Tp *	vec,
		int	n
	)

template<typename _Tp , int m, int n>

cv::_OutputArray::_OutputArray ( const Matx< _Tp, m, n > & matx )

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

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

Member Function Documentation

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

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

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

inherited

void cv::_OutputArray::clear ( ) const

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

inherited

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

inherited

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

inherited

void cv::_OutputArray::create	(	Size	sz,
		int	type,
		int	i = `-1`,
		bool	allowTransposed = `false`,
		int	fixedDepthMask = `0`
	)		const

void cv::_OutputArray::create	(	int	rows,
		int	cols,
		int	type,
		int	i = `-1`,
		bool	allowTransposed = `false`,
		int	fixedDepthMask = `0`
	)		const

void cv::_OutputArray::create	(	int	dims,
		const int *	size,
		int	type,
		int	i = `-1`,
		bool	allowTransposed = `false`,
		int	fixedDepthMask = `0`
	)		const

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

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

inherited

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

inherited

bool cv::_InputArray::empty ( ) const

inherited

bool cv::_OutputArray::fixedSize ( ) const

bool cv::_OutputArray::fixedType ( ) const

int cv::_InputArray::getFlags ( ) const

inherited

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

inherited

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

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

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

inherited

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

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

inherited

Examples:: pca.cpp.

Referenced by cv::AGAST(), cv::AGAST_5_8(), cv::AGAST_7_12d(), cv::AGAST_7_12s(), cv::AgastFeatureDetector_Impl::detect(), and cv::OAST_9_16().

Here is the caller graph for this function:

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

inherited

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

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

inherited

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

inherited

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

inherited

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

Size cv::_InputArray::getSz ( ) const

inherited

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

inherited

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

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

inherited

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

protectedinherited

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

protectedinherited

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

inherited

bool cv::_InputArray::isGpuMatVector ( ) const

inherited

bool cv::_InputArray::isMat ( ) const

inherited

bool cv::_InputArray::isMatVector ( ) const

inherited

bool cv::_InputArray::isMatx ( ) const

inherited

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

inherited

bool cv::_InputArray::isUMat ( ) const

inherited

Referenced by cv::AgastFeatureDetector_Impl::detect().

Here is the caller graph for this function:

bool cv::_InputArray::isUMatVector ( ) const

inherited

bool cv::_InputArray::isVector ( ) const

inherited

int cv::_InputArray::kind ( ) const

inherited

bool cv::_OutputArray::needed ( ) const

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

inherited

void cv::_OutputArray::release ( ) const

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

inherited

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

inherited

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

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

inherited

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

inherited

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

inherited

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

inherited

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

inherited

Referenced by cv::AgastFeatureDetector_Impl::detect().

Here is the caller graph for this function:

Member Data Documentation

int cv::_InputArray::flags

protectedinherited

void* cv::_InputArray::obj

protectedinherited

Size cv::_InputArray::sz

protectedinherited

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

core/include/opencv2/core/mat.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation