OpendTect 8.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VolProc::StatsCalculatorTask Class Reference

#include <volprocstatscomputer.h>

Inheritance diagram for VolProc::StatsCalculatorTask:
[legend]

Public Member Functions

 StatsCalculatorTask (const Array3D< float > &, const TrcKeyZSampling &tkzsin, const TrcKeyZSampling &tkzsout, BinID, int, BufferString, Array3D< float > &out)
 
 ~StatsCalculatorTask ()
 
od_int64 totalNr () const override
 
uiString uiMessage () 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.
 
- Public Member Functions inherited from ReportingTask
 ReportingTask (const ReportingTask &)=delete
 
virtual ~ReportingTask ()
 
void getProgress (const ReportingTask &)
 
ReportingTaskoperator= (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
 
Taskoperator= (const Task &)=delete
 
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
 
NamedCallBackeroperator= (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.
 
CallBackeroperator= (const CallBacker &)=delete
 
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
 

Static Public Member Functions

static const char * sKeyEllipse ()
 
- Static Public Member Functions inherited from ParallelTask
static uiString sPosFinished ()
 
static uiString sTrcFinished ()
 
- Static Public Member Functions inherited from ReportingTask
static PtrMan< ProgressMetergetTextProgressMeter (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 ()
 

Protected Member Functions

bool doWork (od_int64, od_int64, int) override
 
od_int64 nrIterations () const override
 
void prepareWork ()
 
- 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 ()
 
ProgressMeterprogressMeter () 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
 

Protected Attributes

Threads::Lock datalock_
 
const Array3D< float > & input_
 
int nzsampextra_
 
Array3D< float > & output_
 
TypeSet< BinIDpositions_
 
BufferString shape_
 
BufferString statstype_
 
BinID stepout_
 
TrcKeyZSampling tkzsin_
 
TrcKeyZSampling tkzsout_
 
od_int64 totalnr_
 
- Protected Attributes inherited from Task
Control control_ = Task::Run
 
Threads::ConditionVarworkcontrolcondvar_ = nullptr
 
- 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
 
- Public Attributes inherited from ReportingTask
Notifier< ReportingTaskprogressUpdated
 

Detailed Description

<>

Constructor & Destructor Documentation

◆ StatsCalculatorTask()

VolProc::StatsCalculatorTask::StatsCalculatorTask ( const Array3D< float > & ,
const TrcKeyZSampling & tkzsin,
const TrcKeyZSampling & tkzsout,
BinID ,
int ,
BufferString ,
Array3D< float > & out )

◆ ~StatsCalculatorTask()

VolProc::StatsCalculatorTask::~StatsCalculatorTask ( )

Member Function Documentation

◆ doWork()

bool VolProc::StatsCalculatorTask::doWork ( od_int64 start,
od_int64 stop,
int threadidx )
overrideprotectedvirtual

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
startfirst index
stoplast index
threadidxgives an identifier (between 0 and nr of threads -1) that is unique to each call to doWork.

Implements ParallelTask.

◆ nrIterations()

od_int64 VolProc::StatsCalculatorTask::nrIterations ( ) const
inlineoverrideprotectedvirtual
Returns
the number of times the process should be run.

Implements ParallelTask.

◆ prepareWork()

void VolProc::StatsCalculatorTask::prepareWork ( )
protected

◆ sKeyEllipse()

static const char * VolProc::StatsCalculatorTask::sKeyEllipse ( )
inlinestatic

◆ totalNr()

od_int64 VolProc::StatsCalculatorTask::totalNr ( ) const
inlineoverridevirtual

Reimplemented from ParallelTask.

◆ uiMessage()

uiString VolProc::StatsCalculatorTask::uiMessage ( ) const
overridevirtual

Reimplemented from Task.

Member Data Documentation

◆ datalock_

Threads::Lock VolProc::StatsCalculatorTask::datalock_
protected

◆ input_

const Array3D<float>& VolProc::StatsCalculatorTask::input_
protected

◆ nzsampextra_

int VolProc::StatsCalculatorTask::nzsampextra_
protected

◆ output_

Array3D<float>& VolProc::StatsCalculatorTask::output_
protected

◆ positions_

TypeSet<BinID> VolProc::StatsCalculatorTask::positions_
protected

◆ shape_

BufferString VolProc::StatsCalculatorTask::shape_
protected

◆ statstype_

BufferString VolProc::StatsCalculatorTask::statstype_
protected

◆ stepout_

BinID VolProc::StatsCalculatorTask::stepout_
protected

◆ tkzsin_

TrcKeyZSampling VolProc::StatsCalculatorTask::tkzsin_
protected

◆ tkzsout_

TrcKeyZSampling VolProc::StatsCalculatorTask::tkzsout_
protected

◆ totalnr_

od_int64 VolProc::StatsCalculatorTask::totalnr_
protected

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