OpenCV  4.1.0
Open Source Computer Vision
Namespaces | Classes | Typedefs | Enumerations | Functions
Basic structures

Namespaces

namespace  cv::traits
 

Classes

class  cv::_InputArray
 This is the proxy class for passing read-only input arrays into OpenCV functions. More...
 
class  cv::_InputOutputArray
 
class  cv::_OutputArray
 This type is very similar to InputArray except that it is used for input/output and output function parameters. More...
 
class  cv::Algorithm
 This is a base class for all more or less complex algorithms in OpenCV. More...
 
class  cv::Complex< _Tp >
 A complex number class. More...
 
class  cv::DataDepth< _Tp >
 A helper class for cv::DataType. More...
 
class  cv::DataType< _Tp >
 Template "trait" class for OpenCV primitive data types. More...
 
class  cv::DMatch
 Class for matching keypoint descriptors. More...
 
class  cv::Formatted
 
class  cv::Formatter
 
class  cv::KeyPoint
 Data structure for salient point detectors. More...
 
class  cv::Mat
 n-dimensional dense array class More...
 
class  cv::Mat_< _Tp >
 Template matrix class derived from Mat. More...
 
class  cv::MatAllocator
 Custom array allocator. More...
 
class  cv::MatCommaInitializer_< _Tp >
 Comma-separated Matrix Initializer. More...
 
class  cv::MatConstIterator
 
class  cv::MatConstIterator_< _Tp >
 Matrix read-only iterator. More...
 
class  cv::MatExpr
 Matrix expression representation. More...
 
class  cv::MatIterator_< _Tp >
 Matrix read-write iterator. More...
 
class  cv::MatOp
 
struct  cv::MatSize
 
struct  cv::MatStep
 
class  cv::Matx< _Tp, m, n >
 Template class for small matrices whose type and size are known at compilation time. More...
 
class  cv::MatxCommaInitializer< _Tp, m, n >
 Comma-separated Matrix Initializer. More...
 
class  cv::NAryMatIterator
 n-ary multi-dimensional array iterator. More...
 
struct  cv::ParamType< _Tp, _EnumTp >
 
struct  cv::ParamType< _Tp, typename std::enable_if< std::is_enum< _Tp >::value >::type >
 
struct  cv::ParamType< Algorithm >
 
struct  cv::ParamType< bool >
 
struct  cv::ParamType< double >
 
struct  cv::ParamType< float >
 
struct  cv::ParamType< Mat >
 
struct  cv::ParamType< Scalar >
 
struct  cv::ParamType< std::vector< Mat > >
 
struct  cv::ParamType< String >
 
struct  cv::ParamType< uchar >
 
struct  cv::ParamType< uint64 >
 
struct  cv::ParamType< unsigned >
 
class  cv::Point3_< _Tp >
 Template class for 3D points specified by its coordinates x, y and z. More...
 
class  cv::Point_< _Tp >
 Template class for 2D points specified by its coordinates x and y. More...
 
class  cv::Range
 Template class specifying a continuous subsequence (slice) of a sequence. More...
 
class  cv::Rect_< _Tp >
 Template class for 2D rectangles. More...
 
class  cv::RotatedRect
 The class represents rotated (i.e. not up-right) rectangles on a plane. More...
 
class  cv::Scalar_< _Tp >
 Template class for a 4-element vector derived from Vec. More...
 
class  cv::Size_< _Tp >
 Template class for specifying the size of an image or rectangle. More...
 
class  cv::SparseMat
 The class SparseMat represents multi-dimensional sparse numerical arrays. More...
 
class  cv::SparseMat_< _Tp >
 Template sparse n-dimensional array class derived from SparseMat. More...
 
class  cv::SparseMatConstIterator
 Read-Only Sparse Matrix Iterator. More...
 
class  cv::SparseMatConstIterator_< _Tp >
 Template Read-Only Sparse Matrix Iterator Class. More...
 
class  cv::SparseMatIterator
 Read-write Sparse Matrix Iterator. More...
 
class  cv::SparseMatIterator_< _Tp >
 Template Read-Write Sparse Matrix Iterator Class. More...
 
class  cv::TermCriteria
 The class defining termination criteria for iterative algorithms. More...
 
class  cv::UMat
 
struct  cv::UMatData
 
class  cv::Vec< _Tp, cn >
 Template class for short numerical vectors, a partial case of Matx. More...
 
