OpenCV: cv::ConjGradSolver Class Reference

| OpenCV 3.4.2 Open Source Computer Vision

Static Public Member Functions | List of all members
cv::ConjGradSolver Class Reference
Core functionality » Optimization Algorithms

This class is used to perform the non-linear non-constrained minimization of a function with known gradient,. More...

`#include "optim.hpp"`

Inheritance diagram for cv::ConjGradSolver:

## Static Public Member Functions
static Ptr< ConjGradSolver > | create (const Ptr< MinProblemSolver::Function > &f=Ptr< ConjGradSolver::Function >(), TermCriteria termcrit=TermCriteria(TermCriteria::MAX_ITER+TermCriteria::EPS, 5000, 0.000001))
| This function returns the reference to the ready-to-use ConjGradSolver object. More...
Static Public Member Functions inherited from cv::Algorithm
template<typename _Tp >
static Ptr< _Tp > | load (const String &filename, const String &objname=String())
| Loads algorithm from the file. More...
template<typename _Tp >
static Ptr< _Tp > | loadFromString (const String &strModel, const String &objname=String())
| Loads algorithm from a String. More...
template<typename _Tp >
static Ptr< _Tp > | read (const FileNode &fn)
| Reads algorithm from the file node. More...

## Additional Inherited Members
Public Member Functions inherited from cv::MinProblemSolver
virtual Ptr< Function > | getFunction () const =0
| Getter for the optimized function. More...
virtual TermCriteria | getTermCriteria () const =0
| Getter for the previously set terminal criteria for this algorithm. More...
virtual double | minimize (InputOutputArray x)=0
| actually runs the algorithm and performs the minimization. More...
virtual void | setFunction (const Ptr< Function > &f)=0
| Setter for the optimized function. More...
virtual void | setTermCriteria (const TermCriteria &termcrit)=0
| Set terminal criteria for solver. More...
Public Member Functions inherited from cv::Algorithm
| Algorithm ()
virtual | ~Algorithm ()
virtual void | clear ()
| Clears the algorithm state. More...
virtual bool | empty () const
| Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read. More...
virtual String | getDefaultName () const
virtual void | read (const FileNode &fn)
| Reads algorithm parameters from a file storage. More...
virtual void | save (const String &filename) const
virtual void | write (FileStorage &fs) const
| Stores algorithm parameters in a file storage. More...
void | write (const Ptr< FileStorage > &fs, const String &name=String()) const
| simplified API for language bindings This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
Protected Member Functions inherited from cv::Algorithm
void | writeFormat (FileStorage &fs) const

## Detailed Description

This class is used to perform the non-linear non-constrained minimization of a function with known gradient,.

defined on an n-dimensional Euclidean space, using the Nonlinear Conjugate Gradient method. The implementation was done based on the beautifully clear explanatory article [An Introduction to the Conjugate Gradient Method Without the Agonizing Pain](http://www.cs.cmu.edu/~quake-papers/painless-conjugate-gradient.pdf) by Jonathan Richard Shewchuk. The method can be seen as an adaptation of a standard Conjugate Gradient method (see, for example http://en.wikipedia.org/wiki/Conjugate_gradient_method) for numerically solving the systems of linear equations.

It should be noted, that this method, although deterministic, is rather a heuristic method and therefore may converge to a local minima, not necessary a global one. What is even more disastrous, most of its behaviour is ruled by gradient, therefore it essentially cannot distinguish between local minima and maxima. Therefore, if it starts sufficiently near to the local maximum, it may converge to it. Another obvious restriction is that it should be possible to compute the gradient of a function at any point, thus it is preferable to have analytic expression for gradient and computational burden should be born by the user.

The latter responsibility is accompilished via the getGradient method of a MinProblemSolver::Function interface (which represents function being optimized). This method takes point a point in n-dimensional space (first argument represents the array of coordinates of that point) and comput its gradient (it should be stored in the second argument as an array).

Note
  class ConjGradSolver thus does not add any new methods to the basic MinProblemSolver interface.
  term criteria should meet following condition:
  termcrit.type == (TermCriteria::MAX_ITER + TermCriteria::EPS) && termcrit.epsilon > 0 && termcrit.maxCount > 0
  // or
  termcrit.type == TermCriteria::MAX_ITER) && termcrit.maxCount > 0

## Member Function Documentation

## ◆ create()

static Ptr<ConjGradSolver> cv::ConjGradSolver::create | ( | const Ptr< MinProblemSolver::Function > & | f = `Ptr< ConjGradSolver::Function >()`,
|  | TermCriteria | termcrit = `TermCriteria(TermCriteria::MAX_ITER+TermCriteria::EPS, 5000, 0.000001)`
| ) |  |
| static

This function returns the reference to the ready-to-use ConjGradSolver object.

All the parameters are optional, so this procedure can be called even without parameters at all. In this case, the default values will be used. As default value for terminal criteria are the only sensible ones, MinProblemSolver::setFunction() should be called upon the obtained object, if the function was not given to create(). Otherwise, the two ways (submit it to create() or miss it out and call the MinProblemSolver::setFunction()) are absolutely equivalent (and will drop the same errors in the same way, should invalid input be detected).

Parameters

  f | Pointer to the function that will be minimized, similarly to the one you submit via MinProblemSolver::setFunction.
  termcrit | Terminal criteria to the algorithm, similarly to the one you submit via MinProblemSolver::setTermCriteria.

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

- core/include/opencv2/core/optim.hpp