cv::_InputArray 类参考

这是用于将只读输入数组传递给 OpenCV 函数的代理类。 更多...

#include <opencv2/core/mat.hpp>

cv::_InputArray 的协作图

公开类型
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 ,   CUDA_GPU_MATND =16 << KIND_SHIFT }

公开成员函数
	_InputArray ()
template<typename _Tp >
	_InputArray (const _Tp *vec, int n)
	_InputArray (const cuda::GpuMat &d_mat)
	_InputArray (const cuda::GpuMatND &d_mat)
	_InputArray (const cuda::HostMem &cuda_mem)
template<typename _Tp >
	_InputArray (const cudev::GpuMat_< _Tp > &m)
	_InputArray (const double &val)
	_InputArray (const Mat &m)
template<typename _Tp >
	_InputArray (const Mat_< _Tp > &m)
	_InputArray (const MatExpr &expr)
template<typename _Tp , int m, int n>
	_InputArray (const Matx< _Tp, m, n > &matx)
	_InputArray (const ogl::Buffer &buf)
template<typename _Tp , std::size_t _Nm>
	_InputArray (const std::array< _Tp, _Nm > &arr)
template<std::size_t _Nm>
	_InputArray (const std::array< Mat, _Nm > &arr)
template<typename _Tp >
	_InputArray (const std::vector< _Tp > &vec)
	_InputArray (const std::vector< bool > &vec)
	_InputArray (const std::vector< cuda::GpuMat > &d_mat_array)
	_InputArray (const std::vector< Mat > &vec)
template<typename _Tp >
	_InputArray (const std::vector< Mat_< _Tp > > &vec)
template<typename _Tp >
	_InputArray (const std::vector< std::vector< _Tp > > &vec)
	_InputArray (const std::vector< std::vector< bool > > &)=delete
	_InputArray (const std::vector< UMat > &umv)
	_InputArray (const UMat &um)
	_InputArray (int _flags, void *_obj)
	~_InputArray ()
int	channels (int i=-1) const
int	cols (int i=-1) const
void	copyTo (const _OutputArray &arr) const
void	copyTo (const _OutputArray &arr, const _InputArray &mask) const
int	depth (int i=-1) const
int	dims (int i=-1) const
bool	empty () const
bool	empty (int i) const
int	getFlags () const
cuda::GpuMat	getGpuMat () const
cuda::GpuMatND	getGpuMatND () const
void	getGpuMatVector (std::vector< cuda::GpuMat > &gpumv) const
Mat	getMat (int idx=-1) const
Mat	getMat_ (int idx=-1) const
void	getMatVector (std::vector< Mat > &mv) const
void *	getObj () const
ogl::Buffer	getOGlBuffer () const
Size	getSz () const
UMat	getUMat (int idx=-1) const
void	getUMatVector (std::vector< UMat > &umv) const
bool	isContinuous (int i=-1) const
bool	isGpuMat () const
bool	isGpuMatND () 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
size_t	offset (int i=-1) const
int	rows (int i=-1) const
bool	sameSize (const _InputArray &arr) 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

静态公开成员函数
template<typename _Tp , std::size_t _Nm>
static _InputArray	rawIn (const std::array< _Tp, _Nm > &arr)
template<typename _Tp >
static _InputArray	rawIn (const std::vector< _Tp > &vec)

保护成员函数
void	init (int _flags, const void *_obj)
void	init (int _flags, const void *_obj, Size _sz)

保护属性
int	flags (标志)
void *	obj
Size	sz

详细说明

这是用于将只读输入数组传递给 OpenCV 函数的代理类。

它的定义是：

typedef const _InputArray& InputArray;

其中 cv::_InputArray 是一个可以由 cv::Mat, cv::Mat_<T>, cv::Matx<T, m, n>, std::vector<T>, std::vector<std::vector<T>>, std::vector<Mat>, std::vector<Mat_<T>>, cv::UMat, std::vector<UMat> 或 double 构造的类。它也可以由矩阵表达式构造。

