ArrayNDGentleSmoother< T > Class Template Reference

Gently smooths ArrayND by averaging with neighbours. More...

Inheritance diagram for ArrayNDGentleSmoother< T >:

Protected Attributes
const ArrayND< T > &	inp_
ArrayND< T > &	out_
od_int64	totnr_
od_int64	nrdone_
const int	nrdims_
ArrayNDIter	it_
TypeSet< int >	maxidxs_
Protected Attributes inherited from SequentialTask
ProgressMeter *	progressmeter_
int	lastupdate_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedCallBacker
Notifier< NamedCallBacker >	delnotif_
Threads::Atomic< bool >	delalreadytriggered_
Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
virtual mODTextTranslationClass(ArrayNDGentleSmoother) public	~ArrayNDGentleSmoother ()
uiString	message () const
od_int64	totalNr () const
od_int64	nrDone () const
uiString	nrDoneText () const
int	nextStep ()

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }
Public Member Functions inherited from Executor
	Executor (const char *nm)
virtual	~Executor ()
virtual int	doStep ()
bool	go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
bool	go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
virtual bool	execute ()
Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=0)
virtual	~SequentialTask ()
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
ProgressMeter *	progressMeter ()
const ProgressMeter *	progressMeter () const
bool	execute ()
Public Member Functions inherited from Task
virtual	~Task ()
virtual uiRetVal	errorWithDetails () const
virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...
bool	workControlEnabled () const
virtual void	controlWork (Control)
virtual Control	getState () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
bool	operator== (const NamedCallBacker &oth) const
bool	operator== (const NamedObject &oth) const
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
virtual bool	isCapsule () const
void	stopReceivingNotifications () const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual BufferString	getName () const
virtual void	setName (const char *nm)
bool	getNameFromPar (const IOPar &)
void	putNameInPar (IOPar &) const
Static Public Member Functions inherited from SequentialTask
static int	ErrorOccurred ()
static int	Finished ()
static int	MoreToDo ()
static int	WarningAvailable ()
Static Public Member Functions inherited from Task
static uiString	stdMessage ()
static uiString	stdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()
Public Attributes inherited from Executor
Notifier< Executor >	prestep
Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...
Protected Member Functions inherited from Executor
virtual bool	goImpl (od_ostream *, bool, bool, int)
Protected Member Functions inherited from Task
	Task (const char *nm=0)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...

Detailed Description

template<class T>
class ArrayNDGentleSmoother< T >

Gently smooths ArrayND by averaging with neighbours.

The weight of the centre is always equal to the sum of the weights of the rest.

The idea is to do this multiple times when stronger smoothing is required.

Constructor & Destructor Documentation

template<class T >

virtual mODTextTranslationClass (ArrayNDGentleSmoother) public ArrayNDGentleSmoother< T >::~ArrayNDGentleSmoother ( )

inlineprivatevirtual

Member Function Documentation

template<class T >

uiString ArrayNDGentleSmoother< T >::message ( ) const

inlineprivatevirtual

Implements Executor.

template<class T >

int ArrayNDGentleSmoother< T >::nextStep ( )

privatevirtual

Return values

MoreToDo()	Not finished. Call me again.
Finished()	Nothing more to do.
ErrorOccurred()	Something went wrong.

Note

if function returns a value greater than cMoreToDo(),it should be interpreted as cMoreToDo().

Implements SequentialTask.

template<class T >

od_int64 ArrayNDGentleSmoother< T >::nrDone ( ) const

inlineprivatevirtual

Note

only used for displaying progress.

Implements Executor.

template<class T >

uiString ArrayNDGentleSmoother< T >::nrDoneText ( ) const

inlineprivatevirtual

Implements Executor.

template<class T >

od_int64 ArrayNDGentleSmoother< T >::totalNr ( ) const

inlineprivatevirtual

Reimplemented from Task.

Member Data Documentation

template<class T >

const ArrayND<T>& ArrayNDGentleSmoother< T >::inp_

protected

template<class T >

ArrayNDIter ArrayNDGentleSmoother< T >::it_

protected

template<class T >

TypeSet<int> ArrayNDGentleSmoother< T >::maxidxs_

protected

template<class T >

const int ArrayNDGentleSmoother< T >::nrdims_

protected

template<class T >

od_int64 ArrayNDGentleSmoother< T >::nrdone_

protected

template<class T >

ArrayND<T>& ArrayNDGentleSmoother< T >::out_

protected

template<class T >

od_int64 ArrayNDGentleSmoother< T >::totnr_

protected