OpendTect  7.0
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
RayTracerRunner Class Reference
Inheritance diagram for RayTracerRunner:
[legend]

Public Member Functions

 RayTracerRunner (const char *rt1dfactkeywd=VrmsRayTracer1D::sFactoryKeyword())
 
 RayTracerRunner (const ElasticModelSet &, const IOPar &raypar)
 
 RayTracerRunner (const ElasticModelSet &, const IOPar &raypar, const RayTracer1D::Setup *)
 
 RayTracerRunner (const IOPar &raypar)
 
 ~RayTracerRunner ()
 
ConstRefMan< ReflectivityModelSetgetRefModels () const
 
od_int64 nrDone () const override
 May be -1, i.e. class does not report nrdone. More...
 
bool setModel (const ElasticModelSet &)
 
bool setModel (const ElasticModelSet &, const RayTracer1D::Setup *)
 
void setOffsets (const TypeSet< float > &)
 
void setOffsets (const TypeSet< float > &, Seis::OffsetType)
 
uiString uiMessage () const override
 will be message() again in 7.x More...
 
uiString uiNrDoneText () const override
 will be nrDoneText() in 7.x More...
 
- Public Member Functions inherited from ParallelTask
virtual ~ParallelTask ()
 
void doParallel (bool yn)
 
bool execute () override
 
virtual bool executeParallel (bool parallel)
 
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
 
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 ConstRefMan< ReflectivityModelSetgetRefModels (const ElasticModelSet &, const IOPar &raypar, uiString &msg, const RayTracer1D::Setup *, TaskRunner *=nullptr, const ObjectSet< const TimeDepthModel > *=nullptr)
 
static ConstRefMan< ReflectivityModelSetgetRefModels (const ElasticModelSet &, const IOPar &raypar, uiString &msg, TaskRunner *=nullptr, const ObjectSet< const TimeDepthModel > *=nullptr)
 
static const char * sKeyParallel ()
 
- 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 ()
 

Private Member Functions

void computeTotalNr ()
 
bool doFinish (bool) override
 
bool doPrepare (int) override
 
bool doWork (od_int64, od_int64, int) override
 
bool getResults (ReflectivityModelSet &) const
 
int modelIdx (od_int64, bool &startlayer) const
 
od_int64 nrIterations () const override
 

Private Attributes

uiString msg_
 
IOParraypar_
 
ObjectSet< RayTracer1Draytracers_
 
od_int64 totalnr_
 

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
 
- 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 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_
 

Detailed Description

A task to compute reflectivities from a set of ElasticModel objects, using the RayTracer1D factory. The results are stored as a set of ReflectivityModel objects, which combine time-depth models and associated reflectivities. Like for the TimeDepthModel class, the output depths units correspond to SI().depthsInFeet(), and are TVDSS depths (0 at sea-level, not at SRD, positive below sea-level and increasing downwards. The first layer of each ElasticModel must be a SRD.

<>

Constructor & Destructor Documentation

◆ RayTracerRunner() [1/4]

RayTracerRunner::RayTracerRunner ( const char *  rt1dfactkeywd = VrmsRayTracer1D::sFactoryKeyword())

◆ RayTracerRunner() [2/4]

RayTracerRunner::RayTracerRunner ( const IOPar raypar)

◆ RayTracerRunner() [3/4]

RayTracerRunner::RayTracerRunner ( const ElasticModelSet ,
const IOPar raypar 
)

◆ RayTracerRunner() [4/4]

RayTracerRunner::RayTracerRunner ( const ElasticModelSet ,
const IOPar raypar,
const RayTracer1D::Setup  
)

◆ ~RayTracerRunner()

RayTracerRunner::~RayTracerRunner ( )

Member Function Documentation

◆ computeTotalNr()

void RayTracerRunner::computeTotalNr ( )
private

◆ doFinish()

bool RayTracerRunner::doFinish ( bool  success)
overrideprivatevirtual

Called after all doWork have finished.

Parameters
successindicates whether all doWork returned true.

Reimplemented from ParallelTask.

◆ doPrepare()

bool RayTracerRunner::doPrepare ( int  nrthreads)
overrideprivatevirtual

Called once, before any doWork is called.

Reimplemented from ParallelTask.

◆ doWork()

bool RayTracerRunner::doWork ( od_int64  ,
od_int64  ,
int   
)
overrideprivate

◆ getRefModels() [1/3]

ConstRefMan<ReflectivityModelSet> RayTracerRunner::getRefModels ( ) const

◆ getRefModels() [2/3]

static ConstRefMan<ReflectivityModelSet> RayTracerRunner::getRefModels ( const ElasticModelSet ,
const IOPar raypar,
uiString msg,
const RayTracer1D::Setup ,
TaskRunner = nullptr,
const ObjectSet< const TimeDepthModel > *  = nullptr 
)
static

◆ getRefModels() [3/3]

static ConstRefMan<ReflectivityModelSet> RayTracerRunner::getRefModels ( const ElasticModelSet ,
const IOPar raypar,
uiString msg,
TaskRunner = nullptr,
const ObjectSet< const TimeDepthModel > *  = nullptr 
)
static

◆ getResults()

bool RayTracerRunner::getResults ( ReflectivityModelSet ) const
private

◆ modelIdx()

int RayTracerRunner::modelIdx ( od_int64  ,
bool &  startlayer 
) const
private

◆ nrDone()

od_int64 RayTracerRunner::nrDone ( ) const
overridevirtual

May be -1, i.e. class does not report nrdone.

Reimplemented from ParallelTask.

◆ nrIterations()

od_int64 RayTracerRunner::nrIterations ( ) const
overrideprivatevirtual
Returns
the number of times the process should be run.

Implements ParallelTask.

◆ setModel() [1/2]

bool RayTracerRunner::setModel ( const ElasticModelSet )

◆ setModel() [2/2]

bool RayTracerRunner::setModel ( const ElasticModelSet ,
const RayTracer1D::Setup  
)

◆ setOffsets() [1/2]

void RayTracerRunner::setOffsets ( const TypeSet< float > &  )

◆ setOffsets() [2/2]

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

◆ sKeyParallel()

static const char* RayTracerRunner::sKeyParallel ( )
static

◆ uiMessage()

uiString RayTracerRunner::uiMessage ( ) const
inlineoverridevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

uiString RayTracerRunner::uiNrDoneText ( ) const
overridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

◆ msg_

uiString RayTracerRunner::msg_
private

◆ raypar_

IOPar& RayTracerRunner::raypar_
private

◆ raytracers_

ObjectSet<RayTracer1D> RayTracerRunner::raytracers_
private

◆ totalnr_

od_int64 RayTracerRunner::totalnr_
private

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