class  cv::VecCommaInitializer< _Tp, m >
 Comma-separated Vec Initializer. More...
 

Typedefs

typedef Complex< double > cv::Complexd
 
typedef Complex< float > cv::Complexf
 
typedef const _InputArray & cv::InputArray
 
typedef InputArray cv::InputArrayOfArrays
 
typedef const _InputOutputArray & cv::InputOutputArray
 
typedef InputOutputArray cv::InputOutputArrayOfArrays
 
typedef Mat_< ucharcv::Mat1b
 
typedef Mat_< double > cv::Mat1d
 
typedef Mat_< float > cv::Mat1f
 
typedef Mat_< int > cv::Mat1i
 
typedef Mat_< short > cv::Mat1s
 
typedef Mat_< ushortcv::Mat1w
 
typedef Mat_< Vec2b > cv::Mat2b
 
typedef Mat_< Vec2d > cv::Mat2d
 
typedef Mat_< Vec2f > cv::Mat2f
 
typedef Mat_< Vec2i > cv::Mat2i
 
typedef Mat_< Vec2s > cv::Mat2s
 
typedef Mat_< Vec2w > cv::Mat2w
 
typedef Mat_< Vec3b > cv::Mat3b
 
typedef Mat_< Vec3d > cv::Mat3d
 
typedef Mat_< Vec3f > cv::Mat3f
 
typedef Mat_< Vec3i > cv::Mat3i
 
typedef Mat_< Vec3s > cv::Mat3s
 
typedef Mat_< Vec3w > cv::Mat3w
 
typedef Mat_< Vec4b > cv::Mat4b
 
typedef Mat_< Vec4d > cv::Mat4d
 
typedef Mat_< Vec4f > cv::Mat4f
 
typedef Mat_< Vec4i > cv::Mat4i
 
typedef Mat_< Vec4s > cv::Mat4s
 
typedef Mat_< Vec4w > cv::Mat4w
 
typedef Matx< double, 1, 2 > cv::Matx12d
 
typedef Matx< float, 1, 2 > cv::Matx12f
 
typedef Matx< double, 1, 3 > cv::Matx13d
 
typedef Matx< float, 1, 3 > cv::Matx13f
 
typedef Matx< double, 1, 4 > cv::Matx14d
 
typedef Matx< float, 1, 4 > cv::Matx14f
 
typedef Matx< double, 1, 6 > cv::Matx16d
 
typedef Matx< float, 1, 6 > cv::Matx16f
 
typedef Matx< double, 2, 1 > cv::Matx21d
 
typedef Matx< float, 2, 1 > cv::Matx21f
 
typedef Matx< double, 2, 2 > cv::Matx22d
 
typedef Matx< float, 2, 2 > cv::Matx22f
 
typedef Matx< double, 2, 3 > cv::Matx23d
 
typedef Matx< float, 2, 3 > cv::Matx23f
 
typedef Matx< double, 3, 1 > cv::Matx31d
 
typedef Matx< float, 3, 1 > cv::Matx31f
 
typedef Matx< double, 3, 2 > cv::Matx32d
 
typedef Matx< float, 3, 2 > cv::Matx32f
 
typedef Matx< double, 3, 3 > cv::Matx33d
 
typedef Matx< float, 3, 3 > cv::Matx33f
 
typedef Matx< double, 3, 4 > cv::Matx34d
 
typedef Matx< float, 3, 4 > cv::Matx34f
 
typedef Matx< double, 4, 1 > cv::Matx41d
 
typedef Matx< float, 4, 1 > cv::Matx41f
 
typedef Matx< double, 4, 3 > cv::Matx43d
 
typedef Matx< float, 4, 3 > cv::Matx43f
 
typedef Matx< double, 4, 4 > cv::Matx44d
 
typedef Matx< float, 4, 4 > cv::Matx44f
 
typedef Matx< double, 6, 1 > cv::Matx61d
 
typedef Matx< float, 6, 1 > cv::Matx61f
 
typedef Matx< double, 6, 6 > cv::Matx66d
 
typedef Matx< float, 6, 6 > cv::Matx66f
 
typedef const _OutputArray & cv::OutputArray
 
typedef OutputArray cv::OutputArrayOfArrays
 
typedef Point2i cv::Point
 
typedef Point_< double > cv::Point2d
 
typedef Point_< float > cv::Point2f
 
