generic-library/opencv
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documented the TermCriteria class (#2560)

Browse Source
This commit is contained in:
Ilya Lysenkov 2013-02-01 10:16:30 +04:00
parent d8f749da52
commit b24e4bddb1
2 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
modules/core/doc/basic_structures.rst
View File

@ -219,7 +219,31 @@ TermCriteria
------------
.. ocv:class:: TermCriteria
Template class defining termination criteria for iterative algorithms.
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.
TermCriteria::TermCriteria
--------------------------
The constructors.
.. ocv:function:: TermCriteria::TermCriteria()
.. ocv:function:: TermCriteria::TermCriteria(int type, int maxCount, double epsilon)
.. ocv:function:: TermCriteria::TermCriteria(const CvTermCriteria& criteria)
:param type: The type of termination criteria: ``TermCriteria::COUNT``, ``TermCriteria::EPS`` or ``TermCriteria::COUNT`` + ``TermCriteria::EPS``.
:param maxCount: The maximum number of iterations or elements to compute.
:param epsilon: The desired accuracy or change in parameters at which the iterative algorithm stops.
:param criteria: Termination criteria in the deprecated ``CvTermCriteria`` format.
TermCriteria::operator CvTermCriteria
-------------------------------------
Converts to the deprecated ``CvTermCriteria`` format.
.. ocv:function:: TermCriteria::operator CvTermCriteria() const
Matx
----

4
modules/core/include/opencv2/core/core.hpp
View File

@ -2037,10 +2037,10 @@ public:
//! default constructor
TermCriteria();
//! full constructor
TermCriteria(int _type, int _maxCount, double _epsilon);
TermCriteria(int type, int maxCount, double epsilon);
//! conversion from CvTermCriteria
TermCriteria(const CvTermCriteria& criteria);
//! conversion from CvTermCriteria
//! conversion to CvTermCriteria
operator CvTermCriteria() const;
int type; //!< the type of termination criteria: COUNT, EPS or COUNT + EPS