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

Processor for PreStack muting. More...

Inheritance diagram for PreStack::Mute:
[legend]

Public Member Functions

 Mute ()
 
 ~Mute ()
 
uiString errMsg () const override
 
void fillPar (IOPar &) const override
 
bool isTailMute () const
 
bool mustHaveUserInput () override
 
MuteDefmuteDef ()
 
const MuteDefmuteDef () const
 
const MultiIDmuteDefID () const
 
bool prepareWork () override
 
void setEmptyMute ()
 
bool setMuteDefID (const MultiID &)
 
void setTailMute (bool yn=true)
 
void setTaperLength (float)
 
float taperLength () const
 
bool usePar (const IOPar &) override
 
- Public Member Functions inherited from PreStack::Processor
 ~Processor ()
 
virtual void adjustPossibleCompArea (TrcKeySampling &)
 
virtual const BinIDgetInputStepout () const
 
DataPackID getOutput (const BinID &relbid) const
 
bool getOutputInterest (const BinID &relbid) const
 
const BinIDgetOutputStepout () const
 
od_int64 nrIterations () const override
 
int nrOffsets () const
 
virtual bool reset (bool force=true)
 
virtual void retainCurBID (const BinID &)
 
void setInput (const BinID &relbid, DataPackID)
 
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 ()
 
void doParallel (bool yn)
 
bool execute () override
 
virtual bool executeParallel (bool parallel)
 
std::int64_t nrDone () const override
 May be -1, i.e. class does not report nrdone. More...
 
std::int64_t totalNr () const override
 
- Public Member Functions inherited from ReportingTask
virtual ~ReportingTask ()
 
void getProgress (const ReportingTask &)
 
- 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
 
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 * sMuteDef ()
 
static const char * sTailMute ()
 
static const char * sTaperLength ()
 
- 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) override
 
od_int64 nrIterations () const override
 
- 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 (std::int64_t increment)
 
std::int64_t calculateThreadSize (std::int64_t totalnr, int nrthreads, int thread) const
 
virtual int maxNrThreads () const
 
virtual int minThreadSize () const
 
void quickAddToNrDone (std::int64_t 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() More...
 
void updateProgressMeter (bool forced=false, std::int64_t *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

MuteDefdef_
 
uiString errmsg_
 
MultiID id_
 
Mutermuter_ = nullptr
 
TypeSet< int > offsets_
 
TypeSet< int > outidx_
 
bool tail_ = false
 
float taperlen_ = 10
 
- Protected Attributes inherited from PreStack::Processor
RefObjectSet< Gatherinputs_
 
BoolTypeSet outputinterest_
 
RefObjectSet< 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
 
- Public Attributes inherited from ReportingTask
Notifier< ReportingTaskprogressUpdated
 
- Static Protected Member Functions inherited from PreStack::Processor
static void freeArray (ObjectSet< Gather > &)
 
static void freeArray (RefObjectSet< Gather > &)
 
static int getRelBidOffset (const BinID &relbid, const BinID &stepout)
 

Detailed Description

Processor for PreStack muting.

<>

Constructor & Destructor Documentation

◆ Mute()

PreStack::Mute::Mute ( )

◆ ~Mute()

PreStack::Mute::~Mute ( )

Member Function Documentation

◆ doWork()

bool PreStack::Mute::doWork ( od_int64  start,
od_int64  stop,
int   
)
overrideprotectedvirtual

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

Implements PreStack::Processor.

◆ errMsg()

uiString PreStack::Mute::errMsg ( ) const
inlineoverridevirtual

Reimplemented from PreStack::Processor.

◆ fillPar()

void PreStack::Mute::fillPar ( IOPar ) const
overridevirtual

Implements PreStack::Processor.

◆ isTailMute()

bool PreStack::Mute::isTailMute ( ) const
inline

◆ mustHaveUserInput()

bool PreStack::Mute::mustHaveUserInput ( )
inlineoverridevirtual

Reimplemented from PreStack::Processor.

◆ muteDef() [1/2]

MuteDef& PreStack::Mute::muteDef ( )
inline

◆ muteDef() [2/2]

const MuteDef& PreStack::Mute::muteDef ( ) const
inline

◆ muteDefID()

const MultiID& PreStack::Mute::muteDefID ( ) const
inline

◆ nrIterations()

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

Implements ParallelTask.

◆ prepareWork()

bool PreStack::Mute::prepareWork ( )
overridevirtual

Reimplemented from PreStack::Processor.

◆ setEmptyMute()

void PreStack::Mute::setEmptyMute ( )

◆ setMuteDefID()

bool PreStack::Mute::setMuteDefID ( const MultiID )

◆ setTailMute()

void PreStack::Mute::setTailMute ( bool  yn = true)

◆ setTaperLength()

void PreStack::Mute::setTaperLength ( float  )

◆ sMuteDef()

static const char* PreStack::Mute::sMuteDef ( )
inlinestatic

◆ sTailMute()

static const char* PreStack::Mute::sTailMute ( )
inlinestatic

◆ sTaperLength()

static const char* PreStack::Mute::sTaperLength ( )
inlinestatic

◆ taperLength()

float PreStack::Mute::taperLength ( ) const
inline

◆ usePar()

bool PreStack::Mute::usePar ( const IOPar )
overridevirtual

Implements PreStack::Processor.

Member Data Documentation

◆ def_

MuteDef& PreStack::Mute::def_
protected

◆ errmsg_

uiString PreStack::Mute::errmsg_
protected

◆ id_

MultiID PreStack::Mute::id_
protected

◆ muter_

Muter* PreStack::Mute::muter_ = nullptr
protected

◆ offsets_

TypeSet<int> PreStack::Mute::offsets_
protected

◆ outidx_

TypeSet<int> PreStack::Mute::outidx_
protected

◆ tail_

bool PreStack::Mute::tail_ = false
protected

◆ taperlen_

float PreStack::Mute::taperlen_ = 10
protected

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