Class used for calculating a sparse optical flow. More...

#include <opencv2/video/tracking.hpp>

Inheritance diagram for cv::SparsePyrLKOpticalFlow:

Collaboration diagram for cv::SparsePyrLKOpticalFlow:

Public Member Functions
virtual void	calc (InputArray prevImg, InputArray nextImg, InputArray prevPts, InputOutputArray nextPts, OutputArray status, OutputArray err=cv::noArray())=0
	Calculates a sparse 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 int	getFlags () const =0

virtual int	getMaxLevel () const =0

virtual double	getMinEigThreshold () const =0

virtual TermCriteria	getTermCriteria () const =0

virtual Size	getWinSize () 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	setFlags (int flags)=0

virtual void	setMaxLevel (int maxLevel)=0

virtual void	setMinEigThreshold (double minEigThreshold)=0

virtual void	setTermCriteria (TermCriteria &crit)=0

virtual void	setWinSize (Size winSize)=0

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

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

Static Public Member Functions
static Ptr< SparsePyrLKOpticalFlow >	create (Size winSize=Size(21, 21), int maxLevel=3, TermCriteria crit=TermCriteria(TermCriteria::COUNT+TermCriteria::EPS, 30, 0.01), int flags=0, double minEigThreshold=1e-4)

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

Class used for calculating a sparse optical flow.

The class can calculate an optical flow for a sparse feature set using the iterative Lucas-Kanade method with pyramids.

See also: calcOpticalFlowPyrLK

Member Function Documentation

◆ calc()

virtual void cv::SparseOpticalFlow::calc	(	InputArray	prevImg,
		InputArray	nextImg,
		InputArray	prevPts,
		InputOutputArray	nextPts,
		OutputArray	status,
		OutputArray	err = `cv::noArray()`
	)

pure virtualinherited

Calculates a sparse optical flow.

Parameters

prevImg	First input image.
nextImg	Second input image of the same size and the same type as prevImg.
prevPts	Vector of 2D points for which the flow needs to be found.
nextPts	Output vector of 2D points containing the calculated new positions of input features in the second image.
status	Output status vector. Each element of the vector is set to 1 if the flow for the corresponding features has been found. Otherwise, it is set to 0.
err	Optional output vector that contains error response for each point (inverse confidence).

◆ clear()

virtual void cv::Algorithm::clear ( )

inlinevirtualinherited

Clears the algorithm state.

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

◆ create()

static Ptr<SparsePyrLKOpticalFlow> cv::SparsePyrLKOpticalFlow::create	(	Size	winSize = `Size(21, 21)`,
		int	maxLevel = `3`,
		TermCriteria	crit = `TermCriteria(TermCriteria::COUNT+TermCriteria::EPS, 30, 0.01)`,
		int	flags = `0`,
		double	minEigThreshold = `1e-4`
	)

static

◆ empty()

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, and cv::BaseCascadeClassifier.

◆ getDefaultName()

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.

Reimplemented in cv::AKAZE, cv::KAZE, cv::SimpleBlobDetector, cv::GFTTDetector, cv::AgastFeatureDetector, cv::FastFeatureDetector, cv::MSER, cv::ORB, cv::BRISK, and cv::Feature2D.

◆ getFlags()

virtual int cv::SparsePyrLKOpticalFlow::getFlags ( ) const

pure virtual

◆ getMaxLevel()

virtual int cv::SparsePyrLKOpticalFlow::getMaxLevel ( ) const

pure virtual

◆ getMinEigThreshold()

virtual double cv::SparsePyrLKOpticalFlow::getMinEigThreshold ( ) const

pure virtual

◆ getTermCriteria()

virtual TermCriteria cv::SparsePyrLKOpticalFlow::getTermCriteria ( ) const

pure virtual

◆ getWinSize()

virtual Size cv::SparsePyrLKOpticalFlow::getWinSize ( ) const

pure virtual

◆ load()

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_Assert, cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::isOpened(), and cv::FileStorage::READ.

Here is the call graph for this function:

◆ loadFromString()

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::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::MEMORY, and cv::FileStorage::READ.

Here is the call graph for this function:

◆ read() [1/2]

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.

◆ read() [2/2]

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)

◆ save()

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

◆ setFlags()

virtual void cv::SparsePyrLKOpticalFlow::setFlags ( int flags )

pure virtual

◆ setMaxLevel()

virtual void cv::SparsePyrLKOpticalFlow::setMaxLevel ( int maxLevel )

pure virtual

◆ setMinEigThreshold()

virtual void cv::SparsePyrLKOpticalFlow::setMinEigThreshold ( double minEigThreshold )

pure virtual

◆ setTermCriteria()

virtual void cv::SparsePyrLKOpticalFlow::setTermCriteria ( TermCriteria & crit )

pure virtual

◆ setWinSize()

virtual void cv::SparsePyrLKOpticalFlow::setWinSize ( Size winSize )

pure virtual

◆ write() [1/2]

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.

References CV_WRAP.

Referenced by cv::Feature2D::write(), and cv::DescriptorMatcher::write().

Here is the caller graph for this function:

◆ write() [2/2]

void cv::Algorithm::write	(	const Ptr< FileStorage > &	fs,
		const String &	name = `String()`
	)		const

inherited

simplified API for language bindings This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ writeFormat()

void cv::Algorithm::writeFormat ( FileStorage & fs ) const

protectedinherited

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

opencv2/video/tracking.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ calc()

◆ clear()

◆ create()

◆ empty()

◆ getDefaultName()

◆ getFlags()

◆ getMaxLevel()

◆ getMinEigThreshold()

◆ getTermCriteria()

◆ getWinSize()

◆ load()

◆ loadFromString()

◆ read() [1/2]

◆ read() [2/2]

◆ save()

◆ setFlags()

◆ setMaxLevel()

◆ setMinEigThreshold()

◆ setTermCriteria()

◆ setWinSize()

◆ write() [1/2]

◆ write() [2/2]

◆ writeFormat()