OpenCV Reference Manual
v2.2
December, 2010
2
Contents
I C API Reference 43
1 core. The Core Functionality 45
1.1 Basic Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
CvPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
CvPoint2D32f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
CvPoint3D32f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
CvPoint2D64f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
CvPoint3D64f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
CvSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
CvSize2D32f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
CvRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
CvScalar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
CvTermCriteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
CvMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
CvMatND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
CvSparseMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
IplImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
CvArr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.2 Operations on Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
cv::AbsDiff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
cv::AbsDiffS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
cv::Add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
cv::AddS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
cv::AddWeighted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
cv::And . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
cv::AndS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
cv::Avg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
cv::AvgSdv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
cv::CalcCovarMatrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
3
4 CONTENTS
cv::CartToPolar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
cv::Cbrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
cv::ClearND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
cv::CloneImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
cv::CloneMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
cv::CloneMatND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
cv::CloneSparseMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
cv::Cmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
cv::CmpS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
cv::ConvertScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
cv::ConvertScaleAbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
cv::CvtScaleAbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
cv::Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
cv::CountNonZero . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
cv::CreateData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
cv::CreateImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
cv::CreateImageHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
cv::CreateMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
cv::CreateMatHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
cv::CreateMatND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
cv::CreateMatNDHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
cv::CreateSparseMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
cv::CrossProduct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
CvtPixToPlane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
cv::DCT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
cv::DFT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
cv::DecRefData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
cv::Det . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
cv::Div . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
cv::DotProduct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
cv::EigenVV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
cv::Exp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
cv::FastArctan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
cv::Flip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
cv::GEMM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
cv::Get?D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
cv::GetCol(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
cv::GetDiag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
cvGetDims, cvGetDimSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
cv::GetElemType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
CONTENTS 5
cv::GetImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
cv::GetImageCOI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
cv::GetImageROI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
cv::GetMat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
cv::GetNextSparseNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
cv::GetOptimalDFTSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
cv::GetRawData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
cv::GetReal1D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
cv::GetReal2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
cv::GetReal3D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
cv::GetRealND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
cv::GetRow(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
cv::GetSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
cv::GetSubRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
cv::InRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
cv::InRangeS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
cv::IncRefData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
cv::InitImageHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
cv::InitMatHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
cv::InitMatNDHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
cv::InitSparseMatIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
cv::InvSqrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
cv::Inv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
cv::Invert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
cv::IsInf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
cv::IsNaN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
cv::LUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
cv::Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
cv::Mahalanobis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
cv::Mat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
cv::Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
cv::MaxS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
cv::Merge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
cv::Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
cv::MinMaxLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
cv::MinS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Mirror . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
cv::MixChannels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
MulAddS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
cv::Mul . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
