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

#include <tracking.hpp>

Inherits cv::DenseOpticalFlow.

Public Member Functions
virtual double	getTau () const =0
	Time step of the numerical scheme.
virtual void	setTau (double val)=0
	Time step of the numerical scheme.
virtual double	getLambda () const =0
	Weight parameter for the data term, attachment parameter.
virtual void	setLambda (double val)=0
	Weight parameter for the data term, attachment parameter.
virtual double	getTheta () const =0
	Weight parameter for (u - v)^2, tightness parameter.
virtual void	setTheta (double val)=0
	Weight parameter for (u - v)^2, tightness parameter.
virtual double	getGamma () const =0
	coefficient for additional illumination variation term
virtual void	setGamma (double val)=0
	coefficient for additional illumination variation term
virtual int	getScalesNumber () const =0
	Number of scales used to create the pyramid of images.
virtual void	setScalesNumber (int val)=0
	Number of scales used to create the pyramid of images.
virtual int	getWarpingsNumber () const =0
	Number of warpings per scale.
virtual void	setWarpingsNumber (int val)=0
	Number of warpings per scale.
virtual double	getEpsilon () const =0
	Stopping criterion threshold used in the numerical scheme, which is a trade-off between precision and running time.
virtual void	setEpsilon (double val)=0
	Stopping criterion threshold used in the numerical scheme, which is a trade-off between precision and running time.
virtual int	getInnerIterations () const =0
	Inner iterations (between outlier filtering) used in the numerical scheme.
virtual void	setInnerIterations (int val)=0
	Inner iterations (between outlier filtering) used in the numerical scheme.
virtual int	getOuterIterations () const =0
	Outer iterations (number of inner loops) used in the numerical scheme.
virtual void	setOuterIterations (int val)=0
	Outer iterations (number of inner loops) used in the numerical scheme.
virtual bool	getUseInitialFlow () const =0
	Use initial flow.
virtual void	setUseInitialFlow (bool val)=0
	Use initial flow.
virtual double	getScaleStep () const =0
	Step between scales (<1)
virtual void	setScaleStep (double val)=0
	Step between scales (<1)
virtual int	getMedianFiltering () const =0
	Median filter kernel size (1 = no filter) (3 or 5)
virtual void	setMedianFiltering (int val)=0
	Median filter kernel size (1 = no filter) (3 or 5)
virtual CV_WRAP void	calc (InputArray I0, InputArray I1, InputOutputArray flow)=0
	Calculates an optical flow.
virtual CV_WRAP void	collectGarbage ()=0
	Releases all inner buffers.
virtual CV_WRAP void	clear ()
	Clears the algorithm state.
virtual void	write (FileStorage &fs) const
	Stores algorithm parameters in a file storage.
virtual void	read (const FileNode &fn)
	Reads algorithm parameters from a file storage.
