OpenCV  3.2.0-dev
Open Source Computer Vision
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
cv::Vec< _Tp, cn > Class Template Reference
Core functionality » Basic structures

Template class for short numerical vectors, a partial case of Matx. More...

#include "matx.hpp"

Inheritance diagram for cv::Vec< _Tp, cn >:
Inheritance graph
[legend]
Collaboration diagram for cv::Vec< _Tp, cn >:
Collaboration graph
[legend]

Public Types

enum  
 
enum  {
  depth = Matx<_Tp, cn, 1>::depth,
  channels = cn,
  type = CV_MAKETYPE(depth, channels)
}
 
typedef Matx< _Tp, shortdim, 1 > diag_type
 
typedef Matx< _Tp, m, n > mat_type
 
typedef _Tp value_type
 

Public Member Functions

 Vec ()
 default constructor More...
 
 Vec (_Tp v0)
 1-element vector constructor More...
 
 Vec (_Tp v0, _Tp v1)
 2-element vector constructor More...
 
 Vec (_Tp v0, _Tp v1, _Tp v2)
 3-element vector constructor More...
 
 Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3)
 4-element vector constructor More...
 
 Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4)
 5-element vector constructor More...
 
 Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5)
 6-element vector constructor More...
 
 Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6)
 7-element vector constructor More...
 
 Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7)
 8-element vector constructor More...
 
 Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8)
 9-element vector constructor More...
 
 Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9)
 10-element vector constructor More...
 
 Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9, _Tp v10, _Tp v11, _Tp v12, _Tp v13)
 14-element vector constructor More...
 
 Vec (const _Tp *values)
 
 Vec (const Vec< _Tp, cn > &v)
 
 Vec (const Matx< _Tp, cn, 1 > &a, const Matx< _Tp, cn, 1 > &b, Matx_AddOp)
 
 Vec (const Matx< _Tp, cn, 1 > &a, const Matx< _Tp, cn, 1 > &b, Matx_SubOp)
 
template<typename _T2 >
 Vec (const Matx< _Tp, cn, 1 > &a, _T2 alpha, Matx_ScaleOp)
 
Matx< _Tp, m, 1 > col (int i) const
 extract the matrix column More...
 
Vec conj () const
 conjugation (makes sense for complex numbers and quaternions) More...
 
Vec cross (const Vec &v) const
 cross product of the two 3D vectors. More...
 
double ddot (const Matx< _Tp, m, n > &v) const
 dot product computed in double-precision arithmetics More...
 
diag_type diag () const
 extract the matrix diagonal More...
 
Matx< _Tp, m, n > div (const Matx< _Tp, m, n > &a) const
 divide two matrices element-wise More...
 
_Tp dot (const Matx< _Tp, m, n > &v) const
 dot product computed with the default precision More...
 
Matx< _Tp, m1, n1 > get_minor (int i, int j) const
 extract part of the matrix More...
 
Matx< _Tp, n, m > inv (int method=DECOMP_LU, bool *p_is_ok=NULL) const
 invert the matrix More...
 
Matx< _Tp, m, n > mul (const Matx< _Tp, m, n > &a) const
 multiply two matrices element-wise More...
 
Vec mul (const Vec< _Tp, cn > &v) const
 per-element multiplication More...
 
 operator Matx< T2, m, n > () const
 conversion to another data type More...
 
template<typename T2 >
 operator Vec< T2, cn > () const
 conversion to another data type More...
 
const _Tp & operator() (int i, int j) const
 element access More...
 
_Tp & operator() (int i, int j)
 
const _Tp & operator() (int i) const
 
_Tp & operator() (int i)
 
const _Tp & operator[] (int i) const
 element access More...
 
_Tp & operator[] (int i)
 
Matx< _Tp, m1, n1 > reshape () const
 change the matrix shape More...
 
Matx< _Tp, 1, n > row (int i) const
 extract the matrix row More...
 
Matx< _Tp, n, l > solve (const Matx< _Tp, m, l > &rhs, int flags=DECOMP_LU) const
 solve linear system More...
 
Vec< _Tp, n > solve (const Vec< _Tp, m > &rhs, int method) const
 
Matx< _Tp, n, m > t () const
 transpose the matrix More...
 

Static Public Member Functions

static Vec all (_Tp alpha)
 
static Matx diag (const diag_type &d)
 
