Joe Verbout / Mbed 2 deprecated main

opencv on mbed

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

Vec< _Tp, cn > Class Template Reference
Public Member Functions

Vec< _Tp, cn > Class Template Reference
[Basic structures]

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

#include <matx.hpp>

Inherits Matx< _Tp, cn, 1 >.

Public Member Functions

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

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.

Definition at line 305 of file matx.hpp.

Constructor & Destructor Documentation

Vec (  )

default constructor

Vec ( _Tp  v0 )

1-element vector constructor

Vec ( _Tp  v0,
_Tp  v1 
)

2-element vector constructor

Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2 
)

3-element vector constructor

Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3 
)

4-element vector constructor

Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4 
)

5-element vector constructor

Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4,
_Tp  v5 
)

6-element vector constructor

Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4,
_Tp  v5,
_Tp  v6 
)

7-element vector constructor

Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4,
_Tp  v5,
_Tp  v6,
_Tp  v7 
)

8-element vector constructor

Vec ( _Tp  v0,
_Tp  v1,
_Tp  v2,
_Tp  v3,
_Tp  v4,
_Tp  v5,
_Tp  v6,
_Tp  v7,
_Tp  v8 
)

9-element vector constructor

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

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

Member Function Documentation

Matx<_Tp, m, 1> col ( int  i ) const [inherited]

extract the matrix column

Vec conj (  ) const

conjugation (makes sense for complex numbers and quaternions)

Reimplemented in Scalar_< _Tp >, and Scalar_< double >.

Vec cross ( const Vec< _Tp, cn > &  v ) const

cross product of the two 3D vectors.

For other dimensionalities the exception is raised

double ddot ( const Matx< _Tp, m, n > &  v ) const [inherited]

dot product computed in double-precision arithmetics

diag_type diag (  ) const [inherited]

extract the matrix diagonal

Matx<_Tp, m, n> div ( const Matx< _Tp, m, n > &  a ) const [inherited]

divide two matrices element-wise

_Tp dot ( const Matx< _Tp, m, n > &  v ) const [inherited]

dot product computed with the default precision

Matx<_Tp, m1, n1> get_minor ( int  i,
int  j 
) const [inherited]

extract part of the matrix

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

invert the matrix

Vec mul ( const Vec< _Tp, cn > &  v ) const

per-element multiplication

Matx<_Tp, m, n> mul ( const Matx< _Tp, m, n > &  a ) const [inherited]

multiply two matrices element-wise

operator Matx< T2, m, n > (  ) const [inherited]

conversion to another data type

operator Vec< T2, cn > (  ) const

conversion to another data type

const _Tp& operator() ( int  i ) const

1D element access

Reimplemented from Matx< _Tp, cn, 1 >.

const _Tp& operator() ( int  i,
int  j 
) const [inherited]

element access

const _Tp& operator[] ( int  i ) const

element access

Matx<_Tp, m1, n1> reshape (  ) const [inherited]

change the matrix shape

Matx<_Tp, 1, n> row ( int  i ) const [inherited]

extract the matrix row

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

solve linear system

Matx<_Tp, n, m> t (  ) const [inherited]

transpose the matrix

Generated on Tue Jul 12 2022 16:42:43 by  doxygen 1.7.2