typedef Point_< int > cv::Point2i
 
typedef Point_< int64cv::Point2l
 
typedef Point3_< double > cv::Point3d
 
typedef Point3_< float > cv::Point3f
 
typedef Point3_< int > cv::Point3i
 
template<typename _Tp >
using cv::Ptr = std::shared_ptr< _Tp >
 
typedef Rect2i cv::Rect
 
typedef Rect_< double > cv::Rect2d
 
typedef Rect_< float > cv::Rect2f
 
typedef Rect_< int > cv::Rect2i
 
typedef Scalar_< double > cv::Scalar
 
typedef Size2i cv::Size
 
typedef Size_< double > cv::Size2d
 
typedef Size_< float > cv::Size2f
 
typedef Size_< int > cv::Size2i
 
typedef Size_< int64cv::Size2l
 
typedef std::string cv::String
 

Enumerations

enum  cv::AccessFlag {
  cv::ACCESS_READ =1<<24,
  cv::ACCESS_WRITE =1<<25,
  cv::ACCESS_RW =3<<24,
  cv::ACCESS_MASK =ACCESS_RW,
  cv::ACCESS_FAST =1<<26
}
 
enum  cv::Param {
  cv::INT =0,
  cv::BOOLEAN =1,
  cv::REAL =2,
  cv::STRING =3,
  cv::MAT =4,
  cv::MAT_VECTOR =5,
  cv::ALGORITHM =6,
  cv::FLOAT =7,
  cv::UNSIGNED_INT =8,
  cv::UINT64 =9,
  cv::UCHAR =11,
  cv::SCALAR =12
}
 
enum  cv::UMatUsageFlags {
  cv::USAGE_DEFAULT = 0,
  cv::USAGE_ALLOCATE_HOST_MEMORY = 1 << 0,
  cv::USAGE_ALLOCATE_DEVICE_MEMORY = 1 << 1,
  cv::USAGE_ALLOCATE_SHARED_MEMORY = 1 << 2,
  cv::__UMAT_USAGE_FLAGS_32BIT = 0x7fffffff
}
 Usage flags for allocator. More...
 

Functions

template<typename _Tp , int m>
static double cv::determinant (const Matx< _Tp, m, m > &a)
 
template<typename _Tp , typename... A1>
static Ptr< _Tp > cv::makePtr (const A1 &...a1)
 
InputOutputArray cv::noArray ()
 
template<typename _Tp , int m, int n>
static double cv::norm (const Matx< _Tp, m, n > &M)
 
template<typename _Tp , int m, int n>
static double cv::norm (const Matx< _Tp, m, n > &M, int normType)
 
template<typename _Tp , int cn>
static Vec< _Tp, cn > cv::normalize (const Vec< _Tp, cn > &v)
 
static String & cv::operator<< (String &out, Ptr< Formatted > fmtd)
 
static String & cv::operator<< (String &out, const Mat &mtx)
 
template<typename _Tp >
static _InputArray cv::rawIn (_Tp &v)
 
template<typename _Tp >
static _InputOutputArray cv::rawInOut (_Tp &v)
 
template<typename _Tp >
static _OutputArray cv::rawOut (_Tp &v)
 
static std::string cv::toLowerCase (const std::string &str)
 
static std::string cv::toUpperCase (const std::string &str)
 
template<typename _Tp , int m, int n>
static double cv::trace (const Matx< _Tp, m, n > &a)
 

Shorter aliases for the most popular specializations of Vec<T,n>

typedef Vec< uchar, 2 > cv::Vec2b
 
typedef Vec< uchar, 3 > cv::Vec3b
 
typedef Vec< uchar, 4 > cv::Vec4b
 
typedef Vec< short, 2 > cv::Vec2s
 
typedef Vec< short, 3 > cv::Vec3s
 
typedef Vec< short, 4 > cv::Vec4s
 
typedef Vec< ushort, 2 > cv::Vec2w
 
typedef Vec< ushort, 3 > cv::Vec3w
 
typedef Vec< ushort, 4 > cv::Vec4w
 
typedef Vec< int, 2 > cv::Vec2i
 
typedef Vec< int, 3 > cv::Vec3i
 
typedef Vec< int, 4 > cv::Vec4i
 
typedef Vec< int, 6 > cv::Vec6i
 
typedef Vec< int, 8 > cv::Vec8i
 
