RayTracer1D Class Reference

Ray tracer in 1D. More...

Inheritance diagram for RayTracer1D:

Classes
class	Setup

Public Member Functions
	~RayTracer1D ()
bool	areDepthsInFeet () const
bool	areOffsetsInFeet () const
virtual void	fillPar (IOPar &) const
float	getDepth (int layer) const
const ElasticModel &	getModel () const
void	getOffsets (TypeSet< float > &offsets) const
ConstRefMan< OffsetReflectivityModel >	getRefModel () const
float	getTime (int layer, int offset) const
virtual bool	hasSameParams (const RayTracer1D &) const
bool	needsSwave () const
bool	setModel (const ElasticModel &)
void	setOffsets (const TypeSet< float > &offsets)
void	setOffsets (const TypeSet< float > &offsets, Seis::OffsetType)
virtual const RayTracer1D::Setup &	setup () const =0
virtual RayTracer1D::Setup &	setup ()=0
uiString	uiMessage () const override
	will be message() again in 7.x More...
virtual bool	usePar (const IOPar &)
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	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 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

Static Public Member Functions
static RayTracer1D *	createInstance (const IOPar &, const ElasticModel *, uiString &)
static RayTracer1D *	createInstance (const IOPar &, const ElasticModel *, uiString &, const Setup *)
static RayTracer1D *	createInstance (const IOPar &, uiString &)
static RayTracer1D *	createInstance (const IOPar &, uiString &, const Setup *)
static StepInterval< float >	sDefOffsetRange ()
static StepInterval< float >	sDefOffsetRange (Seis::OffsetType)
static void	setIOParsToZeroOffset (IOPar &)
static const char *	sKeyOffset ()
static const char *	sKeyOffsetInFeet ()
static const char *	sKeyRayPar ()
static const char *	sKeyReflectivity ()
static const char *	sKeyWavetypes ()
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
	RayTracer1D ()
virtual bool	compute (int layer, int offidx, float rayparam)
bool	doFinish (bool) override
bool	doPrepare (int) override
od_int64	nrIterations () const override
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 ()
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
float *	depths_ = nullptr
ElasticModel &	model_
uiString	msg_
TypeSet< int >	offsetpermutation_
TypeSet< float >	offsets_
float_complex **	reflectivities_ = nullptr
RefMan< OffsetReflectivityModel >	refmodel_
float **	sinarr_ = nullptr
float **	twt_ = nullptr
float *	velmax_ = nullptr
float *	zerooffstwt_ = 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_

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< ReportingTask >	progressUpdated

Detailed Description

Ray tracer in 1D.

<>

Constructor & Destructor Documentation

~RayTracer1D()

RayTracer1D::~RayTracer1D

(

)

RayTracer1D()

RayTracer1D::RayTracer1D ( )

protected

Member Function Documentation

areDepthsInFeet()

bool RayTracer1D::areDepthsInFeet

(

)

const

areOffsetsInFeet()

bool RayTracer1D::areOffsetsInFeet

(

)

const

compute()

virtual bool RayTracer1D::compute ( int  layer, int  offidx, float  rayparam  )

protectedvirtual

Reimplemented in VrmsRayTracer1D.

createInstance() [1/4]

static RayTracer1D* RayTracer1D::createInstance ( const IOPar &  , const ElasticModel *  , uiString &    )

static

createInstance() [2/4]

static RayTracer1D* RayTracer1D::createInstance ( const IOPar &  , const ElasticModel *  , uiString &  , const Setup *    )

static

createInstance() [3/4]

static RayTracer1D* RayTracer1D::createInstance ( const IOPar &  , uiString &    )

static

createInstance() [4/4]

static RayTracer1D* RayTracer1D::createInstance ( const IOPar &  , uiString &  , const Setup *    )

static

doFinish()

bool RayTracer1D::doFinish ( bool  success )

overrideprotectedvirtual

Called after all doWork have finished.

Parameters

success

indicates whether all doWork returned true.