static Matx eye ()
 
static Matx ones ()
 
static Matx randn (_Tp a, _Tp b)
 
static Matx randu (_Tp a, _Tp b)
 
static Matx zeros ()
 

Public Attributes

_Tp val [m *n]
 

Related Functions

(Note that these are not member functions.)

template<typename _Tp1 , typename _Tp2 , int cn>
static Vec< _Tp1, cn > & operator+= (Vec< _Tp1, cn > &a, const Vec< _Tp2, cn > &b)
 
template<typename _Tp1 , typename _Tp2 , int cn>
static Vec< _Tp1, cn > & operator-= (Vec< _Tp1, cn > &a, const Vec< _Tp2, cn > &b)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator+ (const Vec< _Tp, cn > &a, const Vec< _Tp, cn > &b)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator- (const Vec< _Tp, cn > &a, const Vec< _Tp, cn > &b)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator*= (Vec< _Tp, cn > &a, int alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator*= (Vec< _Tp, cn > &a, float alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator*= (Vec< _Tp, cn > &a, double alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator/= (Vec< _Tp, cn > &a, int alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator/= (Vec< _Tp, cn > &a, float alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator/= (Vec< _Tp, cn > &a, double alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* (const Vec< _Tp, cn > &a, int alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* (int alpha, const Vec< _Tp, cn > &a)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* (const Vec< _Tp, cn > &a, float alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* (float alpha, const Vec< _Tp, cn > &a)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* (const Vec< _Tp, cn > &a, double alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* (double alpha, const Vec< _Tp, cn > &a)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator/ (const Vec< _Tp, cn > &a, int alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator/ (const Vec< _Tp, cn > &a, float alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator/ (const Vec< _Tp, cn > &a, double alpha)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator- (const Vec< _Tp, cn > &a)
 
template<typename _Tp >
Vec< _Tp, 4 > operator* (const Vec< _Tp, 4 > &v1, const Vec< _Tp, 4 > &v2)
 
template<typename _Tp >
Vec< _Tp, 4 > & operator*= (Vec< _Tp, 4 > &v1, const Vec< _Tp, 4 > &v2)
 

Detailed Description

template<typename _Tp, int cn>
class cv::Vec< _Tp, cn >

Template class for short numerical vectors, a partial case of Matx.

This template class represents short numerical vectors (of 1, 2, 3, 4 ... elements) on which you can perform basic arithmetical operations, access individual elements using [] operator etc. The vectors are allocated on stack, as opposite to std::valarray, std::vector, cv::Mat etc., which elements are dynamically allocated in the heap.

The template takes 2 parameters:

Template Parameters
_Tpelement type
cnthe number of elements

In addition to the universal notation like Vec<float, 3>, you can use shorter aliases for the most popular specialized variants of Vec, e.g. Vec3f ~ Vec<float, 3>.

It is possible to convert Vec<T,2> to/from Point_, Vec<T,3> to/from Point3_ , and Vec<T,4> to CvScalar or Scalar_. Use operator[] to access the elements of Vec.

All the expected vector operations are also implemented:

  • v1 = v2 + v3
  • v1 = v2 - v3
  • v1 = v2 * scale
  • v1 = scale * v2
  • v1 = -v2
  • v1 += v2 and other augmenting operations
  • v1 == v2, v1 != v2
  • norm(v1) (euclidean norm) The Vec class is commonly used to describe pixel types of multi-channel arrays. See Mat for details.
Examples:
houghcircles.cpp, houghlines.cpp, and watershed.cpp.

Member Typedef Documentation

typedef Matx<_Tp, shortdim, 1> cv::Matx< _Tp, m, n >::diag_type
inherited
typedef Matx<_Tp, m, n> cv::Matx< _Tp, m, n >::mat_type
inherited
template<typename _Tp, int cn>
typedef _Tp cv::Vec< _Tp, cn >::value_type

Member Enumeration Documentation

anonymous enum
inherited
template<typename _Tp, int cn>
anonymous enum
Enumerator
depth 
channels 
type 

Constructor & Destructor Documentation

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( )

default constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0)

1-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0,
_Tp  v1 
)

2-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2 
)

3-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3 
)

4-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4 
)

5-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4,
_Tp  v5 
)

6-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4,
_Tp  v5,
_Tp  v6 
)

7-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4,
_Tp  v5,
_Tp  v6,
_Tp  v7 
)

8-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4,
_Tp  v5,
_Tp  v6,
_Tp  v7,
_Tp  v8 
)

9-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4,
_Tp  v5,
_Tp  v6,
_Tp  v7,
_Tp  v8,
_Tp  v9 
)

10-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4,
_Tp  v5,
_Tp  v6,
_Tp  v7,
_Tp  v8,
_Tp  v9,
_Tp  v10,
_Tp  v11,
_Tp  v12,
_Tp  v13 
)

