OpenCV  4.1.1-pre
Open Source Computer Vision
Looking for a C++ dev who knows OpenCV?
I'm looking for work. Hire me!
cv::FarnebackOpticalFlow Class Referenceabstract

Class computing a dense optical flow using the Gunnar Farneback's algorithm. More...

#include <opencv2/video/tracking.hpp>

Inheritance diagram for cv::FarnebackOpticalFlow:
Collaboration diagram for cv::FarnebackOpticalFlow:

Public Member Functions

virtual void calc (InputArray I0, InputArray I1, InputOutputArray flow)=0
 Calculates an optical flow. More...
 
virtual void clear ()
 Clears the algorithm state. More...
 
virtual void collectGarbage ()=0
 Releases all inner buffers. 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 bool getFastPyramids () const =0
 
virtual int getFlags () const =0
 
virtual int getNumIters () const =0
 
virtual int getNumLevels () const =0
 
virtual int getPolyN () const =0
 
virtual double getPolySigma () const =0
 
virtual double getPyrScale () const =0
 
virtual int getWinSize () 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 setFastPyramids (bool fastPyramids)=0
 
virtual void setFlags (int flags)=0
 
virtual void setNumIters (int numIters)=0
 
virtual void setNumLevels (int numLevels)=0
 
virtual void setPolyN (int polyN)=0
 
virtual void setPolySigma (double polySigma)=0
 
virtual void setPyrScale (double pyrScale)=0
 
virtual void setWinSize (int winSize)=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

static Ptr< FarnebackOpticalFlowcreate (int numLevels=5, double pyrScale=0.5, bool fastPyramids=false, int winSize=13, int numIters=10, int polyN=5, double polySigma=1.1, int flags=0)
 
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

Class computing a dense optical flow using the Gunnar Farneback's algorithm.

Member Function Documentation

◆ calc()

virtual void cv::DenseOpticalFlow::calc ( InputArray  I0,
InputArray  I1,
InputOutputArray  flow 
)
pure virtualinherited

Calculates an optical flow.

Parameters
I0first 8-bit single-channel input image.
I1second input image of the same size and the same type as prev.
flowcomputed flow image that has the same size as prev and type CV_32FC2.

◆ clear()

virtual void cv::Algorithm::clear ( )
inlinevirtualinherited

Clears the algorithm state.

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

◆ collectGarbage()

virtual void cv::DenseOpticalFlow::collectGarbage ( )
pure virtualinherited

Releases all inner buffers.

◆ create()

static Ptr<FarnebackOpticalFlow> cv::FarnebackOpticalFlow::create ( int  numLevels = 5,
double  pyrScale = 0.5,
bool  fastPyramids = false,
int  winSize = 13,
int  numIters = 10,
int  polyN = 5,
double  polySigma = 1.1,
int  flags = 0 
)
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.

◆ getFastPyramids()

virtual bool cv::FarnebackOpticalFlow::getFastPyramids ( ) const
pure virtual

◆ getFlags()

virtual int cv::FarnebackOpticalFlow::getFlags ( ) const
pure virtual

◆ getNumIters()

virtual int cv::FarnebackOpticalFlow::getNumIters ( ) const
pure virtual

◆ getNumLevels()

virtual int cv::FarnebackOpticalFlow::getNumLevels ( ) const
pure virtual

◆ getPolyN()

virtual int cv::FarnebackOpticalFlow::getPolyN ( ) const
pure virtual

◆ getPolySigma()

virtual double cv::FarnebackOpticalFlow::getPolySigma ( ) const
pure virtual

◆ getPyrScale()

virtual double cv::FarnebackOpticalFlow::getPyrScale ( ) const
pure virtual

◆ getWinSize()

virtual int cv::FarnebackOpticalFlow::getWinSize ( ) const
pure virtual

◆ load()

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

◆ setFastPyramids()

virtual void cv::FarnebackOpticalFlow::setFastPyramids ( bool  fastPyramids)
pure virtual

◆ setFlags()

virtual void cv::FarnebackOpticalFlow::setFlags ( int  flags)
pure virtual

◆ setNumIters()

virtual void cv::FarnebackOpticalFlow::setNumIters ( int  numIters)
pure virtual

◆ setNumLevels()

virtual void cv::FarnebackOpticalFlow::setNumLevels ( int  numLevels)
pure virtual

◆ setPolyN()

virtual void cv::FarnebackOpticalFlow::setPolyN ( int  polyN)
pure virtual

◆ setPolySigma()

virtual void cv::FarnebackOpticalFlow::setPolySigma ( double  polySigma)
pure virtual

◆ setPyrScale()

virtual void cv::FarnebackOpticalFlow::setPyrScale ( double  pyrScale)
pure virtual

◆ setWinSize()

virtual void cv::FarnebackOpticalFlow::setWinSize ( int  winSize)
pure virtual

◆ 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: