w2kmeans::MotionEstimateSupplier< GridType > Class Template Reference

Inheritance diagram for w2kmeans::MotionEstimateSupplier< GridType >:

List of all members.

---

Detailed Description

template<class GridType>
class w2kmeans::MotionEstimateSupplier< GridType >

Base class for MotionEstimators -- subclasses include the abstract base class MotionEstimator which actually does the job and the MotionEstimateListener which gets its estimate by being attached to one or more URLs.

Author:

Lakshman

Version:

Id

w2kmeans_MotionEstimateSupplier.h,v 1.12 2009/06/02 20:17:58 lakshman Exp

Public Member Functions
void	addMotionEstimateHandler (code::SmartPtr< MotionEstimateHandler< GridType > > a)
	Add an estimate handler.
	MotionEstimateSupplier ()
virtual	~MotionEstimateSupplier ()
bool	isProcessing () const
	returns true while processing the input, and false if waiting for new inputs.
virtual bool	shouldProcessInputAt (const code::Time &newTime) const
	are we ready to process the next input? In general, we are always ready, since we have no idea how often the motion estimates are going to arrive .
Protected Member Functions
void	notifyMotionEstimate (const GridType &motionEast, const GridType &motionSouth, const GridType &growthRate, size_t scale, bool complete)
	subclass implementors should call this method when they have this information.
void	notifyIntermediateProduct (const code::DataType &grid)
	this method may be called for handlers who write out intermediate products.
void	setProcessingFlag (bool input)

---

Constructor & Destructor Documentation

template<class GridType>

w2kmeans::MotionEstimateSupplier< GridType >::MotionEstimateSupplier

(

)

[inline]

template<class GridType>

virtual w2kmeans::MotionEstimateSupplier< GridType >::~MotionEstimateSupplier

(

)

[inline, virtual]

---

Member Function Documentation

template<class GridType>

void w2kmeans::MotionEstimateSupplier< GridType >::addMotionEstimateHandler

(

code::SmartPtr< MotionEstimateHandler< GridType > >

a

)

[inline]

Add an estimate handler.

we will call handleMotionEstimate on this object whenever we generate a new motion estimate.

template<class GridType>

bool w2kmeans::MotionEstimateSupplier< GridType >::isProcessing

(

)

const [inline]

returns true while processing the input, and false if waiting for new inputs.

template<class GridType>

void w2kmeans::MotionEstimateSupplier< GridType >::notifyIntermediateProduct

(

const code::DataType &

grid

)

[protected]

this method may be called for handlers who write out intermediate products.

template<class GridType>

void w2kmeans::MotionEstimateSupplier< GridType >::notifyMotionEstimate	(	const GridType &	motionEast,
		const GridType &	motionSouth,
		const GridType &	growthRate,
		size_t	scale,
		bool	complete
	)			[protected]

subclass implementors should call this method when they have this information.

template<class GridType>

void w2kmeans::MotionEstimateSupplier< GridType >::setProcessingFlag

(

bool

input

)

[inline, protected]

template<class GridType>

virtual bool w2kmeans::MotionEstimateSupplier< GridType >::shouldProcessInputAt

(

const code::Time &

newTime

)

const [inline, virtual]

are we ready to process the next input? In general, we are always ready, since we have no idea how often the motion estimates are going to arrive .

.. Subclasses can over-ride this, to allow data providers to decide whether or not the input data is required at this time.

Reimplemented in w2kmeans::MotionEstimator< GridType >.

---