14-element vector constructor

template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( const _Tp *  values)
explicit
template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( const Vec< _Tp, cn > &  v)
template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( const Matx< _Tp, cn, 1 > &  a,
const Matx< _Tp, cn, 1 > &  b,
Matx_AddOp   
)
template<typename _Tp, int cn>
cv::Vec< _Tp, cn >::Vec ( const Matx< _Tp, cn, 1 > &  a,
const Matx< _Tp, cn, 1 > &  b,
Matx_SubOp   
)
template<typename _Tp, int cn>
template<typename _T2 >
cv::Vec< _Tp, cn >::Vec ( const Matx< _Tp, cn, 1 > &  a,
_T2  alpha,
Matx_ScaleOp   
)

Member Function Documentation

template<typename _Tp, int cn>
static Vec cv::Vec< _Tp, cn >::all ( _Tp  alpha)
static
Matx<_Tp, m, 1> cv::Matx< _Tp, m, n >::col ( int  i) const
inherited

extract the matrix column

template<typename _Tp, int cn>
Vec cv::Vec< _Tp, cn >::conj ( ) const

conjugation (makes sense for complex numbers and quaternions)

template<typename _Tp, int cn>
Vec cv::Vec< _Tp, cn >::cross ( const Vec< _Tp, cn > &  v) const

cross product of the two 3D vectors.

For other dimensionalities the exception is raised

double cv::Matx< _Tp, m, n >::ddot ( const Matx< _Tp, m, n > &  v) const
inherited

dot product computed in double-precision arithmetics

static Matx cv::Matx< _Tp, m, n >::diag ( const diag_type &  d)
staticinherited
diag_type cv::Matx< _Tp, m, n >::diag ( ) const
inherited

extract the matrix diagonal

Matx<_Tp, m, n> cv::Matx< _Tp, m, n >::div ( const Matx< _Tp, m, n > &  a) const
inherited

divide two matrices element-wise

_Tp cv::Matx< _Tp, m, n >::dot ( const Matx< _Tp, m, n > &  v) const
inherited

dot product computed with the default precision

static Matx cv::Matx< _Tp, m, n >::eye ( )
staticinherited
Matx<_Tp, m1, n1> cv::Matx< _Tp, m, n >::get_minor ( int  i,
int  j 
) const
inherited

extract part of the matrix

Matx<_Tp, n, m> cv::Matx< _Tp, m, n >::inv ( int  method = DECOMP_LU,
bool *  p_is_ok = NULL 
) const
inherited

invert the matrix

Matx<_Tp, m, n> cv::Matx< _Tp, m, n >::mul ( const Matx< _Tp, m, n > &  a) const
inherited

multiply two matrices element-wise

template<typename _Tp, int cn>
Vec cv::Vec< _Tp, cn >::mul ( const Vec< _Tp, cn > &  v) const

per-element multiplication

static Matx cv::Matx< _Tp, m, n >::ones ( )
staticinherited
cv::Matx< _Tp, m, n >::operator Matx< T2, m, n > ( ) const
inherited

conversion to another data type

template<typename _Tp, int cn>
template<typename T2 >
cv::Vec< _Tp, cn >::operator Vec< T2, cn > ( ) const

conversion to another data type

const _Tp& cv::Matx< _Tp, m, n >::operator() ( int  i,
int  j 
) const
inherited

element access

_Tp& cv::Matx< _Tp, m, n >::operator() ( int  i,
int  j 
)
inherited
template<typename _Tp, int cn>
const _Tp& cv::Vec< _Tp, cn >::operator() ( int  i) const
template<typename _Tp, int cn>
_Tp& cv::Vec< _Tp, cn >::operator() ( int  i)
template<typename _Tp, int cn>
const _Tp& cv::Vec< _Tp, cn >::operator[] ( int  i) const

