OpenCV  3.2.0-dev
Open Source Computer Vision
cv::superres::BroxOpticalFlow Class Referenceabstract

#include "optical_flow.hpp"

Inheritance diagram for cv::superres::BroxOpticalFlow:
Collaboration diagram for cv::superres::BroxOpticalFlow:

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 double getAlpha () const =0
 Flow smoothness. More...
 
virtual String getDefaultName () const
 Returns the algorithm string identifier. More...
 
virtual double getGamma () const =0
 Gradient constancy importance. More...
 
virtual int getInnerIterations () const =0
 Number of lagged non-linearity iterations (inner loop) More...
 
virtual int getOuterIterations () const =0
 Number of warping iterations (number of pyramid levels) More...
 
virtual double getScaleFactor () const =0
 Pyramid scale factor. More...
 
virtual int getSolverIterations () const =0
 Number of linear system solver iterations. More...
 
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 setAlpha (double val)=0
 Flow smoothness. More...
 
virtual void setGamma (double val)=0
 Gradient constancy importance. More...
 
virtual void setInnerIterations (int val)=0
 Number of lagged non-linearity iterations (inner loop) More...
 
virtual void setOuterIterations (int val)=0
 Number of warping iterations (number of pyramid levels) More...
 
virtual void setScaleFactor (double val)=0
 Pyramid scale factor. More...
 
virtual void setSolverIterations (int val)=0
 Number of linear system solver iterations. More...
 
virtual void write (FileStorage &fs) const
 Stores algorithm parameters in a file storage. 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

virtual void cv::superres::DenseOpticalFlowExt::calc ( InputArray  frame0,
InputArray  frame1,
OutputArray  flow1,
OutputArray  flow2 = noArray() 
)
pure virtualinherited
virtual void cv::Algorithm::clear ( )
inlinevirtualinherited

Clears the algorithm state.

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

virtual void cv::superres::DenseOpticalFlowExt::collectGarbage ( )
pure virtualinherited
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, cv::BaseCascadeClassifier, and cv::cuda::DescriptorMatcher.

virtual double cv::superres::BroxOpticalFlow::getAlpha ( ) const
pure virtual

Flow smoothness.

See also
setAlpha
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.

virtual double cv::superres::BroxOpticalFlow::getGamma ( ) const
pure virtual

Gradient constancy importance.

See also
setGamma
virtual int cv::superres::BroxOpticalFlow::getInnerIterations ( ) const
pure virtual

Number of lagged non-linearity iterations (inner loop)

See also
setInnerIterations
virtual int cv::superres::BroxOpticalFlow::getOuterIterations ( ) const
pure virtual

Number of warping iterations (number of pyramid levels)

See also
setOuterIterations
virtual double cv::superres::BroxOpticalFlow::getScaleFactor ( ) const
pure virtual

Pyramid scale factor.

See also
setScaleFactor
virtual int cv::superres::BroxOpticalFlow::getSolverIterations ( ) const
pure virtual

Number of linear system solver iterations.

See also
setSolverIterations
template<typename _Tp >
static Ptr<_Tp> cv::Algorithm::load ( const String filename,
const String objname = String() 
)
inlinestaticinherited

Loads algorithm from the file.

Parameters
filenameName of the file to read.
objnameThe 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::Ptr< T >::empty(), cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), and cv::FileStorage::READ.

Here is the call graph for this function:

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

Loads algorithm from a String.

Parameters
strModelThe string variable containing the model you want to load.
objnameThe 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::Ptr< T >::empty(), cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::MEMORY, and cv::FileStorage::READ.

Here is the call graph for this function:

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.

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)

References cv::Ptr< T >::empty().

Here is the call graph for this function:

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

virtual void cv::superres::BroxOpticalFlow::setAlpha ( double  val)
pure virtual

Flow smoothness.

See also
getAlpha
virtual void cv::superres::BroxOpticalFlow::setGamma ( double  val)
pure virtual

Gradient constancy importance.

See also
getGamma
virtual void cv::superres::BroxOpticalFlow::setInnerIterations ( int  val)
pure virtual

Number of lagged non-linearity iterations (inner loop)

See also
getInnerIterations
virtual void cv::superres::BroxOpticalFlow::setOuterIterations ( int  val)
pure virtual

Number of warping iterations (number of pyramid levels)

See also
getOuterIterations
virtual void cv::superres::BroxOpticalFlow::setScaleFactor ( double  val)
pure virtual

Pyramid scale factor.

See also
getScaleFactor
virtual void cv::superres::BroxOpticalFlow::setSolverIterations ( int  val)
pure virtual

Number of linear system solver iterations.

See also
getSolverIterations
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.

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

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