"Dual TV L1" Optical Flow Algorithm. More...

#include "tracking.hpp"

Inheritance diagram for cv::DualTVL1OpticalFlow:

Collaboration diagram for cv::DualTVL1OpticalFlow:

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 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
	coefficient for additional illumination variation term More...

virtual int	getInnerIterations () const =0
	Inner iterations (between outlier filtering) used in the numerical scheme. More...

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

virtual int	getMedianFiltering () const =0
	Median filter kernel size (1 = no filter) (3 or 5) More...

virtual int	getOuterIterations () const =0
	Outer iterations (number of inner loops) used in the numerical scheme. More...

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

virtual double	getScaleStep () const =0
	Step between scales (<1) More...

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

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

virtual bool	getUseInitialFlow () const =0
	Use initial flow. More...

virtual int	getWarpingsNumber () const =0
	Number of warpings per scale. 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	setEpsilon (double val)=0
	Stopping criterion threshold used in the numerical scheme, which is a trade-off between precision and running time. More...

virtual void	setGamma (double val)=0
	coefficient for additional illumination variation term More...

virtual void	setInnerIterations (int val)=0
	Inner iterations (between outlier filtering) used in the numerical scheme. More...

virtual void	setLambda (double val)=0
	Weight parameter for the data term, attachment parameter. More...

virtual void	setMedianFiltering (int val)=0
	Median filter kernel size (1 = no filter) (3 or 5) More...

virtual void	setOuterIterations (int val)=0
	Outer iterations (number of inner loops) used in the numerical scheme. More...

virtual void	setScalesNumber (int val)=0
	Number of scales used to create the pyramid of images. More...

virtual void	setScaleStep (double val)=0
	Step between scales (<1) More...

virtual void	setTau (double val)=0
	Time step of the numerical scheme. More...

virtual void	setTheta (double val)=0
	Weight parameter for (u - v)^2, tightness parameter. More...

virtual void	setUseInitialFlow (bool val)=0
	Use initial flow. More...

virtual void	setWarpingsNumber (int val)=0
	Number of warpings per scale. More...

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

Static Public Member Functions
static Ptr< DualTVL1OpticalFlow >	create (double tau=0.25, double lambda=0.15, double theta=0.3, int nscales=5, int warps=5, double epsilon=0.01, int innnerIterations=30, int outerIterations=10, double scaleStep=0.8, double gamma=0.0, int medianFiltering=5, bool useInitialFlow=false)
	Creates instance of cv::DualTVL1OpticalFlow. More...

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

"Dual TV L1" Optical Flow Algorithm.

The class implements the "Dual TV L1" optical flow algorithm described in [94] and [74] . Here are important members of the class that control the algorithm, which you can set after constructing the class instance:

member double tau Time step of the numerical scheme.
member double lambda 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.
member double theta 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.
member int nscales Number of scales used to create the pyramid of images.
member int warps 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.
member double epsilon 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.
member int iterations Stopping criterion iterations number used in the numerical scheme.

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::DenseOpticalFlow::calc	(	InputArray	I0,
		InputArray	I1,
		InputOutputArray	flow
	)

pure virtualinherited

Calculates an optical flow.

Parameters

I0	first 8-bit single-channel input image.
I1	second input image of the same size and the same type as prev.
flow	computed flow image that has the same size as prev and type CV_32FC2.

virtual void cv::Algorithm::clear ( )

inlinevirtualinherited

Clears the algorithm state.

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

virtual void cv::DenseOpticalFlow::collectGarbage ( )

pure virtualinherited

Releases all inner buffers.

static Ptr<DualTVL1OpticalFlow> cv::DualTVL1OpticalFlow::create	(	double	tau = `0.25`,
		double	lambda = `0.15`,
		double	theta = `0.3`,
		int	nscales = `5`,
		int	warps = `5`,
		double	epsilon = `0.01`,
		int	innnerIterations = `30`,
		int	outerIterations = `10`,
		double	scaleStep = `0.8`,
		double	gamma = `0.0`,
		int	medianFiltering = `5`,
		bool	useInitialFlow = `false`
	)