由于这主要是实现级别的类，并且其接口可能会在未来版本中更改，我们不详细描述它。但是，有一些关键点需要牢记：

• 当您在参考手册或 OpenCV 源代码中看到一个接受 InputArray 的函数时，这意味着您实际上可以传递 Mat, Matx, vector<T> 等（请参阅上面的完整列表）。
• 可选输入参数：如果某些输入数组可能为空，请传递 cv::noArray() （或者像以前一样简单地传递 cv::Mat()）。
• 该类专门用于传递参数。也就是说，通常您 不应该 声明此类别的类成员、局部变量和全局变量。
• 如果您想设计一个可以操作多种类型数组的函数或类方法，可以将 InputArray (或 OutputArray) 用于相应的参数。在函数内部，您应该使用 _InputArray::getMat() 方法为数组构造一个矩阵头（不复制数据）。 _InputArray::kind() 可以用于区分 Mat 与 vector<> 等，但通常不需要。

下面是如何使用接受 InputArray 的函数：

std::vector<Point2f> vec;
// 圆点
for( int i = 0; i < 30; i++ )
vec.push_back(Point2f((float)(100 + 30*cos(i*CV_PI*2/5)),
(float)(100 - 30*sin(i*CV_PI*2/5))));
cv::transform(vec, vec, cv::Matx23f(0.707, -0.707, 10, 0.707, 0.707, 20));

也就是说，我们构造一个包含点的 STL 向量，并使用内联创建的 2x3 矩阵 Matx<float, 2, 3> 实例对向量应用就地仿射变换。

下面是这种函数如何实现（为简单起见，我们根据内部的断言语句实现了一个非常具体的案例）：

void myAffineTransform(InputArray _src, OutputArray _dst, InputArray _m)
{
    // 获取输入数组的 Mat 头。这是一个 O(1) 操作，
    // 除非 _src 和/或 _m 是矩阵表达式。
    Mat src = _src.getMat(), m = _m.getMat();
    CV_Assert( src.type() == CV_32FC2 && m.type() == CV_32F && m.size() == Size(3, 2) );
 
    // [重新]创建输出数组，使其具有适当的大小和类型。
    // 对于 Mat，它调用 Mat::create，对于 STL 向量，它调用 vector::resize。
_dst.create(src.size(), src.type());
    Mat dst = _dst.getMat();
 
    for( int i = 0; i < src.rows; i++ )
        for( int j = 0; j < src.cols; j++ )
        {
            Point2f pt = src.at<Point2f>(i, j);
dst.at<Point2f>(i, j) = Point2f(m.at<float>(0, 0)*pt.x +
m.at<float>(0, 1)*pt.y +
m.at<float>(0, 2),
m.at<float>(1, 0)*pt.x +
m.at<float>(1, 1)*pt.y +
m.at<float>(1, 2));
        }
}

还有另一个相关类型 InputArrayOfArrays，它目前被定义为 InputArray 的同义词

typedef InputArray InputArrayOfArrays;

它表示函数参数是向量的向量或矩阵的向量。需要一个单独的同义词才能正确生成 Python/Java 等包装器。在函数实现级别，它们的用法类似，但应使用 _InputArray::getMat(idx) 来获取外部向量的第 idx 个组件的头，并应使用 _InputArray::size().area() 来查找外部向量的组件（向量/矩阵）数量。

通常，类型支持仅限于 cv::Mat 类型。其他类型是被禁止的。但在某些情况下，我们需要支持传递自定义的非通用 Mat 类型，例如 cv::KeyPoint、cv::DMatch 等数组。此数据不应被解释为图像数据，也不应像常规 cv::Mat 那样进行处理。要传递此类自定义类型，请使用 rawIn() / rawOut() / rawInOut() 包装器。自定义类型被包装为 Mat 兼容的 CV_8UC<N> 值（N = sizeof(T), N <= CV_CN_MAX）。

