cv::LMSolver Class Reference

Levenberg-Marquardt solver. More...

#include <opencv2/calib3d.hpp>

Inheritance diagram for cv::LMSolver:

Collaboration diagram for cv::LMSolver:

Classes
class	Callback

Public Member Functions
virtual void	clear ()
	Clears the algorithm state. More...
virtual bool	empty () const
	Returns true if the Algorithm is empty (e.g. More...
virtual String	getDefaultName () const
	Returns the algorithm string identifier. More...
virtual int	getMaxIters () const =0
	Retrieves the current maximum number of iterations. More...
virtual void	read (const FileNode &fn)
	Reads algorithm parameters from a file storage. More...
virtual int	run (InputOutputArray param) const =0
	Runs Levenberg-Marquardt algorithm using the passed vector of parameters as the start point. More...
virtual void	save (const String &filename) const
	Saves the algorithm to a file. More...
virtual void	setMaxIters (int maxIters)=0
	Sets the maximum number of iterations. More...
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...

Static Public Member Functions
static Ptr< LMSolver >	create (const Ptr< LMSolver::Callback > &cb, int maxIters)
	Creates Levenberg-Marquard solver. More...
static Ptr< LMSolver >	create (const Ptr< LMSolver::Callback > &cb, int maxIters, double eps)
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...

Protected Member Functions
void	writeFormat (FileStorage &fs) const

Detailed Description

Levenberg-Marquardt solver.

Starting with the specified vector of parameters it optimizes the target vector criteria "err" (finds local minima of each target vector component absolute value).

When needed, it calls user-provided callback.

Member Function Documentation

clear()

virtual void cv::Algorithm::clear ( )

inlinevirtualinherited

Clears the algorithm state.

Reimplemented in cv::FlannBasedMatcher, and cv::DescriptorMatcher.

create() [1/2]

static Ptr<LMSolver> cv::LMSolver::create ( const Ptr< LMSolver::Callback > &  cb, int  maxIters  )

static

Creates Levenberg-Marquard solver.

Parameters

cb	callback
maxIters	maximum number of iterations that can be further modified using setMaxIters() method.

create() [2/2]

static Ptr<LMSolver> cv::LMSolver::create ( const Ptr< LMSolver::Callback > &  cb, int  maxIters, double  eps  )

static

empty()

virtual bool cv::Algorithm::empty ( ) const

inlinevirtualinherited

Returns true if the Algorithm is empty (e.g.

in the very beginning or after unsuccessful read

Reimplemented in cv::DescriptorMatcher, cv::ml::StatModel, cv::Feature2D, and cv::BaseCascadeClassifier.

getDefaultName()

virtual String cv::Algorithm::getDefaultName ( ) const

virtualinherited

Returns the algorithm string identifier.

This string is used as top level xml/yml node tag when the object is saved to a file or string.

Reimplemented in cv::AKAZE, cv::KAZE, cv::SimpleBlobDetector, cv::GFTTDetector, cv::AgastFeatureDetector, cv::FastFeatureDetector, cv::MSER, cv::ORB, cv::BRISK, and cv::Feature2D.

getMaxIters()

virtual int cv::LMSolver::getMaxIters ( ) const

pure virtual

Retrieves the current maximum number of iterations.

load()

template<typename _Tp >

static Ptr<_Tp> cv::Algorithm::load ( const String &  filename, const String &  objname = String()  )

inlinestaticinherited

Loads algorithm from the file.

Parameters

filename	Name of the file to read.
objname	The optional name of the node to read (if empty, the first top-level node will be used)

This is static template method of Algorithm. It's usage is following (in the case of SVM):

Ptr<SVM> svm = Algorithm::load<SVM>("my_svm_model.xml");

In order to make this method work, the derived class must overwrite Algorithm::read(const FileNode& fn).

References CV_Assert, cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::isOpened(), and cv::FileStorage::READ.

Here is the call graph for this function:

loadFromString()

template<typename _Tp >

static Ptr<_Tp> cv::Algorithm::loadFromString ( const String &  strModel, const String &  objname = String()  )

inlinestaticinherited

Loads algorithm from a String.

Parameters

strModel	The string variable containing the model you want to load.
objname	The optional name of the node to read (if empty, the first top-level node will be used)

This is static template method of Algorithm. It's usage is following (in the case of SVM):

Ptr<SVM> svm = Algorithm::loadFromString<SVM>(myStringModel);

References CV_WRAP, cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::MEMORY, and cv::FileStorage::READ.

Here is the call graph for this function:

read() [1/2]

virtual void cv::Algorithm::read ( const FileNode &  fn )

inlinevirtualinherited

Reads algorithm parameters from a file storage.

Reimplemented in cv::FlannBasedMatcher, cv::DescriptorMatcher, and cv::Feature2D.

read() [2/2]

template<typename _Tp >

static Ptr<_Tp> cv::Algorithm::read ( const FileNode &  fn )

inlinestaticinherited

Reads algorithm from the file node.

This is static template method of Algorithm. It's usage is following (in the case of SVM):

cv::FileStorage fsRead("example.xml", FileStorage::READ);
Ptr<SVM> svm = Algorithm::read<SVM>(fsRead.root());

In order to make this method work, the derived class must overwrite Algorithm::read(const FileNode& fn) and also have static create() method without parameters (or with all the optional parameters)

run()

virtual int cv::LMSolver::run ( InputOutputArray  param ) const

pure virtual

Runs Levenberg-Marquardt algorithm using the passed vector of parameters as the start point.

The final vector of parameters (whether the algorithm converged or not) is stored at the same vector. The method returns the number of iterations used. If it's equal to the previously specified maxIters, there is a big chance the algorithm did not converge.

Parameters

param

initial/final vector of parameters.

Note that the dimensionality of parameter space is defined by the size of param vector, and the dimensionality of optimized criteria is defined by the size of err vector computed by the callback.

save()

virtual void cv::Algorithm::save ( const String &  filename ) const

virtualinherited

Saves the algorithm to a file.

In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

setMaxIters()

virtual void cv::LMSolver::setMaxIters ( int  maxIters )

pure virtual

Sets the maximum number of iterations.

Parameters

maxIters

the number of iterations

write() [1/2]

virtual void cv::Algorithm::write ( FileStorage &  fs ) const

inlinevirtualinherited

Stores algorithm parameters in a file storage.

Reimplemented in cv::FlannBasedMatcher, cv::DescriptorMatcher, and cv::Feature2D.

References CV_WRAP.

Referenced by cv::Feature2D::write(), and cv::DescriptorMatcher::write().

Here is the caller graph for this function:

write() [2/2]

void cv::Algorithm::write ( const Ptr< FileStorage > &  fs, const String &  name = String()  ) const

inherited

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.

writeFormat()

void cv::Algorithm::writeFormat ( FileStorage &  fs ) const

protectedinherited

---

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

• opencv2/calib3d.hpp