The class defining termination criteria for iterative algorithms. More...

#include <opencv2/core/types.hpp>

Collaboration diagram for cv::TermCriteria:

Public Types
enum	Type { COUNT =1, MAX_ITER =COUNT, EPS =2 }
	Criteria type, can be one of: COUNT, EPS or COUNT + EPS. More...

Public Member Functions
	TermCriteria ()
	default constructor More...

	TermCriteria (int type, int maxCount, double epsilon)

bool	isValid () const

Public Attributes
double	epsilon
	the desired accuracy More...

int	maxCount
	the maximum number of iterations/elements More...

int	type
	the type of termination criteria: COUNT, EPS or COUNT + EPS More...

Detailed Description

The class defining termination criteria for iterative algorithms.

You can initialize it by default constructor and then override any parameters, or the structure may be fully initialized using the advanced variant of the constructor.

Examples:: samples/cpp/camshiftdemo.cpp, samples/cpp/image_alignment.cpp, samples/cpp/kmeans.cpp, samples/cpp/lkdemo.cpp, and samples/cpp/train_HOG.cpp.

Member Enumeration Documentation

◆ Type

enum cv::TermCriteria::Type

Criteria type, can be one of: COUNT, EPS or COUNT + EPS.

Enumerator
COUNT	the maximum number of iterations or elements to compute
MAX_ITER	ditto
EPS	the desired accuracy or change in parameters at which the iterative algorithm stops

Constructor & Destructor Documentation

◆ TermCriteria() [1/2]

cv::TermCriteria::TermCriteria ( )

default constructor

◆ TermCriteria() [2/2]

cv::TermCriteria::TermCriteria	(	int	type,
		int	maxCount,
		double	epsilon
	)

Parameters

type	The type of termination criteria, one of TermCriteria::Type
maxCount	The maximum number of iterations or elements to compute.
epsilon	The desired accuracy or change in parameters at which the iterative algorithm stops.

Member Function Documentation

◆ isValid()

bool cv::TermCriteria::isValid ( ) const

inline

References cvIsNaN().

Here is the call graph for this function:

Member Data Documentation

◆ epsilon

double cv::TermCriteria::epsilon

the desired accuracy

◆ maxCount

int cv::TermCriteria::maxCount

the maximum number of iterations/elements

◆ type

int cv::TermCriteria::type

the type of termination criteria: COUNT, EPS or COUNT + EPS

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

opencv2/core/types.hpp

Public Types

Public Member Functions

Public Attributes