示例

samples/cpp/pca.cpp 和 samples/cpp/peopledetect.cpp。

成员枚举文档

KindFlag

enum cv::_InputArray::KindFlag

枚举值 (Enumerator)
KIND_SHIFT
FIXED_TYPE
FIXED_SIZE
KIND_MASK
NONE
MAT
MATX
STD_VECTOR
STD_VECTOR_VECTOR
STD_VECTOR_MAT
EXPR	已移除：https://github.com/opencv/opencv/pull/17046
OPENGL_BUFFER
CUDA_HOST_MEM
CUDA_GPU_MAT
UMAT
STD_VECTOR_UMAT
STD_BOOL_VECTOR
STD_VECTOR_CUDA_GPU_MAT
STD_ARRAY	已移除：https://github.com/opencv/opencv/issues/18897
STD_ARRAY_MAT
CUDA_GPU_MATND

构造函数与析构函数说明

_InputArray() [1/24]

cv::_InputArray::_InputArray

(

)

_InputArray() [2/24]

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

_InputArray() [3/24]

cv::_InputArray::_InputArray

(

const Mat &

m

)

_InputArray() [4/24]

cv::_InputArray::_InputArray

(

const MatExpr &

expr

)

_InputArray() [5/24]

cv::_InputArray::_InputArray

(

const std::vector< Mat > &

vec

)

_InputArray() [6/24]

template<typename _Tp >

cv::_InputArray::_InputArray

(

const Mat_< _Tp > &

m

)

_InputArray() [7/24]

template<typename _Tp >

cv::_InputArray::_InputArray

(

const std::vector< _Tp > &

vec

)

_InputArray() [8/24]

cv::_InputArray::_InputArray

(

const std::vector< bool > &

vec

)

_InputArray() [9/24]

template<typename _Tp >

cv::_InputArray::_InputArray

(

const std::vector< std::vector< _Tp > > &

vec

)

_InputArray() [10/24]

cv::_InputArray::_InputArray ( const std::vector< std::vector< bool > > & )

delete

_InputArray() [11/24]

template<typename _Tp >

cv::_InputArray::_InputArray

(

const std::vector< Mat_< _Tp > > &

vec

)

_InputArray() [12/24]

template<typename _Tp >

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

_InputArray() [13/24]

template<typename _Tp , int m, int n>

cv::_InputArray::_InputArray

(

const Matx< _Tp, m, n > &

matx

)

_InputArray() [14/24]

cv::_InputArray::_InputArray

(

const double &

val

)

_InputArray() [15/24]

cv::_InputArray::_InputArray

(

const cuda::GpuMat &

d_mat

)

_InputArray() [16/24]

cv::_InputArray::_InputArray

(

const std::vector< cuda::GpuMat > &

d_mat_array

)

_InputArray() [17/24]

cv::_InputArray::_InputArray

(

const cuda::GpuMatND &

d_mat

)

_InputArray() [18/24]

cv::_InputArray::_InputArray

(

const ogl::Buffer &

buf

)

_InputArray() [19/24]

cv::_InputArray::_InputArray

(

const cuda::HostMem &

cuda_mem

)

_InputArray() [20/24]

template<typename _Tp >

cv::_InputArray::_InputArray

(

const cudev::GpuMat_< _Tp > &

m

)

_InputArray() [21/24]

cv::_InputArray::_InputArray

(

const UMat &

um

)

_InputArray() [22/24]

cv::_InputArray::_InputArray

(

const std::vector< UMat > &

umv

)

_InputArray() [23/24]

template<typename _Tp , std::size_t _Nm>

cv::_InputArray::_InputArray

(

const std::array< _Tp, _Nm > &

arr (数组)

)

_InputArray() [24/24]

template<std::size_t _Nm>

cv::_InputArray::_InputArray

(

const std::array< Mat, _Nm > &

arr (数组)

)

~_InputArray()

cv::_InputArray::~_InputArray

(

)

成员函数说明

