PreStack::Processor Class Reference

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

#include <prestackprocessor.h>

Inheritance diagram for PreStack::Processor:

Public Member Functions
	~Processor ()
virtual void	adjustPossibleCompArea (TrcKeySampling &)
virtual bool	canDoSynthetics () const
bool	doWork (od_int64 start, od_int64 stop, int) override=0
virtual uiString	errMsg () const
virtual void	fillPar (IOPar &) const =0
OD::GeomSystem	getGeomSystem () const
virtual const BinID &	getInputStepout () const
const ElasticModel *	getModel (const BinID &relbid) const
ConstRefMan< Gather >	getOutput (const BinID &relbid) const
DataPackID	getOutputID (const BinID &relbid) const
bool	getOutputInterest (const BinID &relbid) const
const BinID &	getOutputStepout () const
virtual bool	mustHaveUserInput () const
od_int64	nrIterations () const override
int	nrOffsets () const
virtual bool	prepareWork ()
virtual bool	reset (bool force=true)
virtual void	retainCurBID (const BinID &)
void	setGeomSystem (OD::GeomSystem)
void	setInput (const BinID &, const Gather *)
void	setInput (const BinID &, Gather *)
void	setInput (const BinID &relbid, DataPackID)
void	setModel (const BinID &, const ElasticModel *)
virtual bool	setOutputInterest (const BinID &relbid, bool)
virtual bool	showInEditor () const
virtual bool	usePar (const IOPar &)=0
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)
od_int64	nrDone () const override
	May be -1, i.e. class does not report nrdone.
od_int64	totalNr () const override
Public Member Functions inherited from ReportingTask
	ReportingTask (const ReportingTask &)=delete
virtual	~ReportingTask ()
void	getProgress (const ReportingTask &)
ReportingTask &	operator= (const ReportingTask &)=delete
void	setSimpleMeter (bool yn, int repperc)
int	simpleMeterStep () const
bool	useSimpleMeter () const
Public Member Functions inherited from Task
	Task (const Task &)=delete
virtual	~Task ()
virtual void	controlWork (Control)
virtual void	enableWorkControl (bool=true)
	Must be called before execute()
virtual uiRetVal	errorWithDetails () const
virtual Control	getState () const
Task &	operator= (const Task &)=delete
virtual uiString	uiMessage () const
virtual uiString	uiNrDoneText () const
bool	workControlEnabled () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=nullptr)
	NamedCallBacker (const NamedCallBacker &)=delete
	~NamedCallBacker ()
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
NamedCallBacker &	operator= (const NamedCallBacker &)=delete
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.
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.
CallBacker &	operator= (const CallBacker &)=delete
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
	Processor (const char *nm)
virtual Gather *	createOutputArray (const Gather &input) const
Protected Member Functions inherited from ParallelTask
	ParallelTask (const char *nm=0)
