Class cv::optflow::DualTVL1OpticalFlow#

"Dual TV L1" Optical Flow Algorithm. View details

#include <opencv2/optflow.hpp>

Collaboration diagram for cv::optflow::DualTVL1OpticalFlow:

Public Member Functions#

Public Member Functions inherited from cv::DenseOpticalFlow

Return	Name	Description
`void`	`calc(` `InputArray I0,` `InputArray I1,` `InputOutputArray flow )`	Calculates an optical flow.
`void`	`collectGarbage()`	Releases all inner buffers.

Public Member Functions inherited from cv::Algorithm

Return	Name	Description
	`Algorithm()`
	`~Algorithm()`
`void`	`clear()`	Clears the algorithm state.
`bool`	`empty()`	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
`String`	`getDefaultName()`
`void`	`read(const FileNode & fn)`	Reads algorithm parameters from a file storage.
`void`	`save(const String & filename)`
`void`	`write(` `const Ptr< FileStorage > & fs,` `const String & name = String() )`
`void`	`write(FileStorage & fs)`	Stores algorithm parameters in a file storage.
`void`	`write(` `FileStorage & fs,` `const String & name )`

Static Public Member Functions#

Static Public Member Functions inherited from cv::Algorithm

Return	Name	Description
`static Ptr< _Tp >`	`load(` `const String & filename,` `const String & objname = String() )`	Loads algorithm from the file.
`static Ptr< _Tp >`	`loadFromString(` `const String & strModel,` `const String & objname = String() )`	Loads algorithm from a String.
`static Ptr< _Tp >`	`read(const FileNode & fn)`	Reads algorithm from the file node.

Additional Inherited Members#

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

Member Function Documentation#

getEpsilon()#

double 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

getGamma()#

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

coefficient for additional illumination variation term

See also

setGamma

getInnerIterations()#

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

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

See also

setInnerIterations

getLambda()#

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

Weight parameter for the data term, attachment parameter.

See also

setLambda

getMedianFiltering()#

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

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

See also

setMedianFiltering

getOuterIterations()#

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

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

See also

setOuterIterations

getScalesNumber()#

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

Number of scales used to create the pyramid of images.

See also

setScalesNumber

getScaleStep()#

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

Step between scales (<1)

See also

setScaleStep

getTau()#

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

Time step of the numerical scheme.

See also

setTau

getTheta()#

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

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

See also

setTheta

getUseInitialFlow()#

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

Use initial flow.

See also

setUseInitialFlow

getWarpingsNumber()#

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

Number of warpings per scale.

See also

setWarpingsNumber

setEpsilon()#

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

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

See also

getEpsilon

setGamma()#

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

coefficient for additional illumination variation term

See also

getGamma

setInnerIterations()#

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

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

See also

getInnerIterations

setLambda()#

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

Weight parameter for the data term, attachment parameter.

See also

getLambda

setMedianFiltering()#

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

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

See also

getMedianFiltering

setOuterIterations()#

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

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

See also

getOuterIterations

setScalesNumber()#

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

Number of scales used to create the pyramid of images.

See also

getScalesNumber

setScaleStep()#

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

Step between scales (<1)

See also

getScaleStep

setTau()#

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

Time step of the numerical scheme.

See also

getTau

setTheta()#

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

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

See also

getTheta

setUseInitialFlow()#

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

Use initial flow.

See also

getUseInitialFlow

setWarpingsNumber()#

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

Number of warpings per scale.

See also

getWarpingsNumber

create()#

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 )

Creates instance of cv::DualTVL1OpticalFlow.

Source file#

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

opencv2/optflow.hpp