cv::superres::PyrLKOpticalFlow Class Reference

#include "optical_flow.hpp"

Inheritance diagram for cv::superres::PyrLKOpticalFlow:

Collaboration diagram for cv::superres::PyrLKOpticalFlow:

Public Member Functions
virtual void	calc (InputArray frame0, InputArray frame1, OutputArray flow1, OutputArray flow2=noArray())=0
virtual void	clear ()
	Clears the algorithm state. More...
virtual void	collectGarbage ()=0
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	getIterations () const =0
virtual int	getMaxLevel () const =0
virtual int	getWindowSize () const =0
virtual void	read (const FileNode &fn)
	Reads algorithm parameters from a file storage. More...
virtual void	save (const String &filename) const
	Saves the algorithm to a file. More...
virtual void	setIterations (int val)=0
virtual void	setMaxLevel (int val)=0
virtual void	setWindowSize (int val)=0
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
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

Member Function Documentation

calc()

virtual void cv::superres::DenseOpticalFlowExt::calc ( InputArray  frame0, InputArray  frame1, OutputArray  flow1, OutputArray  flow2 = noArray()  )

pure virtualinherited

clear()

virtual void cv::Algorithm::clear ( )

inlinevirtualinherited

Clears the algorithm state.

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

collectGarbage()

virtual void cv::superres::DenseOpticalFlowExt::collectGarbage ( )

pure virtualinherited

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.

getIterations()

virtual int cv::superres::PyrLKOpticalFlow::getIterations ( ) const

pure virtual

See also

setIterations

getMaxLevel()

virtual int cv::superres::PyrLKOpticalFlow::getMaxLevel ( ) const

pure virtual

See also

setMaxLevel

getWindowSize()

virtual int cv::superres::PyrLKOpticalFlow::getWindowSize ( ) const

pure virtual

See also

setWindowSize

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)

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).

setIterations()

virtual void cv::superres::PyrLKOpticalFlow::setIterations ( int  val )

pure virtual

See also

getIterations

setMaxLevel()

virtual void cv::superres::PyrLKOpticalFlow::setMaxLevel ( int  val )

pure virtual

See also

getMaxLevel

setWindowSize()

virtual void cv::superres::PyrLKOpticalFlow::setWindowSize ( int  val )

pure virtual

See also

getWindowSize

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:

• superres/include/opencv2/superres/optical_flow.hpp