virtual bool	empty () const
	Returns true if the Algorithm is empty (e.g.
virtual CV_WRAP void	save (const String &filename) const
	Saves the algorithm to a file.
virtual CV_WRAP String	getDefaultName () const
	Returns the algorithm string identifier.
Static Public Member Functions
template<typename _Tp >
static Ptr< _Tp >	read (const FileNode &fn)
	Reads algorithm from the file node.
template<typename _Tp >
static Ptr< _Tp >	load (const String &filename, const String &objname=String())
	Loads algorithm from the file.
template<typename _Tp >
static Ptr< _Tp >	loadFromString (const String &strModel, const String &objname=String())
	Loads algorithm from a String.

Detailed Description

"Dual TV L1" Optical Flow Algorithm.

The class implements the "Dual TV L1" optical flow algorithm described in Zach2007 and Javier2012 . 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".

Definition at line 442 of file tracking.hpp.

Member Function Documentation

virtual CV_WRAP void calc	(	InputArray	I0,
		InputArray	I1,
		InputOutputArray	flow
	)		`[pure virtual, inherited]`

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 CV_WRAP void clear ( ) [virtual, inherited]

Clears the algorithm state.

Reimplemented in DescriptorMatcher, and FlannBasedMatcher.

Definition at line 2984 of file core.hpp.

virtual CV_WRAP void collectGarbage ( ) [pure virtual, inherited]

Releases all inner buffers.

virtual bool empty ( ) const [virtual, inherited]

Returns true if the Algorithm is empty (e.g.

in the very beginning or after unsuccessful read

Reimplemented in Feature2D, DescriptorMatcher, and StatModel.

Definition at line 2996 of file core.hpp.

virtual CV_WRAP String getDefaultName ( ) const [virtual, inherited]

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 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 getGamma ( ) const [pure virtual]

coefficient for additional illumination variation term

See also:: setGamma

virtual int getInnerIterations ( ) const [pure virtual]

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

See also:: setInnerIterations

virtual double getLambda ( ) const [pure virtual]

Weight parameter for the data term, attachment parameter.

See also:: setLambda

virtual int getMedianFiltering ( ) const [pure virtual]

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

See also:: setMedianFiltering

virtual int getOuterIterations ( ) const [pure virtual]

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

See also:: setOuterIterations

virtual int getScalesNumber ( ) const [pure virtual]

Number of scales used to create the pyramid of images.

See also:: setScalesNumber

virtual double getScaleStep ( ) const [pure virtual]

Step between scales (<1)

See also:: setScaleStep

virtual double getTau ( ) const [pure virtual]

Time step of the numerical scheme.

See also:: setTau

virtual double getTheta ( ) const [pure virtual]

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

See also:: setTheta

virtual bool getUseInitialFlow ( ) const [pure virtual]

Use initial flow.

See also:: setUseInitialFlow

virtual int getWarpingsNumber ( ) const [pure virtual]

Number of warpings per scale.

See also:: setWarpingsNumber

static Ptr<_Tp> load	(	const String &	filename,
		const String &	objname = `String()`
	)		`[static, inherited]`

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

Definition at line 3027 of file core.hpp.

static Ptr<_Tp> loadFromString	(	const String &	strModel,
		const String &	objname = `String()`
	)		`[static, inherited]`

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

Definition at line 3046 of file core.hpp.

virtual void read ( const FileNode & fn ) [virtual, inherited]

Reads algorithm parameters from a file storage.

Reimplemented in DescriptorMatcher, and FlannBasedMatcher.

Definition at line 2992 of file core.hpp.

static Ptr<_Tp> read ( const FileNode & fn ) [static, inherited]

Reads algorithm from the file node.

This is static template method of Algorithm. It's usage is following (in the case of SVM):

     Ptr<SVM> svm = Algorithm::read<SVM>(fn);

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)

Reimplemented in DescriptorMatcher, and FlannBasedMatcher.

Definition at line 3008 of file core.hpp.

virtual CV_WRAP void save ( const String & filename ) const [virtual, inherited]

Saves the algorithm to a file.

In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

virtual void 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 setGamma ( double val ) [pure virtual]

coefficient for additional illumination variation term

See also:: getGamma

virtual void setInnerIterations ( int val ) [pure virtual]

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

See also:: getInnerIterations

virtual void setLambda ( double val ) [pure virtual]

Weight parameter for the data term, attachment parameter.

See also:: getLambda

virtual void setMedianFiltering ( int val ) [pure virtual]

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

See also:: getMedianFiltering

virtual void setOuterIterations ( int val ) [pure virtual]

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

See also:: getOuterIterations

virtual void setScalesNumber ( int val ) [pure virtual]

Number of scales used to create the pyramid of images.

See also:: getScalesNumber

virtual void setScaleStep ( double val ) [pure virtual]

Step between scales (<1)

See also:: getScaleStep

virtual void setTau ( double val ) [pure virtual]

Time step of the numerical scheme.

See also:: getTau

virtual void setTheta ( double val ) [pure virtual]

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

See also:: getTheta

virtual void setUseInitialFlow ( bool val ) [pure virtual]

Use initial flow.

See also:: getUseInitialFlow

virtual void setWarpingsNumber ( int val ) [pure virtual]

Number of warpings per scale.

See also:: getWarpingsNumber

virtual void write ( FileStorage & fs ) const [virtual, inherited]

Stores algorithm parameters in a file storage.

Reimplemented in DescriptorMatcher, and FlannBasedMatcher.

Definition at line 2988 of file core.hpp.

Type:	Program
Mbed OS support:	Mbed 2 deprecated
Created:	31 Mar 2016
Imports:	152
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	1
Followers:	2

DualTVL1OpticalFlow Class Reference
[Object Tracking]

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

DualTVL1OpticalFlow Class Reference [Object Tracking]

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning

DualTVL1OpticalFlow Class Reference
[Object Tracking]