#include <ImFusion/Vision/OpticalFlowCustomModel.h>

Performs optical flow estimation using a traced machine learning model provided by the user. More...

Inheritance diagram for OpticalFlowCustomModel:

Detailed Description

Performs optical flow estimation using a traced machine learning model provided by the user.

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

std::unique_ptr< SharedImageSet >	compute (std::shared_ptr< SharedImage > firstImg, std::shared_ptr< SharedImage > secondImg) override
	Run the machine learning model to estimate optical flow between two images. Both inputs should be 2D RGB images and must have the same dimensions.

Public Member Functions inherited from OpticalFlow
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

Public Attributes
Parameter< ImFusion::Filesystem::Path >	p_configFilePath = {"pathToModelConfiguration", "", this}
	Path to .yaml model configuration file.

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

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

Member Function Documentation

std::string name ( ) const

inlineoverridevirtual

Return name of optical flow algorithm.

Implements OpticalFlow.

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

overridevirtual

Run the machine learning model to estimate optical flow between two images. Both inputs should be 2D RGB images and must have the same dimensions.

Implements OpticalFlow.

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