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

#include <opencv2/optflow.hpp>

Inheritance diagram for cv::optflow::DualTVL1OpticalFlow:

Public Member Functions
virtual double	getEpsilon () const =0
	Stopping criterion threshold used in the numerical scheme, which is a trade-off between precision and running time.

virtual double	getGamma () const =0
	coefficient for additional illumination variation term

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

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

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

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

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

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

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

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

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

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

virtual void	setEpsilon (double val)=0

virtual void	setGamma (double val)=0

virtual void	setInnerIterations (int val)=0

virtual void	setLambda (double val)=0

virtual void	setMedianFiltering (int val)=0

virtual void	setOuterIterations (int val)=0

virtual void	setScalesNumber (int val)=0

virtual void	setScaleStep (double val)=0

virtual void	setTau (double val)=0

virtual void	setTheta (double val)=0

virtual void	setUseInitialFlow (bool val)=0

virtual void	setWarpingsNumber (int val)=0

Public Member Functions inherited from cv::DenseOpticalFlow
virtual void	calc (InputArray I0, InputArray I1, InputOutputArray flow)=0
	Calculates an optical flow.

virtual void	collectGarbage ()=0
	Releases all inner buffers.

Public Member Functions inherited from cv::Algorithm
	Algorithm ()

virtual	~Algorithm ()

virtual void	clear ()
	Clears the algorithm state.

virtual bool	empty () const
	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.

virtual String	getDefaultName () const

virtual void	read (const FileNode &fn)
	Reads algorithm parameters from a file storage.

virtual void	save (const String &filename) const

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

void	write (const Ptr< FileStorage > &fs, const String &name=String()) const
	simplified API for language bindingsThis is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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.

Additional Inherited Members
Protected Member Functions inherited from cv::Algorithm
void	writeFormat (FileStorage &fs) const

Detailed Description

"Dual TV L1" Optical Flow Algorithm.

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

Member Function Documentation

static Ptr<DualTVL1OpticalFlow> cv::optflow::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

Python:
	retval	=	cv.optflow.DualTVL1OpticalFlow_create(	[, tau[, lambda[, theta[, nscales[, warps[, epsilon[, innnerIterations[, outerIterations[, scaleStep[, gamma[, medianFiltering[, useInitialFlow]]]]]]]]]]]]	)

Creates instance of cv::DualTVL1OpticalFlow.

virtual double cv::optflow::DualTVL1OpticalFlow::getEpsilon ( ) const

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getEpsilon(		)

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

See Also: setEpsilon

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getGamma(		)

coefficient for additional illumination variation term

See Also: setGamma

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getInnerIterations(		)

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

See Also: setInnerIterations

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getLambda(		)

Weight parameter for the data term, attachment parameter.

See Also: setLambda

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getMedianFiltering(		)

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

See Also: setMedianFiltering

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getOuterIterations(		)

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

See Also: setOuterIterations

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getScalesNumber(		)

Number of scales used to create the pyramid of images.

See Also: setScalesNumber

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getScaleStep(		)

Step between scales (<1)

See Also: setScaleStep

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getTau(		)

Time step of the numerical scheme.

See Also: setTau

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getTheta(		)

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

See Also: setTheta

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getUseInitialFlow(		)

Use initial flow.

See Also: setUseInitialFlow

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

pure virtual

Python:
	retval	=	cv.optflow_DualTVL1OpticalFlow.getWarpingsNumber(		)

Number of warpings per scale.

See Also: setWarpingsNumber

virtual void cv::optflow::DualTVL1OpticalFlow::setEpsilon ( double val )

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setEpsilon(	val	)

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

See Also: getEpsilon

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setGamma(	val	)

coefficient for additional illumination variation term

See Also: getGamma

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setInnerIterations(	val	)

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

See Also: getInnerIterations

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setLambda(	val	)

Weight parameter for the data term, attachment parameter.

See Also: getLambda

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setMedianFiltering(	val	)

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

See Also: getMedianFiltering

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setOuterIterations(	val	)

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

See Also: getOuterIterations

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setScalesNumber(	val	)

Number of scales used to create the pyramid of images.

See Also: getScalesNumber

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setScaleStep(	val	)

Step between scales (<1)

See Also: getScaleStep

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setTau(	val	)

Time step of the numerical scheme.

See Also: getTau

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setTheta(	val	)

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

See Also: getTheta

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setUseInitialFlow(	val	)

Use initial flow.

See Also: getUseInitialFlow

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

pure virtual

Python:
	None	=	cv.optflow_DualTVL1OpticalFlow.setWarpingsNumber(	val	)

Number of warpings per scale.

See Also: getWarpingsNumber

The documentation for this class was generated from the following file:

optflow.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation