OpendTect-6_4  6.4
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
PreStack::Processor Class Referenceabstract

Processes PreStack data at one cdp location. The algorithm is implemented in subclasses, and can be created by the PreStack::PF() factory. More...

Inheritance diagram for PreStack::Processor:
[legend]

Public Member Functions

 mDefineFactoryInClass (Processor, factory)
 
virtual bool reset (bool force=true)
 
virtual const BinIDgetInputStepout () const
 
virtual bool wantsInput (const BinID &relbid) const
 
void setInput (const BinID &relbid, DataPack::ID)
 
const BinIDgetOutputStepout () const
 
virtual bool setOutputInterest (const BinID &relbid, bool)
 
bool getOutputInterest (const BinID &relbid) const
 
DataPack::ID getOutput (const BinID &relbid) const
 
virtual bool prepareWork ()
 
virtual uiString errMsg () const
 
virtual void fillPar (IOPar &) const =0
 
virtual bool usePar (const IOPar &)=0
 
virtual bool doWork (od_int64 start, od_int64 stop, int)=0
 
int nrOffsets () const
 
virtual od_int64 nrIterations () const
 
virtual ~Processor ()
 
virtual bool usesPreStackInput () const
 
virtual void adjustPossibleCompArea (TrcKeySampling &)
 
virtual void retainCurBID (const BinID &)
 
virtual bool mustHaveUserInput ()
 
- 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 Member Functions

 Processor (const char *nm)
 
virtual GathercreateOutputArray (const Gather &input) const
 
- 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...
 

Static Protected Member Functions

static int getRelBidOffset (const BinID &relbid, const BinID &stepout)
 
static void freeArray (ObjectSet< Gather > &)
 

Protected Attributes

BinID outputstepout_
 
ObjectSet< Gatheroutputs_
 
BoolTypeSet outputinterest_
 
ObjectSet< Gatherinputs_
 
- 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 ()
 

Detailed Description

Processes PreStack data at one cdp location. The algorithm is implemented in subclasses, and can be created by the PreStack::PF() factory.

Constructor & Destructor Documentation

virtual PreStack::Processor::~Processor ( )
virtual
PreStack::Processor::Processor ( const char *  nm)
protected

Member Function Documentation

virtual void PreStack::Processor::adjustPossibleCompArea ( TrcKeySampling )
inlinevirtual
virtual Gather* PreStack::Processor::createOutputArray ( const Gather input) const
protectedvirtual
virtual bool PreStack::Processor::doWork ( od_int64  start,
od_int64  stop,
int   
)
pure virtual

If nrIterations is not overridden, start and stop will refer to offsets that should be processed.

Implemented in PreStack::AngleMute, PreStack::TrimStatics, PreStack::Mute, PreStack::LateralStack, PreStack::AGC, and PreStack::Stack.

virtual uiString PreStack::Processor::errMsg ( ) const
inlinevirtual
virtual void PreStack::Processor::fillPar ( IOPar ) const
pure virtual
static void PreStack::Processor::freeArray ( ObjectSet< Gather > &  )
staticprotected
virtual const BinID& PreStack::Processor::getInputStepout ( ) const
virtual

Reimplemented in PreStack::LateralStack.

DataPack::ID PreStack::Processor::getOutput ( const BinID relbid) const
bool PreStack::Processor::getOutputInterest ( const BinID relbid) const
const BinID& PreStack::Processor::getOutputStepout ( ) const
static int PreStack::Processor::getRelBidOffset ( const BinID relbid,
const BinID stepout 
)
staticprotected
PreStack::Processor::mDefineFactoryInClass ( Processor  ,
factory   
)
virtual bool PreStack::Processor::mustHaveUserInput ( )
inlinevirtual

Reimplemented in PreStack::Mute.

virtual od_int64 PreStack::Processor::nrIterations ( ) const
inlinevirtual

If algorithms cannot be done in parallel with regards to offsets, override function and return 1. doWork() will then be called with start=stop=0 and you can do whatever you want in doWork. You can also return number of samples in gather and run it parallel vertically.

Implements ParallelTask.

Reimplemented in PreStack::AngleMute, PreStack::TrimStatics, PreStack::Mute, PreStack::LateralStack, and PreStack::Stack.

int PreStack::Processor::nrOffsets ( ) const
virtual bool PreStack::Processor::prepareWork ( )
virtual
virtual bool PreStack::Processor::reset ( bool  force = true)
virtual

Reimplemented in PreStack::LateralStack.

virtual void PreStack::Processor::retainCurBID ( const BinID )
inlinevirtual
void PreStack::Processor::setInput ( const BinID relbid,
DataPack::ID   
)
virtual bool PreStack::Processor::setOutputInterest ( const BinID relbid,
bool   
)
virtual

Reimplemented in PreStack::LateralStack.

virtual bool PreStack::Processor::usePar ( const IOPar )
pure virtual
virtual bool PreStack::Processor::usesPreStackInput ( ) const
inlinevirtual
virtual bool PreStack::Processor::wantsInput ( const BinID relbid) const
virtual

Reimplemented in PreStack::LateralStack.

Member Data Documentation

ObjectSet<Gather> PreStack::Processor::inputs_
protected
BoolTypeSet PreStack::Processor::outputinterest_
protected
ObjectSet<Gather> PreStack::Processor::outputs_
protected
BinID PreStack::Processor::outputstepout_
protected

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