Array2DFilterer< T > Class Template Reference

Filters an Array2D. More...

Inheritance diagram for Array2DFilterer< T >:

Public Member Functions
	Array2DFilterer (Array2D< T > &, const Array2DFilterPars &)
	Array2DFilterer (const Array2D< T > &, Array2D< T > &, const RowCol &origin, const Array2DFilterPars &)
	~Array2DFilterer ()
void	setScope (const Interval< int > &rowrg, const Interval< int > &colrg)
Array2D< T > &	output ()
const Array2D< T > &	output () const
const Array2DFilterPars &	pars () const
const Stats::RunCalc< float > &	calc () const
int	nextStep ()
uiString	uiMessage () const
	will be message() again in 7.x More...
od_int64	nrDone () const
uiString	uiNrDoneText () const
	will be nrDoneText() in 7.x More...
od_int64	totalNr () const
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 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 NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject *linkedto)
	NamedObject (const NamedObject &)
virtual	~NamedObject ()
void	setLinkedTo (NamedObject *)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual const OD::String &	annotName () const
virtual void	setName (const char *)
void	setCleanName (const char *)
	cleans string first More...
void	deleteNotify (const CallBack &)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (NotifierAccess &, const CallBack &, bool onlyifnew=false)
bool	attachCB (NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false)
void	detachCB (NotifierAccess &, const CallBack &)
void	detachCB (NotifierAccess *notif, const CallBack &cb)
bool	isNotifierAttached (NotifierAccess *) const
	Only for debugging purposes, don't use. More...

Protected Member Functions
void	filterRow (int)
void	doPoint (int, int)
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 CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...

Protected Attributes
Array2D< T > &	output_
Array2DFilterPars	pars_
Stats::RunCalc< float > *	calc_
Array2DImpl< T >	input_
RowCol	origin_
Interval< int >	outputrowrg_
Interval< int >	outputcolrg_
const int	inputrowsize_
const int	inputcolsize_
const int	nrcols_
bool	linefilt_
int	nrrowsdone_
Protected Attributes inherited from SequentialTask
ProgressMeter *	progressmeter_
int	lastupdate_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedObject
BufferString *	name_
NamedObject *	linkedto_
CallBackSet *	delnotify_

Private Member Functions
	mODTextTranslationClass (Array2DFilterer)

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }
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	stdNrDoneText ()
static uiString	uiStdNrDoneText ()
Public Attributes inherited from Executor
Notifier< Executor >	prestep
Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...

Detailed Description

template<class T>
class Array2DFilterer< T >

Filters an Array2D.

Note that you cannot change the filter pars after construction.

Constructor & Destructor Documentation

template<class T >

Array2DFilterer< T >::Array2DFilterer ( Array2D< T > &  a, const Array2DFilterPars &  p  )

inline

template<class T >

Array2DFilterer< T >::Array2DFilterer ( const Array2D< T > &  input, Array2D< T > &  a, const RowCol &  origin, const Array2DFilterPars &  p  )

inline

template<class T >

Array2DFilterer< T >::~Array2DFilterer ( )

inline

Member Function Documentation

template<class T >

const Stats::RunCalc<float>& Array2DFilterer< T >::calc ( ) const

inline

template<class T >

void Array2DFilterer< T >::doPoint ( int  row, int  col  )

inlineprotected

template<class T >

void Array2DFilterer< T >::filterRow ( int  row )

inlineprotected

template<class T >

Array2DFilterer< T >::mODTextTranslationClass ( Array2DFilterer< T >  )

private

template<class T >

int Array2DFilterer< T >::nextStep ( )

inlinevirtual

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 Array2DFilterer< T >::nrDone ( ) const

inlinevirtual

Note

nrDone is only used for displaying progress and will be compared to totalNr to show user how large part of the task that is finished.

Reimplemented from Task.

template<class T >

Array2D<T>& Array2DFilterer< T >::output ( )

inline

template<class T >

const Array2D<T>& Array2DFilterer< T >::output ( ) const

inline

template<class T >

const Array2DFilterPars& Array2DFilterer< T >::pars ( ) const

inline

template<class T >

void Array2DFilterer< T >::setScope ( const Interval< int > &  rowrg, const Interval< int > &  colrg  )

inline

template<class T >

od_int64 Array2DFilterer< T >::totalNr ( ) const

inlinevirtual

Reimplemented from Task.

template<class T >

uiString Array2DFilterer< T >::uiMessage ( ) const

inlinevirtual

will be message() again in 7.x

Note

totalNr is only used for displaying progress.

Reimplemented from Task.

template<class T >

uiString Array2DFilterer< T >::uiNrDoneText ( ) const

inlinevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

template<class T >

Stats::RunCalc<float>* Array2DFilterer< T >::calc_

protected

template<class T >

Array2DImpl<T> Array2DFilterer< T >::input_

protected

template<class T >

const int Array2DFilterer< T >::inputcolsize_

protected

template<class T >

const int Array2DFilterer< T >::inputrowsize_

protected

template<class T >

bool Array2DFilterer< T >::linefilt_

protected

template<class T >

const int Array2DFilterer< T >::nrcols_

protected

template<class T >

int Array2DFilterer< T >::nrrowsdone_

protected

template<class T >

RowCol Array2DFilterer< T >::origin_

protected

template<class T >

Array2D<T>& Array2DFilterer< T >::output_

protected

template<class T >

Interval<int> Array2DFilterer< T >::outputcolrg_

protected

template<class T >

Interval<int> Array2DFilterer< T >::outputrowrg_

protected

template<class T >

Array2DFilterPars Array2DFilterer< T >::pars_

protected