OpendTect  6.6
Public Member Functions | Protected Attributes | List of all members
ArrayNDGentleSmoother< T > Class Template Reference

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

Inheritance diagram for ArrayNDGentleSmoother< T >:
[legend]

Public Member Functions

 ArrayNDGentleSmoother (const ArrayND< T > &, ArrayND< T > &)
 
virtual ~ArrayNDGentleSmoother ()
 
int nextStep ()
 
od_int64 nrDone () const
 
od_int64 totalNr () const
 
uiString uiMessage () const
 will be message() again in 7.x More...
 
uiString uiNrDoneText () const
 will be nrDoneText() in 7.x More...
 
- Public Member Functions inherited from Executor
 Executor (const char *nm)
 
virtual ~Executor ()
 
virtual int doStep ()
 
virtual bool execute ()
 
bool go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
 
bool go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
 
- Public Member Functions inherited from SequentialTask
 SequentialTask (const char *nm=nullptr)
 
virtual ~SequentialTask ()
 
bool execute ()
 
ProgressMeterprogressMeter ()
 
const ProgressMeterprogressMeter () const
 
void setProgressMeter (ProgressMeter *)
 Must be called before execute() More...
 
- Public Member Functions inherited from Task
virtual ~Task ()
 
virtual void controlWork (Control)
 
virtual void enableWorkControl (bool=true)
 Must be called before execute() More...
 
virtual uiRetVal errorWithDetails () const
 
virtual Control getState () const
 
bool workControlEnabled () const
 
- Public Member Functions inherited from NamedCallBacker
 NamedCallBacker (const char *nm=0)
 
 NamedCallBacker (const NamedCallBacker &)
 
virtual Notifier< NamedCallBacker > & objectToBeDeleted () const
 
bool operator== (const NamedCallBacker &oth) const
 
bool operator== (const NamedObject &oth) 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 detachAllNotifiers () const
 Call from the destructor of your inherited object. More...
 
void detachCB (const NotifierAccess &, const CallBack &) const
 
void detachCB (const NotifierAccess *notif, const CallBack &cb) const
 
virtual bool isCapsule () const
 
bool isNotifierAttached (const NotifierAccess *) const
 Only for debugging purposes, don't use. More...
 
void stopReceivingNotifications () const
 
- Public Member Functions inherited from NamedObject
 NamedObject (const char *nm=nullptr)
 
 NamedObject (const NamedObject &oth)
 
virtual ~NamedObject ()
 
virtual BufferString getName () const
 
bool getNameFromPar (const IOPar &)
 
virtual const name_typename () const
 
NamedObjectoperator= (const NamedObject &)
 
bool operator== (const NamedObject &oth) const
 
virtual void setName (const char *nm)
 
- Public Member Functions inherited from ObjectWithName
virtual ~ObjectWithName ()
 
bool hasName (const char *nm) const
 
bool hasName (const name_type &nm) const
 
void putNameInPar (IOPar &) const
 

Protected Attributes

const ArrayND< T > & inp_
 
ArrayNDIter it_
 
TypeSet< int > maxidxs_
 
const int nrdims_
 
od_int64 nrdone_
 
ArrayND< T > & out_
 
od_int64 totnr_
 
- Protected Attributes inherited from SequentialTask
int lastupdate_
 
ProgressMeterprogressmeter_
 
- Protected Attributes inherited from Task
Control control_
 
Threads::ConditionVarworkcontrolcondvar_
 
- Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool > delalreadytriggered_
 
Notifier< NamedCallBackerdelnotif_
 
- Protected Attributes inherited from NamedObject
BufferString name_
 

Additional Inherited Members

- Public Types inherited from Task
enum  Control { Run , Pause , Stop }
 
- Public Types inherited from ObjectWithName
typedef OD::String name_type
 
- 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 ()
 
- Static Public Member Functions inherited from CallBacker
static void createReceiverForCurrentThread ()
 
static void removeReceiverForCurrentThread ()
 
- Public Attributes inherited from Executor
Notifier< Executorpoststep
 Only when MoreToDo will be returned. More...
 
Notifier< Executorprestep
 
- Protected Member Functions inherited from Executor
virtual bool goImpl (od_ostream *, bool, bool, int)
 
- Protected Member Functions inherited from Task
 Task (const char *nm=nullptr)
 
virtual bool shouldContinue ()
 
- Protected Member Functions inherited from NamedCallBacker
void sendDelNotif () const
 

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

◆ ArrayNDGentleSmoother()

template<class T >
ArrayNDGentleSmoother< T >::ArrayNDGentleSmoother ( const ArrayND< T > &  inp,
ArrayND< T > &  out 
)

◆ ~ArrayNDGentleSmoother()

template<class T >
virtual ArrayNDGentleSmoother< T >::~ArrayNDGentleSmoother ( )
inlinevirtual

Member Function Documentation

◆ nextStep()

template<class T >
int ArrayNDGentleSmoother< T >::nextStep ( )
virtual
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.

◆ nrDone()

template<class T >
od_int64 ArrayNDGentleSmoother< 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.

◆ totalNr()

template<class T >
od_int64 ArrayNDGentleSmoother< T >::totalNr ( ) const
inlinevirtual

Reimplemented from Task.

◆ uiMessage()

template<class T >
uiString ArrayNDGentleSmoother< T >::uiMessage ( ) const
inlinevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

template<class T >
uiString ArrayNDGentleSmoother< T >::uiNrDoneText ( ) const
inlinevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

◆ inp_

template<class T >
const ArrayND<T>& ArrayNDGentleSmoother< T >::inp_
protected

◆ it_

template<class T >
ArrayNDIter ArrayNDGentleSmoother< T >::it_
protected

◆ maxidxs_

template<class T >
TypeSet<int> ArrayNDGentleSmoother< T >::maxidxs_
protected

◆ nrdims_

template<class T >
const int ArrayNDGentleSmoother< T >::nrdims_
protected

◆ nrdone_

template<class T >
od_int64 ArrayNDGentleSmoother< T >::nrdone_
protected

◆ out_

template<class T >
ArrayND<T>& ArrayNDGentleSmoother< T >::out_
protected

◆ totnr_

template<class T >
od_int64 ArrayNDGentleSmoother< T >::totnr_
protected

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2022