OpendTect-6_4  6.4
Public Member Functions | Protected Attributes | List of all members
Array1DStacker< fT, ArrT > Class Template Reference

Gently stacks ArrayND by summation along the secondary axis Currently implemented only 1D, and Array1D's need to return getData() non-null. With normalize_, will return the average instead of the sum. More...

Inheritance diagram for Array1DStacker< fT, ArrT >:
[legend]

Public Member Functions

 Array1DStacker (const ObjectSet< ArrT > &inp, ArrT &out)
 
bool doPrepare (int nrthreads)
 
bool doWork (od_int64 start, od_int64 stop, int threadidx)
 
od_int64 nrIterations () const
 
void doNormalize (bool normalize)
 
const char * errMsg () const
 
- Public Member Functions inherited from ParallelTask
virtual ~ParallelTask ()
 
bool execute ()
 
virtual bool executeParallel (bool parallel)
 
void setProgressMeter (ProgressMeter *)
 Must be called before execute() More...
 
int64_t nrDone () const
 May be -1, i.e. class does not report nrdone. More...
 
int64_t totalNr () const
 
- Public Member Functions inherited from Task
virtual ~Task ()
 
virtual uiString uiMessage () const
 will be message() again in 7.x More...
 
virtual uiString uiNrDoneText () const
 will be nrDoneText() in 7.x More...
 
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::Stringname () const
 
virtual const OD::StringannotName () 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 Attributes

od_int64 totalnr_
 
const ObjectSet< ArrT > & inp_
 
ArrT & out_
 
bool normalize_
 
FixedString msg_
 
- Protected Attributes inherited from Task
Control control_
 
Threads::ConditionVarworkcontrolcondvar_
 
- Protected Attributes inherited from NamedObject
BufferStringname_
 
NamedObjectlinkedto_
 
CallBackSetdelnotify_
 

Additional Inherited Members

- Public Types inherited from Task
enum  Control { Run, Pause, Stop }
 
- Static Public Member Functions inherited from ParallelTask
static uiString sPosFinished ()
 
static uiString sTrcFinished ()
 
- Static Public Member Functions inherited from Task
static uiString stdNrDoneText ()
 
static uiString uiStdNrDoneText ()
 
- Protected Member Functions inherited from ParallelTask
virtual int maxNrThreads () const
 
virtual int minThreadSize () const
 
virtual bool stopAllOnFailure () const
 
 ParallelTask (const char *nm=0)
 
 ParallelTask (const ParallelTask &)
 
int64_t calculateThreadSize (int64_t totalnr, int nrthreads, int thread) const
 
void addToNrDone (int64_t increment)
 
void quickAddToNrDone (int64_t loopidx)
 
void resetNrDone ()
 
- 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...
 

Detailed Description

template<class fT, class ArrT>
class Array1DStacker< fT, ArrT >

Gently stacks ArrayND by summation along the secondary axis Currently implemented only 1D, and Array1D's need to return getData() non-null. With normalize_, will return the average instead of the sum.

Constructor & Destructor Documentation

template<class fT , class ArrT >
Array1DStacker< fT, ArrT >::Array1DStacker ( const ObjectSet< ArrT > &  inp,
ArrT &  out 
)
inline

Member Function Documentation

template<class fT , class ArrT >
void Array1DStacker< fT, ArrT >::doNormalize ( bool  normalize)
inline
template<class fT , class ArrT >
bool Array1DStacker< fT, ArrT >::doPrepare ( int  nrthreads)
inlinevirtual

Called once, before any doWork is called.

Reimplemented from ParallelTask.

template<class fT , class ArrT >
bool Array1DStacker< fT, ArrT >::doWork ( od_int64  start,
od_int64  stop,
int  threadidx 
)
inline
template<class fT , class ArrT >
const char* Array1DStacker< fT, ArrT >::errMsg ( ) const
inline
template<class fT , class ArrT >
od_int64 Array1DStacker< fT, ArrT >::nrIterations ( ) const
inlinevirtual
Returns
the number of times the process should be run.

Implements ParallelTask.

Member Data Documentation

template<class fT , class ArrT >
const ObjectSet<ArrT>& Array1DStacker< fT, ArrT >::inp_
protected
template<class fT , class ArrT >
FixedString Array1DStacker< fT, ArrT >::msg_
protected
template<class fT , class ArrT >
bool Array1DStacker< fT, ArrT >::normalize_
protected
template<class fT , class ArrT >
ArrT& Array1DStacker< fT, ArrT >::out_
protected
template<class fT , class ArrT >
od_int64 Array1DStacker< fT, ArrT >::totalnr_
protected

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