OpendTect  6.6
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PreStack::AGC Class Reference

Processor for PreStack AGC. More...

Inheritance diagram for PreStack::AGC:
[legend]

Public Member Functions

 AGC ()
 
void fillPar (IOPar &) const
 
float getLowEnergyMute () const
 
const Interval< float > & getWindow () const
 
void getWindowUnit (BufferString &, bool withparens) const
 
bool prepareWork ()
 
void setLowEnergyMute (float fraction)
 
void setWindow (const Interval< float > &)
 
bool usePar (const IOPar &)
 
- Public Member Functions inherited from PreStack::Processor
virtual ~Processor ()
 
virtual void adjustPossibleCompArea (TrcKeySampling &)
 
virtual uiString errMsg () const
 
virtual const BinIDgetInputStepout () const
 
DataPack::ID getOutput (const BinID &relbid) const
 
bool getOutputInterest (const BinID &relbid) const
 
const BinIDgetOutputStepout () const
 
virtual bool mustHaveUserInput ()
 
virtual od_int64 nrIterations () const
 
int nrOffsets () const
 
virtual bool reset (bool force=true)
 
virtual void retainCurBID (const BinID &)
 
void setInput (const BinID &relbid, DataPack::ID)
 
virtual bool setOutputInterest (const BinID &relbid, bool)
 
virtual bool usesPreStackInput () const
 
virtual bool wantsInput (const BinID &relbid) 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...
 
- 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
 

Static Public Member Functions

static const char * sKeyMuteFraction ()
 
static const char * sKeyWindow ()
 
- 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

bool doWork (od_int64, od_int64, int)
 
od_int64 totalNr () const
 
- Protected Member Functions inherited from PreStack::Processor
 Processor (const char *nm)
 
virtual GathercreateOutputArray (const Gather &input) const
 
- 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
 

Protected Attributes

float mutefraction_
 
Interval< int > samplewindow_
 
int totalnr_
 
Interval< float > window_
 
- Protected Attributes inherited from PreStack::Processor
ObjectSet< Gatherinputs_
 
BoolTypeSet outputinterest_
 
ObjectSet< Gatheroutputs_
 
BinID outputstepout_
 
- 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 Protected Member Functions inherited from PreStack::Processor
static void freeArray (ObjectSet< Gather > &)
 
static int getRelBidOffset (const BinID &relbid, const BinID &stepout)
 

Detailed Description

Processor for PreStack AGC.

<>

Constructor & Destructor Documentation

◆ AGC()

PreStack::AGC::AGC ( )

Member Function Documentation

◆ doWork()

bool PreStack::AGC::doWork ( od_int64  start,
od_int64  stop,
int   
)
protectedvirtual

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

Implements PreStack::Processor.

◆ fillPar()

void PreStack::AGC::fillPar ( IOPar ) const
virtual

Implements PreStack::Processor.

◆ getLowEnergyMute()

float PreStack::AGC::getLowEnergyMute ( ) const

◆ getWindow()

const Interval<float>& PreStack::AGC::getWindow ( ) const

◆ getWindowUnit()

void PreStack::AGC::getWindowUnit ( BufferString ,
bool  withparens 
) const

◆ prepareWork()

bool PreStack::AGC::prepareWork ( )
virtual

Reimplemented from PreStack::Processor.

◆ setLowEnergyMute()

void PreStack::AGC::setLowEnergyMute ( float  fraction)

◆ setWindow()

void PreStack::AGC::setWindow ( const Interval< float > &  )

◆ sKeyMuteFraction()

static const char* PreStack::AGC::sKeyMuteFraction ( )
static

◆ sKeyWindow()

static const char* PreStack::AGC::sKeyWindow ( )
static

◆ totalNr()

od_int64 PreStack::AGC::totalNr ( ) const
inlineprotectedvirtual

Reimplemented from ParallelTask.

◆ usePar()

bool PreStack::AGC::usePar ( const IOPar )
virtual

Implements PreStack::Processor.

Member Data Documentation

◆ mutefraction_

float PreStack::AGC::mutefraction_
protected

◆ samplewindow_

Interval<int> PreStack::AGC::samplewindow_
protected

◆ totalnr_

int PreStack::AGC::totalnr_
protected

◆ window_

Interval<float> PreStack::AGC::window_
protected

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