Tut::SeisTools Class Reference

Inheritance diagram for Tut::SeisTools:

Public Types
enum	Action { Scale , Square , Smooth , ChgSD }
Public Types inherited from Task
enum	Control { Run , Pause , Stop }
Public Types inherited from ObjectWithName
typedef OD::String	name_type

Public Member Functions
	SeisTools ()
virtual	~SeisTools ()
Action	action () const
float	factor () const
const IOObj *	input () const
od_int64	nrDone () const override
const IOObj *	output () const
SamplingData< float >	sampling () const
void	setAction (Action a)
void	setInput (const IOObj &)
void	setOutput (const IOObj &)
void	setRange (const TrcKeyZSampling &)
void	setSampling (SamplingData< float > sd)
void	setScale (float f, float s)
void	setWeakSmoothing (bool yn)
float	shift () const
od_int64	totalNr () const override
uiString	uiMessage () const override
	will be message() again in 7.x More...
uiString	uiNrDoneText () const override
	will be nrDoneText() in 7.x More...
bool	weakSmoothing () const
Public Member Functions inherited from Executor
	Executor (const char *nm)
virtual	~Executor ()
int	doStep () override
bool	execute () override
bool	go (od_ostream &s, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
bool	go (od_ostream *s=0, bool isfirst=true, bool islast=true, int delaybtwnstepsinms=0)
Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=nullptr)
virtual	~SequentialTask ()
bool	execute () 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
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 CallBacker *	trueCaller ()
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_type &	name () const override
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

Protected Member Functions
bool	createReader ()
bool	createWriter ()
bool	goImpl (od_ostream *, bool, bool, int) override
void	handleTrace ()
Protected Member Functions inherited from ReportingTask
	ReportingTask (const char *nm=nullptr)
void	incrementProgress ()
ProgressMeter *	progressMeter () 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
Action	action_
float	factor_ = 1.f
IOObj *	inioobj_ = nullptr
uiString	msg_
SamplingData< float >	newsd_
int	nrdone_ = 0
IOObj *	outioobj_ = nullptr
SeisTrcReader *	rdr_ = nullptr
float	shift_ = 0.f
TrcKeyZSampling	tkzs_
int	totnr_ = -1
SeisTrc &	trcin_
SeisTrc &	trcout_
bool	weaksmooth_ = false
SeisTrcWriter *	wrr_ = nullptr
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_

Private Member Functions
void	calculateTotalNr ()
int	nextStep () override

Additional Inherited Members
Static Public Member Functions inherited from SequentialTask
static int	ErrorOccurred ()
static int	Finished ()
static int	MoreToDo ()
static int	WarningAvailable ()
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 ()
Public Attributes inherited from Executor
Notifier< Executor >	poststep
	Only when MoreToDo will be returned. More...
Notifier< Executor >	prestep
Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

Detailed Description

<>

Member Enumeration Documentation

Action

enum Tut::SeisTools::Action

Enumerator
Scale
Square
Smooth
ChgSD

Constructor & Destructor Documentation

SeisTools()

Tut::SeisTools::SeisTools

(

)

~SeisTools()

virtual Tut::SeisTools::~SeisTools ( )

virtual

Member Function Documentation

action()

Action Tut::SeisTools::action ( ) const

inline

calculateTotalNr()

void Tut::SeisTools::calculateTotalNr ( )

private

createReader()

bool Tut::SeisTools::createReader ( )

protected

createWriter()

bool Tut::SeisTools::createWriter ( )

protected

factor()

float Tut::SeisTools::factor ( ) const

inline

goImpl()

bool Tut::SeisTools::goImpl ( od_ostream *  , bool  , bool  , int    )

overrideprotectedvirtual

Reimplemented from Executor.

handleTrace()

void Tut::SeisTools::handleTrace ( )

protected

input()

const IOObj* Tut::SeisTools::input ( ) const

inline

nextStep()

int Tut::SeisTools::nextStep ( )

overrideprivatevirtual

Return values

MoreToDo()	Not finished. Call me again.
Finished()	Nothing more to do.
ErrorOccurred()	Something went wrong.

Note

if function returns a value greater than cMoreToDo(), it should be interpreted as cMoreToDo().

Implements SequentialTask.

nrDone()

od_int64 Tut::SeisTools::nrDone ( ) const

inlineoverridevirtual

Note

nrDone is only used for displaying progress and will be compared to totalNr to show user how large part of the task that is finished.

Reimplemented from Task.

output()

const IOObj* Tut::SeisTools::output ( ) const

inline

sampling()

SamplingData<float> Tut::SeisTools::sampling ( ) const

inline

setAction()

void Tut::SeisTools::setAction ( Action  a )

inline

setInput()

void Tut::SeisTools::setInput

(

const IOObj &

)

setOutput()

void Tut::SeisTools::setOutput

(

const IOObj &

)

setRange()

void Tut::SeisTools::setRange

(

const TrcKeyZSampling &

)

setSampling()

void Tut::SeisTools::setSampling ( SamplingData< float >  sd )

inline

setScale()

void Tut::SeisTools::setScale ( float  f, float  s  )

inline

setWeakSmoothing()

void Tut::SeisTools::setWeakSmoothing ( bool  yn )

inline

shift()

float Tut::SeisTools::shift ( ) const

inline

totalNr()

od_int64 Tut::SeisTools::totalNr ( ) const

overridevirtual

Reimplemented from Task.

uiMessage()

uiString Tut::SeisTools::uiMessage ( ) const

overridevirtual

will be message() again in 7.x

Reimplemented from Task.

uiNrDoneText()

uiString Tut::SeisTools::uiNrDoneText ( ) const

inlineoverridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

weakSmoothing()

bool Tut::SeisTools::weakSmoothing ( ) const

inline

Member Data Documentation

action_

Action Tut::SeisTools::action_

protected

factor_

float Tut::SeisTools::factor_ = 1.f

protected

inioobj_

IOObj* Tut::SeisTools::inioobj_ = nullptr

protected

msg_

uiString Tut::SeisTools::msg_

protected

newsd_

SamplingData<float> Tut::SeisTools::newsd_

protected

nrdone_

int Tut::SeisTools::nrdone_ = 0

protected

outioobj_

IOObj* Tut::SeisTools::outioobj_ = nullptr

protected

rdr_

SeisTrcReader* Tut::SeisTools::rdr_ = nullptr

protected

shift_

float Tut::SeisTools::shift_ = 0.f

protected

tkzs_

TrcKeyZSampling Tut::SeisTools::tkzs_

protected

totnr_

int Tut::SeisTools::totnr_ = -1

protected

trcin_

SeisTrc& Tut::SeisTools::trcin_

protected

trcout_

SeisTrc& Tut::SeisTools::trcout_

protected

weaksmooth_

bool Tut::SeisTools::weaksmooth_ = false

protected

wrr_

SeisTrcWriter* Tut::SeisTools::wrr_ = nullptr

protected