channels()

int cv::_InputArray::channels

(

int

i = -1

)

const

cols()

int cv::_InputArray::cols

(

int

i = -1

)

const

copyTo() [1/2]

void cv::_InputArray::copyTo

(

const _OutputArray &

arr (数组)

)

const

copyTo() [2/2]

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

depth()

int cv::_InputArray::depth

(

int

i = -1

)

const

dims()

int cv::_InputArray::dims

(

int

i = -1

)

const

empty() [1/2]

bool cv::_InputArray::empty

(

)

const

empty() [2/2]

bool cv::_InputArray::empty

(

int

i

)

const

getFlags()

int cv::_InputArray::getFlags

(

)

const

getGpuMat()

cuda::GpuMat cv::_InputArray::getGpuMat

(

)

const

getGpuMatND()

cuda::GpuMatND cv::_InputArray::getGpuMatND

(

)

const

getGpuMatVector()

void cv::_InputArray::getGpuMatVector

(

std::vector< cuda::GpuMat > &

gpumv

)

const

getMat()

Mat cv::_InputArray::getMat

(

int

idx = -1

)

const

示例

samples/cpp/pca.cpp.

getMat_()

Mat cv::_InputArray::getMat_

(

int

idx = -1

)

const

getMatVector()

void cv::_InputArray::getMatVector

(

std::vector< Mat > &

mv

)

const

getObj()

void * cv::_InputArray::getObj

(

)

const

getOGlBuffer()

ogl::Buffer cv::_InputArray::getOGlBuffer

(

)

const

getSz()

Size cv::_InputArray::getSz

(

)

const

getUMat()

UMat cv::_InputArray::getUMat

(

int

idx = -1

)

const

getUMatVector()

void cv::_InputArray::getUMatVector

(

std::vector< UMat > &

umv

)

const

init() [1/2]

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

保护

init() [2/2]

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

保护

isContinuous()

bool cv::_InputArray::isContinuous

(

int

i = -1

)

const

isGpuMat()

bool cv::_InputArray::isGpuMat

(

)

const

isGpuMatND()

bool cv::_InputArray::isGpuMatND

(

)

const

isGpuMatVector()

bool cv::_InputArray::isGpuMatVector

(

)

const

isMat()

bool cv::_InputArray::isMat

(

)

const

isMatVector()

bool cv::_InputArray::isMatVector

(

)

const

isMatx()

bool cv::_InputArray::isMatx

(

)

const

isSubmatrix()

bool cv::_InputArray::isSubmatrix

(

int

i = -1

)

const

isUMat()

bool cv::_InputArray::isUMat

(

)

const

isUMatVector()

bool cv::_InputArray::isUMatVector

(

)

const

isVector()

bool cv::_InputArray::isVector

(

)

const

kind()

_InputArray::KindFlag cv::_InputArray::kind

(

)

const

offset()

size_t cv::_InputArray::offset

(

int

i = -1

)

const

rawIn() [1/2]

template<typename _Tp , std::size_t _Nm>

static _InputArray cv::_InputArray::rawIn ( const std::array< _Tp, _Nm > & arr (数组) )

static (静态)

rawIn() [2/2]

template<typename _Tp >

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

static (静态)

rows()

int cv::_InputArray::rows

(

int

i = -1

)

const

sameSize()

bool cv::_InputArray::sameSize

(

const _InputArray &

arr (数组)

)

const

size()

Size cv::_InputArray::size

(

int

i = -1

)

const

sizend()

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

step()

size_t cv::_InputArray::step

(

int

i = -1

)

const

total()

size_t cv::_InputArray::total

(

int

i = -1

)

const

type()

int cv::_InputArray::type

(

int

i = -1

)

const

成员数据文档

flags

int cv::_InputArray::flags

保护

obj

void* cv::_InputArray::obj

保护

sz

Size cv::_InputArray::sz

保护

---

该类的文档由以下文件生成：

• opencv2/core/mat.hpp