OpenCV  4.5.1-pre
Open Source Computer Vision
Modules | Namespaces | Classes | Typedefs | Enumerations | Functions
Core functionality

Modules

 Basic structures
 
 C structures and operations
 
 Operations on arrays
 
 Asynchronous API
 
 XML/YAML Persistence
 
 Clustering
 
 Utility and system functions and macros
 
 OpenGL interoperability
 
 Intel IPP Asynchronous C/C++ Converters
 
 Optimization Algorithms
 
 DirectX interoperability
 
 Eigen support
 
 OpenCL support
 
 Intel VA-API/OpenCL (CL-VA) interoperability
 
 Hardware Acceleration Layer
 

Namespaces

 cv::traits
 

Classes

class  cv::Affine3< T >
 Affine transform. More...
 
class  cv::BufferPoolController
 
class  cv::Quat< _Tp >
 

Typedefs

typedef Affine3< double > cv::Affine3d
 
typedef Affine3< float > cv::Affine3f
 
using cv::Quatd = Quat< double >
 
using cv::Quatf = Quat< float >
 

Enumerations

enum  cv::CovarFlags {
  cv::COVAR_SCRAMBLED = 0,
  cv::COVAR_NORMAL = 1,
  cv::COVAR_USE_AVG = 2,
  cv::COVAR_SCALE = 4,
  cv::COVAR_ROWS = 8,
  cv::COVAR_COLS = 16
}
 Covariation flags. More...
 
enum  cv::QuatAssumeType {
  cv::QUAT_ASSUME_NOT_UNIT,
  cv::QUAT_ASSUME_UNIT
}
 Unit quaternion flag. More...
 

Functions

template<typename T >
Quat< T > cv::acos (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::acosh (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::asin (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::asinh (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::atan (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::atanh (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::cos (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::cosh (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::crossProduct (const Quat< T > &p, const Quat< T > &q)
 
template<typename T >
Quat< T > cv::exp (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::inv (const Quat< T > &q, QuatAssumeType assumeUnit=QUAT_ASSUME_NOT_UNIT)
 
template<typename T >
Quat< T > cv::log (const Quat< T > &q, QuatAssumeType assumeUnit=QUAT_ASSUME_NOT_UNIT)
 
template<typename T >
static Affine3< T > cv::operator* (const Affine3< T > &affine1, const Affine3< T > &affine2)
 
template<typename T , typename V >
static V cv::operator* (const Affine3< T > &affine, const V &vector)
 V is a 3-element vector with member fields x, y and z. More...
 
static Vec3f cv::operator* (const Affine3f &affine, const Vec3f &vector)
 
static Vec3d cv::operator* (const Affine3d &affine, const Vec3d &vector)
 
template<typename T >
Quat< T > cv::operator* (const T, const Quat< T > &)
 
template<typename T >
Quat< T > cv::operator* (const Quat< T > &, const T)
 
template<typename _Tp >
std::ostream & cv::operator<< (std::ostream &, const Quat< _Tp > &)
 
template<typename S >
std::ostream & cv::operator<< (std::ostream &, const Quat< S > &)
 
template<typename T >
Quat< T > cv::power (const Quat< T > &q, const Quat< T > &p, QuatAssumeType assumeUnit=QUAT_ASSUME_NOT_UNIT)
 
template<typename T >
Quat< T > cv::power (const Quat< T > &q, const T x, QuatAssumeType assumeUnit=QUAT_ASSUME_NOT_UNIT)
 
template<typename T >
Quat< T > cv::sin (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::sinh (const Quat< T > &q)
 
template<typename S >
Quat< S > cv::sqrt (const Quat< S > &q, QuatAssumeType assumeUnit=QUAT_ASSUME_NOT_UNIT)
 
void cv::swap (Mat &a, Mat &b)
 Swaps two matrices. More...
 
void cv::swap (UMat &a, UMat &b)
 
template<typename T >
Quat< T > cv::tan (const Quat< T > &q)
 
template<typename T >
Quat< T > cv::tanh (const Quat< T > &q)
 

Detailed Description

Typedef Documentation

◆ Affine3d

typedef Affine3<double> cv::Affine3d

◆ Affine3f

typedef Affine3<float> cv::Affine3f

◆ Quatd

using cv::Quatd = typedef Quat<double>

◆ Quatf

using cv::Quatf = typedef Quat<float>

Enumeration Type Documentation

◆ CovarFlags

#include <opencv2/core.hpp>

Covariation flags.

Enumerator
COVAR_SCRAMBLED 
Python: cv.COVAR_SCRAMBLED

The output covariance matrix is calculated as:

\[\texttt{scale} \cdot [ \texttt{vects} [0]- \texttt{mean} , \texttt{vects} [1]- \texttt{mean} ,...]^T \cdot [ \texttt{vects} [0]- \texttt{mean} , \texttt{vects} [1]- \texttt{mean} ,...],\]

The covariance matrix will be nsamples x nsamples. Such an unusual covariance matrix is used for fast PCA of a set of very large vectors (see, for example, the EigenFaces technique for face recognition). Eigenvalues of this "scrambled" matrix match the eigenvalues of the true covariance matrix. The "true" eigenvectors can be easily calculated from the eigenvectors of the "scrambled" covariance matrix.

COVAR_NORMAL 
Python: cv.COVAR_NORMAL

The output covariance matrix is calculated as:

\[\texttt{scale} \cdot [ \texttt{vects} [0]- \texttt{mean} , \texttt{vects} [1]- \texttt{mean} ,...] \cdot [ \texttt{vects} [0]- \texttt{mean} , \texttt{vects} [1]- \texttt{mean} ,...]^T,\]

covar will be a square matrix of the same size as the total number of elements in each input vector. One and only one of COVAR_SCRAMBLED and COVAR_NORMAL must be specified.

COVAR_USE_AVG 
Python: cv.COVAR_USE_AVG

If the flag is specified, the function does not calculate mean from the input vectors but, instead, uses the passed mean vector. This is useful if mean has been pre-calculated or known in advance, or if the covariance matrix is calculated by parts. In this case, mean is not a mean vector of the input sub-set of vectors but rather the mean vector of the whole set.

COVAR_SCALE 
Python: cv.COVAR_SCALE

If the flag is specified, the covariance matrix is scaled. In the "normal" mode, scale is 1./nsamples . In the "scrambled" mode, scale is the reciprocal of the total number of elements in each input vector. By default (if the flag is not specified), the covariance matrix is not scaled ( scale=1 ).

COVAR_ROWS 
Python: cv.COVAR_ROWS

If the flag is specified, all the input vectors are stored as rows of the samples matrix. mean should be a single-row vector in this case.

COVAR_COLS 
Python: cv.COVAR_COLS

If the flag is specified, all the input vectors are stored as columns of the samples matrix. mean should be a single-column vector in this case.

◆ QuatAssumeType

#include <opencv2/core/quaternion.hpp>

Unit quaternion flag.

Enumerator
QUAT_ASSUME_NOT_UNIT 
Python: cv.QUAT_ASSUME_NOT_UNIT

This flag is specified by default. If this flag is specified, the input quaternions are assumed to be not unit quaternions. It can guarantee the correctness of the calculations, although the calculation speed will be slower than the flag QUAT_ASSUME_UNIT.

QUAT_ASSUME_UNIT 
Python: cv.QUAT_ASSUME_UNIT

If this flag is specified, the input quaternions are assumed to be unit quaternions which will save some computations. However, if this flag is specified without unit quaternion, the program correctness of the result will not be guaranteed.

Function Documentation

◆ acos()

template<typename T >
Quat<T> cv::acos ( const Quat< T > &  q)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example

Quatd q(1,2,3,4);
acos(q);

◆ acosh()

template<typename T >
Quat<T> cv::acosh ( const Quat< T > &  q)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example

Quatd q(1,2,3,4);
acosh(q);

◆ asin()

template<typename T >
Quat<T> cv::asin ( const Quat< T > &  q)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example

Quatd q(1,2,3,4);
asin(q);

◆ asinh()

template<typename T >
Quat<T> cv::asinh ( const Quat< T > &  q)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example

Quatd q(1,2,3,4);
asinh(q);

◆ atan()

template<typename T >
Quat<T> cv::atan ( const Quat< T > &  q)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example

Quatd q(1,2,3,4);
atan(q);

◆ atanh()

template<typename T >
Quat<T> cv::atanh ( const Quat< T > &  q)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example

Quatd q(1,2,3,4);
atanh(q);

◆ cos()

template<typename T >
Quat<T> cv::cos ( const Quat< T > &  q)

◆ cosh()

template<typename T >
Quat<T> cv::cosh ( const Quat< T > &  q)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example

Quatd q(1,2,3,4);
cosh(q);

◆ crossProduct()

template<typename T >
Quat<T> cv::crossProduct ( const Quat< T > &  p,
const Quat< T > &  q 
)

#include <opencv2/core/quaternion.hpp>

For example

Quatd q{1,2,3,4};
Quatd p{5,6,7,8};

◆ exp()

template<typename T >
Quat<T> cv::exp ( const Quat< T > &  q)
Python:
dst=cv.exp(src[, dst])

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example:

Quatd q{1,2,3,4};
cout << exp(q) << endl;
Examples:
samples/cpp/polar_transforms.cpp.

◆ inv()

template<typename T >
Quat<T> cv::inv ( const Quat< T > &  q,
QuatAssumeType  assumeUnit = QUAT_ASSUME_NOT_UNIT 
)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.
assumeUnitif QUAT_ASSUME_UNIT, quaternion q assume to be a unit quaternion and this function will save some computations.

For example

Quatd q(1,2,3,4);
inv(q);
q = q.normalize();
inv(q, assumeUnit);//This assumeUnit means p is a unit quaternion

◆ log()

template<typename T >
Quat<T> cv::log ( const Quat< T > &  q,
QuatAssumeType  assumeUnit = QUAT_ASSUME_NOT_UNIT 
)
Python:
dst=cv.log(src[, dst])

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.
assumeUnitif QUAT_ASSUME_UNIT, q assume to be a unit quaternion and this function will save some computations.

For example

Quatd q1{1,2,3,4};
cout << log(q1) << endl;
Examples:
samples/cpp/polar_transforms.cpp, and samples/cpp/stitching_detailed.cpp.

◆ operator*() [1/6]

template<typename T >
static Affine3<T> cv::operator* ( const Affine3< T > &  affine1,
const Affine3< T > &  affine2 
)
static

◆ operator*() [2/6]

template<typename T , typename V >
static V cv::operator* ( const Affine3< T > &  affine,
const V &  vector 
)
static

#include <opencv2/core/affine.hpp>

V is a 3-element vector with member fields x, y and z.

◆ operator*() [3/6]

static Vec3f cv::operator* ( const Affine3f affine,
const Vec3f vector 
)
static

◆ operator*() [4/6]

static Vec3d cv::operator* ( const Affine3d affine,
const Vec3d vector 
)
static

◆ operator*() [5/6]

template<typename T >
Quat<T> cv::operator* ( const T  ,
const Quat< T > &   
)

◆ operator*() [6/6]

template<typename T >
Quat<T> cv::operator* ( const Quat< T > &  ,
const T   
)

◆ operator<<() [1/2]

template<typename _Tp >
std::ostream& cv::operator<< ( std::ostream &  ,
const Quat< _Tp > &   
)

◆ operator<<() [2/2]

template<typename S >
std::ostream& cv::operator<< ( std::ostream &  ,
const Quat< S > &   
)

◆ power() [1/2]

template<typename T >
Quat<T> cv::power ( const Quat< T > &  q,
const Quat< T > &  p,
QuatAssumeType  assumeUnit = QUAT_ASSUME_NOT_UNIT 
)

#include <opencv2/core/quaternion.hpp>

Parameters
pbase quaternion of power function.
qindex quaternion of power function.
assumeUnitif QUAT_ASSUME_UNIT, quaternion \(p\) assume to be a unit quaternion and this function will save some computations.

For example

Quatd p(1,2,3,4);
Quatd q(5,6,7,8);
power(p, q);
p = p.normalize();
power(p, q, assumeUnit); //This assumeUnit means p is a unit quaternion

◆ power() [2/2]

template<typename T >
Quat<T> cv::power ( const Quat< T > &  q,
const T  x,
QuatAssumeType  assumeUnit = QUAT_ASSUME_NOT_UNIT 
)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.
xindex of exponentiation.
assumeUnitif QUAT_ASSUME_UNIT, quaternion q assume to be a unit quaternion and this function will save some computations.

For example

Quatd q(1,2,3,4);
power(q, 2.0);
double angle = CV_PI;
Vec3d axis{0, 0, 1};
Quatd q1 = Quatd::createFromAngleAxis(angle, axis); //generate a unit quat by axis and angle
power(q1, 2.0, assumeUnit);//This assumeUnit means q1 is a unit quaternion.
Note
the type of the index should be the same as the quaternion.

◆ sin()

template<typename T >
Quat<T> cv::sin ( const Quat< T > &  q)

◆ sinh()

template<typename T >
Quat<T> cv::sinh ( const Quat< T > &  q)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example

Quatd q(1,2,3,4);
sinh(q);

◆ sqrt()

template<typename S >
Quat<S> cv::sqrt ( const Quat< S > &  q,
QuatAssumeType  assumeUnit = QUAT_ASSUME_NOT_UNIT 
)
Python:
dst=cv.sqrt(src[, dst])

◆ swap() [1/2]

void cv::swap ( Mat a,
Mat b 
)

#include <opencv2/core.hpp>

Swaps two matrices.

Examples:
samples/cpp/lkdemo.cpp, and samples/cpp/warpPerspective_demo.cpp.

◆ swap() [2/2]

void cv::swap ( UMat a,
UMat b 
)

#include <opencv2/core.hpp>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ tan()

template<typename T >
Quat<T> cv::tan ( const Quat< T > &  q)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example

Quatd q(1,2,3,4);
tan(q);

◆ tanh()

template<typename T >
Quat<T> cv::tanh ( const Quat< T > &  q)

#include <opencv2/core/quaternion.hpp>

Parameters
qa quaternion.

For example

Quatd q(1,2,3,4);
tanh(q);
See also
sinh, cosh