typedef Vec< float, 2 > cv::Vec2f
 
typedef Vec< float, 3 > cv::Vec3f
 
typedef Vec< float, 4 > cv::Vec4f
 
typedef Vec< float, 6 > cv::Vec6f
 
typedef Vec< double, 2 > cv::Vec2d
 
typedef Vec< double, 3 > cv::Vec3d
 
typedef Vec< double, 4 > cv::Vec4d
 
typedef Vec< double, 6 > cv::Vec6d
 

Detailed Description

Typedef Documentation

typedef Complex<double> cv::Complexd
typedef Complex<float> cv::Complexf
typedef const _InputArray& cv::InputArray
typedef InputArray cv::InputArrayOfArrays
typedef const _InputOutputArray& cv::InputOutputArray
typedef InputOutputArray cv::InputOutputArrayOfArrays
typedef Mat_<uchar> cv::Mat1b
typedef Mat_<double> cv::Mat1d
typedef Mat_<float> cv::Mat1f
typedef Mat_<int> cv::Mat1i
typedef Mat_<short> cv::Mat1s
typedef Mat_<ushort> cv::Mat1w
typedef Mat_<Vec2b> cv::Mat2b
typedef Mat_<Vec2d> cv::Mat2d
typedef Mat_<Vec2f> cv::Mat2f
typedef Mat_<Vec2i> cv::Mat2i
typedef Mat_<Vec2s> cv::Mat2s
typedef Mat_<Vec2w> cv::Mat2w
typedef Mat_<Vec3b> cv::Mat3b
typedef Mat_<Vec3d> cv::Mat3d
typedef Mat_<Vec3f> cv::Mat3f
typedef Mat_<Vec3i> cv::Mat3i
typedef Mat_<Vec3s> cv::Mat3s
typedef Mat_<Vec3w> cv::Mat3w
typedef Mat_<Vec4b> cv::Mat4b
typedef Mat_<Vec4d> cv::Mat4d
typedef Mat_<Vec4f> cv::Mat4f
typedef Mat_<Vec4i> cv::Mat4i
typedef Mat_<Vec4s> cv::Mat4s
typedef Mat_<Vec4w> cv::Mat4w
typedef Matx<double, 1, 2> cv::Matx12d
typedef Matx<float, 1, 2> cv::Matx12f
typedef Matx<double, 1, 3> cv::Matx13d
typedef Matx<float, 1, 3> cv::Matx13f
typedef Matx<double, 1, 4> cv::Matx14d
typedef Matx<float, 1, 4> cv::Matx14f
typedef Matx<double, 1, 6> cv::Matx16d
typedef Matx<float, 1, 6> cv::Matx16f
typedef Matx<double, 2, 1> cv::Matx21d
typedef Matx<float, 2, 1> cv::Matx21f
typedef Matx<double, 2, 2> cv::Matx22d
typedef Matx<float, 2, 2> cv::Matx22f
typedef Matx<double, 2, 3> cv::Matx23d
typedef Matx<float, 2, 3> cv::Matx23f
typedef Matx<double, 3, 1> cv::Matx31d
typedef Matx<float, 3, 1> cv::Matx31f
typedef Matx<double, 3, 2> cv::Matx32d
typedef Matx<float, 3, 2> cv::Matx32f
typedef Matx<double, 3, 3> cv::Matx33d
typedef Matx<float, 3, 3> cv::Matx33f
typedef Matx<double, 3, 4> cv::Matx34d
typedef Matx<float, 3, 4> cv::Matx34f
typedef Matx<double, 4, 1> cv::Matx41d
typedef Matx<float, 4, 1> cv::Matx41f
typedef Matx<double, 4, 3> cv::Matx43d
typedef Matx<float, 4, 3> cv::Matx43f
typedef Matx<double, 4, 4> cv::Matx44d
typedef Matx<float, 4, 4> cv::Matx44f
typedef Matx<double, 6, 1> cv::Matx61d
typedef Matx<float, 6, 1> cv::Matx61f
typedef Matx<double, 6, 6> cv::Matx66d
typedef Matx<float, 6, 6> cv::Matx66f
typedef const _OutputArray& cv::OutputArray
typedef OutputArray cv::OutputArrayOfArrays
typedef Point2i cv::Point
typedef Point_<double> cv::Point2d
typedef Point_<float> cv::Point2f
typedef Point_<int> cv::Point2i
typedef Point_<int64> cv::Point2l
typedef Point3_<double> cv::Point3d
typedef Point3_<float> cv::Point3f
typedef Point3_<int> cv::Point3i
template<typename _Tp >
using cv::Ptr = typedef std::shared_ptr<_Tp>
typedef Rect2i cv::Rect
typedef Rect_<double> cv::Rect2d
typedef Rect_<float> cv::Rect2f
typedef Rect_<int> cv::Rect2i
typedef Scalar_<double> cv::Scalar
typedef Size2i cv::Size
typedef Size_<double> cv::Size2d
typedef Size_<float> cv::Size2f
typedef Size_<int> cv::Size2i
typedef Size_<int64> cv::Size2l
typedef std::string cv::String
typedef Vec<uchar, 2> cv::Vec2b
typedef Vec<double, 2> cv::Vec2d
typedef Vec<float, 2> cv::Vec2f
typedef Vec<int, 2> cv::Vec2i
typedef Vec<short, 2> cv::Vec2s
typedef Vec<ushort, 2> cv::Vec2w
typedef Vec<uchar, 3> cv::Vec3b
typedef Vec<double, 3> cv::Vec3d
typedef Vec<float, 3> cv::Vec3f
typedef Vec<int, 3> cv::Vec3i
typedef Vec<short, 3> cv::Vec3s
typedef Vec<ushort, 3> cv::Vec3w
typedef Vec<uchar, 4> cv::Vec4b
typedef Vec<double, 4> cv::Vec4d
typedef Vec<float, 4> cv::Vec4f
typedef Vec<int, 4> cv::Vec4i
typedef Vec<short, 4> cv::Vec4s
typedef Vec<ushort, 4> cv::Vec4w
typedef Vec<double, 6> cv::Vec6d
typedef Vec<float, 6> cv::Vec6f
typedef Vec<int, 6> cv::Vec6i
typedef Vec<int, 8> cv::Vec8i

