| OpendTect 8.0

Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Array1DStacker< fT, ArrT > Class Template Reference
Algo

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

`#include <arrayndstacker.h>`

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) override
bool | doWork (od_int64 start, od_int64 stop, int threadidx) override
uiString | errMsg () const
od_int64 | nrIterations () const override
Public Member Functions inherited from ParallelTask
virtual | ~ParallelTask ()
void | doParallel (bool yn)
bool | execute () override
virtual bool | executeParallel (bool parallel)
od_int64 | nrDone () const override
| May be -1, i.e. class does not report nrdone.
od_int64 | totalNr () const override
Public Member Functions inherited from ReportingTask
| ReportingTask (const ReportingTask &)=delete
virtual | ~ReportingTask ()
void | getProgress (const ReportingTask &)
ReportingTask & | operator= (const ReportingTask &)=delete
void | setSimpleMeter (bool yn, int repperc)
int | simpleMeterStep () const
bool | useSimpleMeter () const
Public Member Functions inherited from Task
| Task (const Task &)=delete
virtual | ~Task ()
virtual void | controlWork (Control)
virtual void | enableWorkControl (bool=true)
| Must be called before execute()
virtual uiRetVal | errorWithDetails () const
virtual Control | getState () const
Task & | operator= (const Task &)=delete
virtual uiString | uiMessage () const
virtual uiString | uiNrDoneText () const
bool | workControlEnabled () const
Public Member Functions inherited from NamedCallBacker
| NamedCallBacker (const char *nm=nullptr)
| NamedCallBacker (const NamedCallBacker &)=delete
| ~NamedCallBacker ()
virtual Notifier< NamedCallBacker > & | objectToBeDeleted () const
NamedCallBacker & | operator= (const NamedCallBacker &)=delete
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.
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.
CallBacker & | operator= (const CallBacker &)=delete
void | stopReceivingNotifications () const
virtual CallBacker * | trueCaller ()
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_type & | name () const override
NamedObject & | operator= (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_
uiString | msg_
bool | normalize_
ArrT & | out_
od_int64 | totalnr_
Protected Attributes inherited from Task
Control | control_ = Task::Run
Threads::ConditionVar * | workcontrolcondvar_ = nullptr
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool > | delalreadytriggered_
Notifier< NamedCallBacker > | delnotif_
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 ReportingTask
static PtrMan< ProgressMeter > | getTextProgressMeter (od_ostream &, const IOPar *iop=nullptr)
static bool | needSimpleLogging (const IOPar &)
static const char * | sKeySimpleLogging ()
static const char * | sKeySimpleLoggingStep ()
Static Public Member Functions inherited from Task
static uiString | uiStdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void | createReceiverForCurrentThread ()
static void | removeReceiverForCurrentThread ()
Public Attributes inherited from ReportingTask
Notifier< ReportingTask > | progressUpdated
Protected Member Functions inherited from ParallelTask
| ParallelTask (const char *nm=0)
void | addToNrDone (od_int64 increment)
od_int64 | calculateThreadSize (od_int64 totalnr, int nrthreads, int thread) const
virtual int | maxNrThreads () const
virtual int | minThreadSize () const
void | quickAddToNrDone (od_int64 loopidx)
void | resetNrDone ()
virtual bool | stopAllOnFailure () const
Protected Member Functions inherited from ReportingTask
| ReportingTask (const char *nm=nullptr)
void | incrementProgress ()
ProgressMeter * | progressMeter () const
void | reportProgressFinished ()
void | reportProgressStarted ()
void | resetProgress ()
void | setProgressMeter (ProgressMeter *) override
| Must be called before execute()
void | updateProgressMeter (bool forced=false, od_int64 *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

## 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 | ) |
| inline override virtual

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 override virtual

The functions that does the job. The function will be called with all intervals from 0 to ParallelTask::nrIterations()-1. The function must be designed to be able to run in parallel.

Parameters

  start | first index
  stop | last index
  threadidx | gives an identifier (between 0 and nr of threads -1) that is unique to each call to doWork.

Implements ParallelTask.

## ◆ errMsg()

template<class fT , class ArrT >

uiString Array1DStacker< fT, ArrT >::errMsg | ( |  | ) | const
| inline

## ◆ nrIterations()

template<class fT , class ArrT >

od_int64 Array1DStacker< fT, ArrT >::nrIterations | ( |  | ) | const
| inline override virtual

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 >

uiString 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-2025