cv::cuda::BroxOpticalFlow Class Reference

Class computing the optical flow for two images using Brox et al Optical Flow algorithm ([13]). More...

#include "cudaoptflow.hpp"

Inheritance diagram for cv::cuda::BroxOpticalFlow:

Collaboration diagram for cv::cuda::BroxOpticalFlow:

Public Member Functions
virtual void	calc (InputArray I0, InputArray I1, InputOutputArray flow, Stream &stream=Stream::Null())=0
	Calculates a dense optical flow. More...
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 double	getFlowSmoothness () const =0
virtual double	getGradientConstancyImportance () const =0
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	getPyramidScaleFactor () const =0
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	setFlowSmoothness (double alpha)=0
virtual void	setGradientConstancyImportance (double gamma)=0
virtual void	setInnerIterations (int inner_iterations)=0
virtual void	setOuterIterations (int outer_iterations)=0
virtual void	setPyramidScaleFactor (double scale_factor)=0
virtual void	setSolverIterations (int solver_iterations)=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< BroxOpticalFlow >	create (double alpha=0.197, double gamma=50.0, double scale_factor=0.8, int inner_iterations=5, int outer_iterations=150, int solver_iterations=10)
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 the optical flow for two images using Brox et al Optical Flow algorithm ([13]).

Member Function Documentation

calc()

virtual void cv::cuda::DenseOpticalFlow::calc ( InputArray  I0, InputArray  I1, InputOutputArray  flow, Stream &  stream = Stream::Null()  )

pure virtualinherited

Calculates a dense optical flow.

Parameters

I0	first input image.
I1	second input image of the same size and the same type as I0.
flow	computed flow image that has the same size as I0 and type CV_32FC2.
stream	Stream for the asynchronous version.

clear()

virtual void cv::Algorithm::clear ( )

inlinevirtualinherited

Clears the algorithm state.

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

create()

static Ptr<BroxOpticalFlow> cv::cuda::BroxOpticalFlow::create ( double  alpha = 0.197, double  gamma = 50.0, double  scale_factor = 0.8, int  inner_iterations = 5, int  outer_iterations = 150, int  solver_iterations = 10  )

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, cv::BaseCascadeClassifier, and cv::cuda::DescriptorMatcher.

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.

getFlowSmoothness()

virtual double cv::cuda::BroxOpticalFlow::getFlowSmoothness ( ) const

pure virtual

getGradientConstancyImportance()

virtual double cv::cuda::BroxOpticalFlow::getGradientConstancyImportance ( ) const

pure virtual

getInnerIterations()

virtual int cv::cuda::BroxOpticalFlow::getInnerIterations ( ) const

pure virtual

number of lagged non-linearity iterations (inner loop)

getOuterIterations()

virtual int cv::cuda::BroxOpticalFlow::getOuterIterations ( ) const

pure virtual

number of warping iterations (number of pyramid levels)

getPyramidScaleFactor()

virtual double cv::cuda::BroxOpticalFlow::getPyramidScaleFactor ( ) const

pure virtual

getSolverIterations()

virtual int cv::cuda::BroxOpticalFlow::getSolverIterations ( ) const

pure virtual

number of linear system solver 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)

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

setFlowSmoothness()

virtual void cv::cuda::BroxOpticalFlow::setFlowSmoothness ( double  alpha )

pure virtual

setGradientConstancyImportance()

virtual void cv::cuda::BroxOpticalFlow::setGradientConstancyImportance ( double  gamma )

pure virtual

setInnerIterations()

virtual void cv::cuda::BroxOpticalFlow::setInnerIterations ( int  inner_iterations )

pure virtual

setOuterIterations()

virtual void cv::cuda::BroxOpticalFlow::setOuterIterations ( int  outer_iterations )

pure virtual

setPyramidScaleFactor()

virtual void cv::cuda::BroxOpticalFlow::setPyramidScaleFactor ( double  scale_factor )

pure virtual

setSolverIterations()

virtual void cv::cuda::BroxOpticalFlow::setSolverIterations ( int  solver_iterations )

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:

• cudaoptflow/include/opencv2/cudaoptflow.hpp