element access

template<typename _Tp, int cn>
_Tp& cv::Vec< _Tp, cn >::operator[] ( int  i)
static Matx cv::Matx< _Tp, m, n >::randn ( _Tp  a,
_Tp  b 
)
staticinherited
static Matx cv::Matx< _Tp, m, n >::randu ( _Tp  a,
_Tp  b 
)
staticinherited
Matx<_Tp, m1, n1> cv::Matx< _Tp, m, n >::reshape ( ) const
inherited

change the matrix shape

Matx<_Tp, 1, n> cv::Matx< _Tp, m, n >::row ( int  i) const
inherited

extract the matrix row

Matx<_Tp, n, l> cv::Matx< _Tp, m, n >::solve ( const Matx< _Tp, m, l > &  rhs,
int  flags = DECOMP_LU 
) const
inherited

solve linear system

Vec<_Tp, n> cv::Matx< _Tp, m, n >::solve ( const Vec< _Tp, m > &  rhs,
int  method 
) const
inherited
Matx<_Tp, n, m> cv::Matx< _Tp, m, n >::t ( ) const
inherited

transpose the matrix

static Matx cv::Matx< _Tp, m, n >::zeros ( )
staticinherited

Friends And Related Function Documentation

template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* ( const Vec< _Tp, cn > &  a,
int  alpha 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* ( int  alpha,
const Vec< _Tp, cn > &  a 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* ( const Vec< _Tp, cn > &  a,
float  alpha 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* ( float  alpha,
const Vec< _Tp, cn > &  a 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* ( const Vec< _Tp, cn > &  a,
double  alpha 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator* ( double  alpha,
const Vec< _Tp, cn > &  a 
)
related
template<typename _Tp >
Vec< _Tp, 4 > operator* ( const Vec< _Tp, 4 > &  v1,
const Vec< _Tp, 4 > &  v2 
)
related

References cv::saturate_cast().

Here is the call graph for this function:

template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator*= ( Vec< _Tp, cn > &  a,
int  alpha 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator*= ( Vec< _Tp, cn > &  a,
float  alpha 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator*= ( Vec< _Tp, cn > &  a,
double  alpha 
)
related
template<typename _Tp >
Vec< _Tp, 4 > & operator*= ( Vec< _Tp, 4 > &  v1,
const Vec< _Tp, 4 > &  v2 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator+ ( const Vec< _Tp, cn > &  a,
const Vec< _Tp, cn > &  b 
)
related
template<typename _Tp1 , typename _Tp2 , int cn>
static Vec< _Tp1, cn > & operator+= ( Vec< _Tp1, cn > &  a,
const Vec< _Tp2, cn > &  b 
)
related

References cv::Matx< _Tp, cn, 1 >::val.

template<typename _Tp , int cn>
static Vec< _Tp, cn > operator- ( const Vec< _Tp, cn > &  a,
const Vec< _Tp, cn > &  b 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator- ( const Vec< _Tp, cn > &  a)
related

References cv::Matx< _Tp, cn, 1 >::val.

template<typename _Tp1 , typename _Tp2 , int cn>
static Vec< _Tp1, cn > & operator-= ( Vec< _Tp1, cn > &  a,
const Vec< _Tp2, cn > &  b 
)
related

References cv::Matx< _Tp, cn, 1 >::val.

template<typename _Tp , int cn>
static Vec< _Tp, cn > operator/ ( const Vec< _Tp, cn > &  a,
int  alpha 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator/ ( const Vec< _Tp, cn > &  a,
float  alpha 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > operator/ ( const Vec< _Tp, cn > &  a,
double  alpha 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator/= ( Vec< _Tp, cn > &  a,
int  alpha 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator/= ( Vec< _Tp, cn > &  a,
float  alpha 
)
related
template<typename _Tp , int cn>
static Vec< _Tp, cn > & operator/= ( Vec< _Tp, cn > &  a,
double  alpha 
)
related

Member Data Documentation

_Tp cv::Matx< _Tp, m, n >::val[m *n]
inherited

Referenced by CvScalar::CvScalar(), cv::viz::isNan(), cv::Vec< _Tp, cn >::operator+=(), cv::Vec< _Tp, cn >::operator-(), cv::Vec< _Tp, cn >::operator-=(), and cv::FileStorage::write().

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