Reimplemented from ParallelTask.

doPrepare()

bool RayTracer1D::doPrepare ( int  nrthreads )

overrideprotectedvirtual

Called once, before any doWork is called.

Reimplemented from ParallelTask.

fillPar()

virtual void RayTracer1D::fillPar ( IOPar &  ) const

virtual

getDepth()

float RayTracer1D::getDepth

(

int

layer

)

const

getModel()

const ElasticModel& RayTracer1D::getModel ( ) const

inline

getOffsets()

void RayTracer1D::getOffsets

(

TypeSet< float > &

offsets

)

const

getRefModel()

ConstRefMan<OffsetReflectivityModel> RayTracer1D::getRefModel

(

)

const

getTime()

float RayTracer1D::getTime	(	int	layer,
		int	offset
	)		const

hasSameParams()

virtual bool RayTracer1D::hasSameParams ( const RayTracer1D &  ) const

virtual

needsSwave()

bool RayTracer1D::needsSwave

(

)

const

nrIterations()

od_int64 RayTracer1D::nrIterations ( ) const

overrideprotectedvirtual

Returns

the number of times the process should be run.

Implements ParallelTask.

sDefOffsetRange() [1/2]

static StepInterval<float> RayTracer1D::sDefOffsetRange ( )

static

sDefOffsetRange() [2/2]

static StepInterval<float> RayTracer1D::sDefOffsetRange ( Seis::OffsetType  )

static

setIOParsToZeroOffset()

static void RayTracer1D::setIOParsToZeroOffset ( IOPar &  )

static

setModel()

bool RayTracer1D::setModel

(

const ElasticModel &

)

setOffsets() [1/2]

void RayTracer1D::setOffsets

(

const TypeSet< float > &

offsets

)

<Note, if either p-wave or s-wave are undef, will fill them with Castagna to compute zoeppritz coeffs <!

setOffsets() [2/2]

void RayTracer1D::setOffsets	(	const TypeSet< float > &	offsets,
		Seis::OffsetType
	)

setup() [1/2]

virtual const RayTracer1D::Setup& RayTracer1D::setup ( ) const

pure virtual

Implemented in VrmsRayTracer1D.

setup() [2/2]

virtual RayTracer1D::Setup& RayTracer1D::setup ( )

pure virtual

Implemented in VrmsRayTracer1D.

sKeyOffset()

static const char* RayTracer1D::sKeyOffset ( )

inlinestatic

sKeyOffsetInFeet()

static const char* RayTracer1D::sKeyOffsetInFeet ( )

inlinestatic

sKeyRayPar()

static const char* RayTracer1D::sKeyRayPar ( )

inlinestatic

sKeyReflectivity()

static const char* RayTracer1D::sKeyReflectivity ( )

inlinestatic

sKeyWavetypes()

static const char* RayTracer1D::sKeyWavetypes ( )

inlinestatic

uiMessage()

uiString RayTracer1D::uiMessage ( ) const

inlineoverridevirtual

will be message() again in 7.x

Reimplemented from Task.

usePar()

virtual bool RayTracer1D::usePar ( const IOPar &  )

virtual

Member Data Documentation

depths_

float* RayTracer1D::depths_ = nullptr

protected

model_

ElasticModel& RayTracer1D::model_

protected

msg_

uiString RayTracer1D::msg_

protected

offsetpermutation_

TypeSet<int> RayTracer1D::offsetpermutation_

protected

offsets_

TypeSet<float> RayTracer1D::offsets_

protected

reflectivities_

float_complex** RayTracer1D::reflectivities_ = nullptr

protected

refmodel_

RefMan<OffsetReflectivityModel> RayTracer1D::refmodel_

protected

sinarr_

float** RayTracer1D::sinarr_ = nullptr

protected

twt_

float** RayTracer1D::twt_ = nullptr

protected

velmax_

float* RayTracer1D::velmax_ = nullptr

protected

zerooffstwt_

float* RayTracer1D::zerooffstwt_ = nullptr

protected