#include <ImFusion/Vision/OpticalFlow.h>

Base class for optical flow algorithms producing flow maps (2-channel floating point images). More...

Inheritance diagram for OpticalFlow:

Detailed Description

Base class for optical flow algorithms producing flow maps (2-channel floating point images).

Public Member Functions
virtual std::string	name () const =0
	Return name of optical flow algorithm.

virtual std::unique_ptr< SharedImageSet >	compute (std::shared_ptr< SharedImage > firstImg, std::shared_ptr< SharedImage > secondImg)=0
	Run optical flow computation on provided images.

virtual const bool	hasUncertainty () const

Public Member Functions inherited from Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.

virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.

virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.

void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().

void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.

	Configurable (const Configurable &rhs)

	Configurable (Configurable &&rhs) noexcept

Configurable &	operator= (const Configurable &)

Configurable &	operator= (Configurable &&) noexcept

Additional Inherited Members
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' `signalValueChanged` signal was emitted.

Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

virtual std::string name ( ) const

pure virtual

Return name of optical flow algorithm.

virtual std::unique_ptr< SharedImageSet > compute	(	std::shared_ptr< SharedImage >	firstImg,
		std::shared_ptr< SharedImage >	secondImg )

pure virtual

Run optical flow computation on provided images.

First output image will be 2-channel flow map of type float, second optional output will be uncertainty image of 1 channel with type float.

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