Utility for creating a Command that runs FastOpticalFlowOp operator. More...

#include <CommandOpticalFlow.h>

Inheritance diagram for CmdOpticalFlowBase:

[legend]

Collaboration diagram for CmdOpticalFlowBase:

[legend]

Public Member Functions
void	exec () const
	Main operation: computes differentials and produces approximation of motion.

Public Member Functions inherited from BeanCommand< FastOpticalFlow2Op >
	BeanCommand (const std::string &name, const std::string &description)
	Constructor.

	BeanCommand (const BeanCommand &cmd)
	Copy constructor.

	BeanCommand (FastOpticalFlow2Op &b)
	Constructor wrapping an existing bean.

virtual const bean_t &	getBean () const
	Returns the wrapped bean.

virtual bean_t &	getBean ()
	Returns the wrapped bean.

const std::string &	getName () const final
	Returns the command name.

const std::string &	getDescription () const final
	Returns the command description.

virtual const drain::ReferenceMap &	getParameters () const
	Returns the command parameters.

Public Member Functions inherited from Command
	Command (const Command &cmd)
	Copy constructor.

virtual void	setParameters (const std::string &args) final

template<class T >
void	setParameters (const T &args)
	Sets parameters from argument.

template<class T >
void	setParameter (const std::string &key, const T &value)
	Set a value to a single parameter.

bool	hasParameters () const
	Returns true if this command has parameters.

virtual void	run (const std::string &params="") final
	Description of result, comparable to a return type of a function. ?

virtual void	update ()
	Optional method for preparing command to execution.

Command &	addSection (int i)
	Marks this command as belonging to section i.

const std::string &	getLastParameters () const
	Returns the parameters from the last execution.

virtual void	getRelatedCommands (std::ostream &ostr=std::cout) const
	Writes related command names to stream.

void	linkRelated (const std::string &cmdKey) const
	Add related command(s), to appear in help after "See-also:" phrase.

virtual void	parametersToStream (std::ostream &ostr, const std::string &indent=" ") const
	By default, the "true", technical parameters.

virtual void	parameterKeysToStream (std::ostream &ostr) const
	Writes parameter keys to stream.

void	parameterKeysToStream (std::ostream &ostr, const std::list< std::string > &list, char sep=',') const
	Writes parameter keys to stream.

Public Member Functions inherited from Contextual
	Contextual ()
	Sets internal contextPtr to NULL.

	Contextual (const Contextual &src)
	Copies base context (even null) of the source. Notice that the actual instance may be of derived class.

	Contextual (Context &ctx)
	Copies internal contextPtr.

template<class C >
void	setContext ()
	Sets internal contextPtr to the static source.

void	setExternalContext (Context &ctx)
	Sets internal contextPtr to outside target.

bool	contextIsSet () const
	True, if contextPtr has been set.

template<class T = Context>
T &	getContext () const
	If context has been set, returns it through a cast to base class Context.

Protected Member Functions
virtual const AreaGeometry &	getGeometry () const =0
	Main operation: computes differentials and produces approximation of motion.

virtual void	getSrcData (ImageTray< const Channel > &channels) const =0
	Retrieves the intensity images used as a basis of motion analysis.

virtual void	getDiff (size_t width, size_t height, double max, ImageTray< Channel > &channels) const
	Retrieves the difference image needed as a temporary storage. Maybe viewed for debugging.

virtual void	getMotion (size_t width, size_t height, ImageTray< Channel > &channels) const =0
	The result is stored in this channel pack.

void	debugChannels (const ImageTray< const Channel > &channels, int i=-1, int j=-1) const

Protected Member Functions inherited from BeanCommand< FastOpticalFlow2Op >
virtual drain::ReferenceMap &	getParameters () final

Additional Inherited Members
Public Types inherited from BeanCommand< FastOpticalFlow2Op >
typedef FastOpticalFlow2Op	bean_t
	The bean type.

Public Types inherited from Command
typedef int	cmd_section_type

Static Public Member Functions inherited from Contextual
template<class T >
static Cloner< Context, T > &	getCloner ()
	Returns the object cloner.

Public Attributes inherited from BeanCommand< FastOpticalFlow2Op >
FastOpticalFlow2Op	bean
	The wrapped bean instance.

Public Attributes inherited from Command
cmd_section_type	section = 1
	Section bitmask; zero means hidden from help.

Static Public Attributes inherited from Command
static const SprinterLayout	cmdArgLayout = {",", "?", "=", ""}
	Layout flag for command argument handling.

Protected Attributes inherited from Command
std::set< std::string >	relatedCommands
	Set of related command keys shown in help.

std::string	lastParameters
	String record of the last argument(s) passed.

Protected Attributes inherited from Contextual
Context *	contextPtr
	Pointer to the current context; nullptr if not set.

Detailed Description

Utility for creating a Command that runs FastOpticalFlowOp operator.

Optical flow needs two input images, computes derivatives on them and produces an approximation of motion, ie. the flow.

This utility provides interfacing for those data.

Member Function Documentation

◆ exec()

void exec ( ) const

virtual

Main operation: computes differentials and produces approximation of motion.

Input images: intensity

Differences (output from x, input for the actual algorithm)

Main output (uField,vField, q)

AMVU

AMVV

QIND

Reimplemented from Command.

◆ getDiff()

void getDiff	(	size_t	width,
		size_t	height,
		double	max,
		ImageTray< Channel > &	channels
	)		const

protectedvirtual

Retrieves the difference image needed as a temporary storage. Maybe viewed for debugging.

It is recommended that the image is of type double, as computation of differentials (involving functors) and OpticalFlowWindow use doubles.

Parameters

width	- width of the image
height	- height of the image
max	- expected physical max value (needed if small-integer data used; esp. for subtractions).
channels	- provided resource

Reimplemented in CartesianOpticalFlow.

◆ getGeometry()

virtual const AreaGeometry & getGeometry ( ) const

protectedpure virtual

Main operation: computes differentials and produces approximation of motion.

Desires geometry of the resulting motion field. Implementations may return the resolution of the original data. In derived classes, this could be parameters set by user.

Implemented in CartesianOpticalFlow.