Enumeration Type Documentation

Enumerator
ACCESS_READ 
ACCESS_WRITE 
ACCESS_RW 
ACCESS_MASK 
ACCESS_FAST 
enum cv::Param
Enumerator
INT 
BOOLEAN 
REAL 
STRING 
MAT 
MAT_VECTOR 
ALGORITHM 
FLOAT 
UNSIGNED_INT 
UINT64 
UCHAR 
SCALAR 

Usage flags for allocator.

Enumerator
USAGE_DEFAULT 
USAGE_ALLOCATE_HOST_MEMORY 
USAGE_ALLOCATE_DEVICE_MEMORY 
USAGE_ALLOCATE_SHARED_MEMORY 
__UMAT_USAGE_FLAGS_32BIT 

Function Documentation

template<typename _Tp , int m>
static double cv::determinant ( const Matx< _Tp, m, m > &  a)
static
template<typename _Tp , typename... A1>
static Ptr<_Tp> cv::makePtr ( const A1 &...  a1)
inlinestatic
InputOutputArray cv::noArray ( )
template<typename _Tp , int m, int n>
static double cv::norm ( const Matx< _Tp, m, n > &  M)
static
template<typename _Tp , int m, int n>
static double cv::norm ( const Matx< _Tp, m, n > &  M,
int  normType 
)
static
template<typename _Tp , int cn>
static Vec<_Tp, cn> cv::normalize ( const Vec< _Tp, cn > &  v)
static
static String& cv::operator<< ( String &  out,
Ptr< Formatted >  fmtd 
)
inlinestatic
static String& cv::operator<< ( String &  out,
const Mat &  mtx 
)
inlinestatic
template<typename _Tp >
static _InputArray cv::rawIn ( _Tp &  v)
inlinestatic

Helper to wrap custom types.

See Also
InputArray
template<typename _Tp >
static _InputOutputArray cv::rawInOut ( _Tp &  v)
inlinestatic

Helper to wrap custom types.

See Also
InputArray
template<typename _Tp >
static _OutputArray cv::rawOut ( _Tp &  v)
inlinestatic

Helper to wrap custom types.

See Also
InputArray
static std::string cv::toLowerCase ( const std::string &  str)
inlinestatic
static std::string cv::toUpperCase ( const std::string &  str)
inlinestatic
template<typename _Tp , int m, int n>
static double cv::trace ( const Matx< _Tp, m, n > &  a)
static