void	addToNrDone (od_int64 increment)
od_int64	calculateThreadSize (od_int64 totalnr, int nrthreads, int thread) const
virtual int	maxNrThreads () const
virtual int	minThreadSize () const
void	quickAddToNrDone (od_int64 loopidx)
void	resetNrDone ()
virtual bool	stopAllOnFailure () const
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()
void	updateProgressMeter (bool forced=false, od_int64 *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

Static Protected Member Functions
static int	getRelBidOffset (const BinID &relbid, const BinID &stepout)

Protected Attributes
OD::GeomSystem	gs_
RefObjectSet< Gather >	inputs_
ObjectSet< const ElasticModel >	models_
BoolTypeSet	outputinterest_
RefObjectSet< Gather >	outputs_
BinID	outputstepout_
Protected Attributes inherited from Task
Control	control_ = Task::Run
Threads::ConditionVar *	workcontrolcondvar_ = nullptr
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 Public Member Functions inherited from ParallelTask
static uiString	sPosFinished ()
static uiString	sTrcFinished ()
Static Public Member Functions inherited from ReportingTask
static PtrMan< ProgressMeter >	getTextProgressMeter (od_ostream &, const IOPar *iop=nullptr)
static bool	needSimpleLogging (const IOPar &)
static const char *	sKeySimpleLogging ()
static const char *	sKeySimpleLoggingStep ()
Static Public Member Functions inherited from Task
static uiString	uiStdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()
Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

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

~Processor()

PreStack::Processor::~Processor

(

)

Processor()

PreStack::Processor::Processor ( const char * nm )

protected

Member Function Documentation

adjustPossibleCompArea()

virtual void PreStack::Processor::adjustPossibleCompArea ( TrcKeySampling & )

inlinevirtual

canDoSynthetics()

virtual bool PreStack::Processor::canDoSynthetics ( ) const

inlinevirtual

Reimplemented in PreStack::LateralStack, and PreStack::TrimStatics.

createOutputArray()

virtual Gather * PreStack::Processor::createOutputArray ( const Gather & input ) const

protectedvirtual

doWork()

bool PreStack::Processor::doWork ( od_int64 start, od_int64 stop, int  )

overridepure virtual

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

Implements ParallelTask.

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

errMsg()

virtual uiString PreStack::Processor::errMsg ( ) const

inlinevirtual

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

fillPar()

virtual void PreStack::Processor::fillPar ( IOPar & ) const

pure virtual

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

getGeomSystem()

OD::GeomSystem PreStack::Processor::getGeomSystem ( ) const

inline

getInputStepout()

virtual const BinID & PreStack::Processor::getInputStepout ( ) const

virtual

Reimplemented in PreStack::LateralStack.

getModel()

const ElasticModel * PreStack::Processor::getModel

(

const BinID &

relbid

)

const

getOutput()

ConstRefMan< Gather > PreStack::Processor::getOutput

(

const BinID &

relbid

)

const

getOutputID()

DataPackID PreStack::Processor::getOutputID

(

const BinID &

relbid

)

const

getOutputInterest()

bool PreStack::Processor::getOutputInterest

(

const BinID &

relbid

)

const

getOutputStepout()

const BinID & PreStack::Processor::getOutputStepout

(

)

const

getRelBidOffset()

static int PreStack::Processor::getRelBidOffset ( const BinID & relbid, const BinID & stepout )

staticprotected

mustHaveUserInput()

virtual bool PreStack::Processor::mustHaveUserInput ( ) const

inlinevirtual

Reimplemented in PreStack::Mute.

nrIterations()

od_int64 PreStack::Processor::nrIterations ( ) const

inlineoverridevirtual

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::Stack, and PreStack::TrimStatics.

nrOffsets()

int PreStack::Processor::nrOffsets

(

)

const

prepareWork()

virtual bool PreStack::Processor::prepareWork ( )

virtual

Reimplemented in PreStack::AGC, PreStack::LateralStack, PreStack::Mute, and PreStack::TrimStatics.

reset()

virtual bool PreStack::Processor::reset ( bool force = true )

virtual

Reimplemented in PreStack::LateralStack.

retainCurBID()

virtual void PreStack::Processor::retainCurBID ( const BinID & )

inlinevirtual

setGeomSystem()

void PreStack::Processor::setGeomSystem

(

OD::GeomSystem

)

setInput() [1/3]

void PreStack::Processor::setInput	(	const BinID &	,
		const Gather *	)

setInput() [2/3]

void PreStack::Processor::setInput	(	const BinID &	,
		Gather *	)

setInput() [3/3]

void PreStack::Processor::setInput	(	const BinID &	relbid,
		DataPackID	)

setModel()

void PreStack::Processor::setModel	(	const BinID &	,
		const ElasticModel *	)

setOutputInterest()

virtual bool PreStack::Processor::setOutputInterest ( const BinID & relbid, bool  )

virtual

Reimplemented in PreStack::LateralStack.

showInEditor()

virtual bool PreStack::Processor::showInEditor ( ) const

inlinevirtual

usePar()

virtual bool PreStack::Processor::usePar ( const IOPar & )

pure virtual

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

usesPreStackInput()

virtual bool PreStack::Processor::usesPreStackInput ( ) const

inlinevirtual

wantsInput()

virtual bool PreStack::Processor::wantsInput ( const BinID & relbid ) const

virtual

Reimplemented in PreStack::LateralStack.

Member Data Documentation

gs_

OD::GeomSystem PreStack::Processor::gs_

protected

inputs_

RefObjectSet<Gather> PreStack::Processor::inputs_

protected

models_

ObjectSet<const ElasticModel> PreStack::Processor::models_

protected

outputinterest_

BoolTypeSet PreStack::Processor::outputinterest_

protected

outputs_

RefObjectSet<Gather> PreStack::Processor::outputs_

protected

outputstepout_

BinID PreStack::Processor::outputstepout_

protected