OpendTect  6.6
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)
 
void doNormalize (bool normalize)
 
bool doPrepare (int nrthreads)
 
bool doWork (od_int64 start, od_int64 stop, int threadidx)
 
const char * errMsg () const
 
od_int64 nrIterations () const
 
- Public Member Functions inherited from ParallelTask
virtual ~ParallelTask ()
 
bool execute ()
 
virtual bool executeParallel (bool parallel)
 
int64_t nrDone () const
 May be -1, i.e. class does not report nrdone. More...
 
void setProgressMeter (ProgressMeter *)
 Must be called before execute() More...
 
int64_t totalNr () const
 
- 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
 
virtual uiString uiMessage () const
 will be message() again in 7.x More...
 
virtual uiString uiNrDoneText () const
 will be nrDoneText() in 7.x More...
 
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 ObjectSet< ArrT > & inp_
 
FixedString msg_
 
bool normalize_
 
ArrT & out_
 
od_int64 totalnr_
 
- 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 ParallelTask
static uiString sPosFinished ()
 
static uiString sTrcFinished ()
 
- 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 ()
 
- Protected Member Functions inherited from ParallelTask
 ParallelTask (const char *nm=0)
 
 ParallelTask (const ParallelTask &)
 
void addToNrDone (int64_t increment)
 
int64_t calculateThreadSize (int64_t totalnr, int nrthreads, int thread) const
 
virtual int maxNrThreads () const
 
virtual int minThreadSize () const
 
void quickAddToNrDone (int64_t loopidx)
 
void resetNrDone ()
 
virtual bool stopAllOnFailure () const
 
- 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 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

◆ Array1DStacker()

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

Member Function Documentation

◆ doNormalize()

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

◆ doPrepare()

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

Called once, before any doWork is called.

Reimplemented from ParallelTask.

◆ doWork()

template<class fT , class ArrT >
bool Array1DStacker< fT, ArrT >::doWork ( od_int64  start,
od_int64  stop,
int  threadidx 
)
inline

◆ errMsg()

template<class fT , class ArrT >
const char* Array1DStacker< fT, ArrT >::errMsg ( ) const
inline

◆ nrIterations()

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

◆ inp_

template<class fT , class ArrT >
const ObjectSet<ArrT>& Array1DStacker< fT, ArrT >::inp_
protected

◆ msg_

template<class fT , class ArrT >
FixedString Array1DStacker< fT, ArrT >::msg_
protected

◆ normalize_

template<class fT , class ArrT >
bool Array1DStacker< fT, ArrT >::normalize_
protected

◆ out_

template<class fT , class ArrT >
ArrT& Array1DStacker< fT, ArrT >::out_
protected

◆ totalnr_

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. 1995-2022