Implementation of the Zach, Pock and Bischof Dual TV-L1 Optical Flow method. More...

#include "cudaoptflow.hpp"

Inheritance diagram for cv::cuda::OpticalFlowDual_TVL1:

Collaboration diagram for cv::cuda::OpticalFlowDual_TVL1:

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	getEpsilon () const =0
	Stopping criterion threshold used in the numerical scheme, which is a trade-off between precision and running time. More...

virtual double	getGamma () const =0
	Weight parameter for (u - v)^2, tightness parameter. More...

virtual double	getLambda () const =0
	Weight parameter for the data term, attachment parameter. More...

virtual int	getNumIterations () const =0
	Stopping criterion iterations number used in the numerical scheme. More...

virtual int	getNumScales () const =0
	Number of scales used to create the pyramid of images. More...

virtual int	getNumWarps () const =0
	Number of warpings per scale. More...

virtual double	getScaleStep () const =0

virtual double	getTau () const =0
	Time step of the numerical scheme. More...

virtual double	getTheta () const =0
	parameter used for motion estimation. More...

virtual bool	getUseInitialFlow () 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	setEpsilon (double epsilon)=0

virtual void	setGamma (double gamma)=0

virtual void	setLambda (double lambda)=0

virtual void	setNumIterations (int iterations)=0

virtual void	setNumScales (int nscales)=0

virtual void	setNumWarps (int warps)=0

virtual void	setScaleStep (double scaleStep)=0

virtual void	setTau (double tau)=0

virtual void	setTheta (double theta)=0

virtual void	setUseInitialFlow (bool useInitialFlow)=0

virtual void	write (FileStorage &fs) const
	Stores algorithm parameters in a file storage. More...

Static Public Member Functions
static Ptr< OpticalFlowDual_TVL1 >	create (double tau=0.25, double lambda=0.15, double theta=0.3, int nscales=5, int warps=5, double epsilon=0.01, int iterations=300, double scaleStep=0.8, double gamma=0.0, bool useInitialFlow=false)

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

Implementation of the Zach, Pock and Bischof Dual TV-L1 Optical Flow method.

See also: C. Zach, T. Pock and H. Bischof, "A Duality Based Approach for Realtime TV-L1 Optical Flow".; Javier Sanchez, Enric Meinhardt-Llopis and Gabriele Facciolo. "TV-L1 Optical Flow Estimation".

Member Function Documentation

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.

virtual void cv::Algorithm::clear ( )

inlinevirtualinherited

Clears the algorithm state.

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

static Ptr<OpticalFlowDual_TVL1> cv::cuda::OpticalFlowDual_TVL1::create	(	double	tau = `0.25`,
		double	lambda = `0.15`,
		double	theta = `0.3`,
		int	nscales = `5`,
		int	warps = `5`,
		double	epsilon = `0.01`,
		int	iterations = `300`,
		double	scaleStep = `0.8`,
		double	gamma = `0.0`,
		bool	useInitialFlow = `false`
	)

static

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 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::cuda::OpticalFlowDual_TVL1::getEpsilon ( ) const

pure virtual

Stopping criterion threshold used in the numerical scheme, which is a trade-off between precision and running time.

A small value will yield more accurate solutions at the expense of a slower convergence.

virtual double cv::cuda::OpticalFlowDual_TVL1::getGamma ( ) const

pure virtual

Weight parameter for (u - v)^2, tightness parameter.

It serves as a link between the attachment and the regularization terms. In theory, it should have a small value in order to maintain both parts in correspondence. The method is stable for a large range of values of this parameter.

virtual double cv::cuda::OpticalFlowDual_TVL1::getLambda ( ) const

pure virtual

Weight parameter for the data term, attachment parameter.

This is the most relevant parameter, which determines the smoothness of the output. The smaller this parameter is, the smoother the solutions we obtain. It depends on the range of motions of the images, so its value should be adapted to each image sequence.

virtual int cv::cuda::OpticalFlowDual_TVL1::getNumIterations ( ) const

pure virtual

Stopping criterion iterations number used in the numerical scheme.

virtual int cv::cuda::OpticalFlowDual_TVL1::getNumScales ( ) const

pure virtual

Number of scales used to create the pyramid of images.

virtual int cv::cuda::OpticalFlowDual_TVL1::getNumWarps ( ) const

pure virtual

Number of warpings per scale.

Represents the number of times that I1(x+u0) and grad( I1(x+u0) ) are computed per scale. This is a parameter that assures the stability of the method. It also affects the running time, so it is a compromise between speed and accuracy.

virtual double cv::cuda::OpticalFlowDual_TVL1::getScaleStep ( ) const

pure virtual

virtual double cv::cuda::OpticalFlowDual_TVL1::getTau ( ) const

pure virtual

Time step of the numerical scheme.

virtual double cv::cuda::OpticalFlowDual_TVL1::getTheta ( ) const

pure virtual

parameter used for motion estimation.

It adds a variable allowing for illumination variations Set this parameter to 1. if you have varying illumination. See: Chambolle et al, A First-Order Primal-Dual Algorithm for Convex Problems with Applications to Imaging Journal of Mathematical imaging and vision, may 2011 Vol 40 issue 1, pp 120-145

virtual bool cv::cuda::OpticalFlowDual_TVL1::getUseInitialFlow ( ) const

pure virtual

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

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::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::cuda::OpticalFlowDual_TVL1::setEpsilon ( double epsilon )

pure virtual

virtual void cv::cuda::OpticalFlowDual_TVL1::setGamma ( double gamma )

pure virtual

virtual void cv::cuda::OpticalFlowDual_TVL1::setLambda ( double lambda )

pure virtual

virtual void cv::cuda::OpticalFlowDual_TVL1::setNumIterations ( int iterations )

pure virtual

virtual void cv::cuda::OpticalFlowDual_TVL1::setNumScales ( int nscales )

pure virtual

virtual void cv::cuda::OpticalFlowDual_TVL1::setNumWarps ( int warps )

pure virtual

virtual void cv::cuda::OpticalFlowDual_TVL1::setScaleStep ( double scaleStep )

pure virtual

virtual void cv::cuda::OpticalFlowDual_TVL1::setTau ( double tau )

pure virtual

virtual void cv::cuda::OpticalFlowDual_TVL1::setTheta ( double theta )

pure virtual

virtual void cv::cuda::OpticalFlowDual_TVL1::setUseInitialFlow ( bool useInitialFlow )

pure virtual

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:

cudaoptflow/include/opencv2/cudaoptflow.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation