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

Filters an Array2D. More...

Inheritance diagram for Array2DFilterer< T >:
[legend]

Public Member Functions

 Array2DFilterer (Array2D< T > &, const Array2DFilterPars &)
 
 Array2DFilterer (const Array2D< T > &, Array2D< T > &, const RowCol &origin, const Array2DFilterPars &)
 
 ~Array2DFilterer ()
 
const Stats::RunCalc< float > & calc () const
 
int nextStep () override
 
od_int64 nrDone () const override
 
Array2D< T > & output ()
 
const Array2D< T > & output () const
 
const Array2DFilterParspars () const
 
void setScope (const Interval< int > &rowrg, const Interval< int > &colrg)
 
od_int64 totalNr () const override
 
uiString uiMessage () const override
 will be message() again in 7.x More...
 
uiString uiNrDoneText () const override
 will be nrDoneText() in 7.x More...
 
- Public Member Functions inherited from Executor
 Executor (const char *nm)
 
virtual ~Executor ()
 
int doStep () override
 
bool execute () override
 
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 () override
 
- Public Member Functions inherited from ReportingTask
virtual ~ReportingTask ()
 
void getProgress (const ReportingTask &)
 
- 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
 
virtual CallBackertrueCaller ()
 
- 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 &)
 
const name_typename () const override
 
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 Member Functions

void doPoint (int, int)
 
void filterRow (int)
 
- Protected Member Functions inherited from Executor
virtual bool goImpl (od_ostream *, bool, bool, int)
 
- Protected Member Functions inherited from ReportingTask
 ReportingTask (const char *nm=nullptr)
 
void incrementProgress ()
 
ProgressMeterprogressMeter () const
 
void reportProgressFinished ()
 
void reportProgressStarted ()
 
void resetProgress ()
 
void setProgressMeter (ProgressMeter *) override
 Must be called before execute() More...
 
void updateProgressMeter (bool forced=false, std::int64_t *totalnr=0)
 
void updateReportedName ()
 
- Protected Member Functions inherited from Task
 Task (const char *nm=nullptr)
 
virtual bool shouldContinue ()
 
- Protected Member Functions inherited from NamedCallBacker
void sendDelNotif () const
 

Protected Attributes

Stats::RunCalc< float > * calc_
 
Array2DImpl< T > input_
 
const int inputcolsize_
 
const int inputrowsize_
 
bool linefilt_
 
const int nrcols_
 
int nrrowsdone_
 
RowCol origin_
 
Array2D< T > & output_
 
Interval< int > outputcolrg_
 
Interval< int > outputrowrg_
 
Array2DFilterPars pars_
 
- 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
 
- Public Attributes inherited from ReportingTask
Notifier< ReportingTaskprogressUpdated
 

Detailed Description

template<class T>
class Array2DFilterer< T >

Filters an Array2D.

Note that you cannot change the filter pars after construction.

<>

Constructor & Destructor Documentation

◆ Array2DFilterer() [1/2]

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

◆ Array2DFilterer() [2/2]

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

◆ ~Array2DFilterer()

template<class T >
Array2DFilterer< T >::~Array2DFilterer
inline

Member Function Documentation

◆ calc()

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

◆ doPoint()

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

◆ filterRow()

template<class T >
void Array2DFilterer< T >::filterRow ( int  row)
inlineprotected

◆ nextStep()

template<class T >
int Array2DFilterer< T >::nextStep ( )
inlineoverridevirtual
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 Array2DFilterer< T >::nrDone ( ) const
inlineoverridevirtual
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.

◆ output() [1/2]

template<class T >
Array2D<T>& Array2DFilterer< T >::output ( )
inline

◆ output() [2/2]

template<class T >
const Array2D<T>& Array2DFilterer< T >::output ( ) const
inline

◆ pars()

template<class T >
const Array2DFilterPars& Array2DFilterer< T >::pars ( ) const
inline

◆ setScope()

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

◆ totalNr()

template<class T >
od_int64 Array2DFilterer< T >::totalNr ( ) const
inlineoverridevirtual

Reimplemented from Task.

◆ uiMessage()

template<class T >
uiString Array2DFilterer< T >::uiMessage ( ) const
inlineoverridevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

template<class T >
uiString Array2DFilterer< T >::uiNrDoneText ( ) const
inlineoverridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

◆ calc_

template<class T >
Stats::RunCalc<float>* Array2DFilterer< T >::calc_
protected

◆ input_

template<class T >
Array2DImpl<T> Array2DFilterer< T >::input_
protected

◆ inputcolsize_

template<class T >
const int Array2DFilterer< T >::inputcolsize_
protected

◆ inputrowsize_

template<class T >
const int Array2DFilterer< T >::inputrowsize_
protected

◆ linefilt_

template<class T >
bool Array2DFilterer< T >::linefilt_
protected

◆ nrcols_

template<class T >
const int Array2DFilterer< T >::nrcols_
protected

◆ nrrowsdone_

template<class T >
int Array2DFilterer< T >::nrrowsdone_
protected

◆ origin_

template<class T >
RowCol Array2DFilterer< T >::origin_
protected

◆ output_

template<class T >
Array2D<T>& Array2DFilterer< T >::output_
protected

◆ outputcolrg_

template<class T >
Interval<int> Array2DFilterer< T >::outputcolrg_
protected

◆ outputrowrg_

template<class T >
Interval<int> Array2DFilterer< T >::outputrowrg_
protected

◆ pars_

template<class T >
Array2DFilterPars Array2DFilterer< T >::pars_
protected

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