static

Creates instance of cv::DualTVL1OpticalFlow.

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

pure virtual

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

See also: setEpsilon

virtual double cv::DualTVL1OpticalFlow::getGamma ( ) const

pure virtual

coefficient for additional illumination variation term

See also: setGamma

virtual int cv::DualTVL1OpticalFlow::getInnerIterations ( ) const

pure virtual

Inner iterations (between outlier filtering) used in the numerical scheme.

See also: setInnerIterations

virtual double cv::DualTVL1OpticalFlow::getLambda ( ) const

pure virtual

Weight parameter for the data term, attachment parameter.

See also: setLambda

virtual int cv::DualTVL1OpticalFlow::getMedianFiltering ( ) const

pure virtual

Median filter kernel size (1 = no filter) (3 or 5)

See also: setMedianFiltering

virtual int cv::DualTVL1OpticalFlow::getOuterIterations ( ) const

pure virtual

Outer iterations (number of inner loops) used in the numerical scheme.

See also: setOuterIterations

virtual int cv::DualTVL1OpticalFlow::getScalesNumber ( ) const

pure virtual

Number of scales used to create the pyramid of images.

See also: setScalesNumber

virtual double cv::DualTVL1OpticalFlow::getScaleStep ( ) const

pure virtual

Step between scales (<1)

See also: setScaleStep

virtual double cv::DualTVL1OpticalFlow::getTau ( ) const

pure virtual

Time step of the numerical scheme.

See also: setTau

virtual double cv::DualTVL1OpticalFlow::getTheta ( ) const

pure virtual

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

See also: setTheta

virtual bool cv::DualTVL1OpticalFlow::getUseInitialFlow ( ) const

pure virtual

Use initial flow.

See also: setUseInitialFlow

virtual int cv::DualTVL1OpticalFlow::getWarpingsNumber ( ) const

pure virtual

Number of warpings per scale.

See also: setWarpingsNumber

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::DualTVL1OpticalFlow::setEpsilon ( double val )

pure virtual

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

See also: getEpsilon

virtual void cv::DualTVL1OpticalFlow::setGamma ( double val )

pure virtual

coefficient for additional illumination variation term

See also: getGamma

virtual void cv::DualTVL1OpticalFlow::setInnerIterations ( int val )

pure virtual

Inner iterations (between outlier filtering) used in the numerical scheme.

See also: getInnerIterations

virtual void cv::DualTVL1OpticalFlow::setLambda ( double val )

pure virtual

Weight parameter for the data term, attachment parameter.

See also: getLambda

virtual void cv::DualTVL1OpticalFlow::setMedianFiltering ( int val )

pure virtual

Median filter kernel size (1 = no filter) (3 or 5)

See also: getMedianFiltering

virtual void cv::DualTVL1OpticalFlow::setOuterIterations ( int val )

pure virtual

Outer iterations (number of inner loops) used in the numerical scheme.

See also: getOuterIterations

virtual void cv::DualTVL1OpticalFlow::setScalesNumber ( int val )

pure virtual

Number of scales used to create the pyramid of images.

See also: getScalesNumber

virtual void cv::DualTVL1OpticalFlow::setScaleStep ( double val )

pure virtual

Step between scales (<1)

See also: getScaleStep

virtual void cv::DualTVL1OpticalFlow::setTau ( double val )

pure virtual

Time step of the numerical scheme.

See also: getTau

virtual void cv::DualTVL1OpticalFlow::setTheta ( double val )

pure virtual

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

See also: getTheta

virtual void cv::DualTVL1OpticalFlow::setUseInitialFlow ( bool val )

pure virtual

Use initial flow.

See also: getUseInitialFlow

virtual void cv::DualTVL1OpticalFlow::setWarpingsNumber ( int val )

pure virtual

Number of warpings per scale.

See also: getWarpingsNumber

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:

video/include/opencv2/video/tracking.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation