PreStack::Mute Class Reference

Processor for PreStack muting. More...

Inheritance diagram for PreStack::Mute:

Public Member Functions
	Mute ()
	~Mute ()
uiString	errMsg () const
void	fillPar (IOPar &) const
bool	isTailMute () const
bool	mustHaveUserInput ()
MuteDef &	muteDef ()
const MuteDef &	muteDef () const
const MultiID &	muteDefID () const
bool	prepareWork ()
void	setEmptyMute ()
bool	setMuteDefID (const MultiID &)
void	setTailMute (bool yn=true)
void	setTaperLength (float)
float	taperLength () const
bool	usePar (const IOPar &)
Public Member Functions inherited from PreStack::Processor
virtual	~Processor ()
virtual void	adjustPossibleCompArea (TrcKeySampling &)
virtual const BinID &	getInputStepout () const
DataPack::ID	getOutput (const BinID &relbid) const
bool	getOutputInterest (const BinID &relbid) const
const BinID &	getOutputStepout () 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...
int64_t	totalNr () const
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_type &	name () const
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

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)
od_int64	nrIterations () const
Protected Member Functions inherited from PreStack::Processor
	Processor (const char *nm)
virtual Gather *	createOutputArray (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
MuteDef &	def_
uiString	errmsg_
MultiID	id_
Muter *	muter_
TypeSet< int >	offsets_
TypeSet< int >	outidx_
bool	tail_
float	taperlen_
Protected Attributes inherited from PreStack::Processor
ObjectSet< Gather >	inputs_
BoolTypeSet	outputinterest_
ObjectSet< Gather >	outputs_
BinID	outputstepout_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
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 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 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    )

protectedvirtual

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

inlinevirtual

Reimplemented from PreStack::Processor.

fillPar()

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

virtual

Implements PreStack::Processor.

isTailMute()

bool PreStack::Mute::isTailMute ( ) const

inline

mustHaveUserInput()

bool PreStack::Mute::mustHaveUserInput ( )

inlinevirtual

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

inlineprotectedvirtual

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.

Reimplemented from PreStack::Processor.

prepareWork()

bool PreStack::Mute::prepareWork ( )

virtual

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 &  )

virtual

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_

protected

offsets_

TypeSet<int> PreStack::Mute::offsets_

protected

outidx_

TypeSet<int> PreStack::Mute::outidx_

protected

tail_

bool PreStack::Mute::tail_

protected

taperlen_

float PreStack::Mute::taperlen_

protected