OpendTect  7.0
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
MPE::SectionAdjuster Class Reference

SequentialTask to adjust the section of an EM object with ID EM::SectionID. More...

Inheritance diagram for MPE::SectionAdjuster:
[legend]

Public Member Functions

virtual ~SectionAdjuster ()
 
const char * errMsg () const
 
virtual void fillPar (IOPar &) const
 
virtual TrcKeyZSampling getAttribCube (const Attrib::SelSpec &) const
 
virtual const Attrib::SelSpecgetAttributeSel (int idx) const
 
virtual void getNeededAttribs (TypeSet< Attrib::SelSpec > &) const
 
virtual int getNrAttributes () const
 
float getThresholdValue () const
 
virtual bool hasInitializedSetup () const
 
virtual bool is2D () const
 
int nextStep () override
 
bool removeOnFailure (bool yn)
 
bool removesOnFailure () const
 
virtual void reset ()
 
mDeprecatedObs EM::SectionID sectionID () const
 
virtual void setAttributeSel (int idx, const Attrib::SelSpec &)
 
void setPositions (const TypeSet< TrcKey > &targets, const TypeSet< TrcKey > *src=0)
 
void setSeedId (int)
 
void setSeedPosition (const TrcKey &)
 
void setThresholdValue (float val)
 
void setUndo (bool yn)
 
virtual bool usePar (const IOPar &)
 
- Public Member Functions inherited from SequentialTask
 SequentialTask (const char *nm=nullptr)
 
virtual ~SequentialTask ()
 
virtual int doStep ()
 
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
 
virtual std::int64_t nrDone () const
 
virtual std::int64_t totalNr () 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
 
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
 

Protected Member Functions

 SectionAdjuster ()
 
- 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
 

Static Protected Member Functions

static const char * sKeyAdjuster ()
 
static const char * sKeyRemoveOnFailure ()
 
static const char * sKeyThreshold ()
 

Protected Attributes

BufferString errmsg_
 
bool removeonfailure_ = true
 
int seedid_ = 0
 
TrcKey seedtk_ = TrcKey::udf()
 
bool setundo_ = true
 
float thresholdval_ = 0.5f
 
TypeSet< TrcKeytks_
 
TypeSet< TrcKeytksrc_
 
- 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_
 

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 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 ReportingTask
Notifier< ReportingTaskprogressUpdated
 

Detailed Description

SequentialTask to adjust the section of an EM object with ID EM::SectionID.

<>

Constructor & Destructor Documentation

◆ ~SectionAdjuster()

virtual MPE::SectionAdjuster::~SectionAdjuster ( )
virtual

◆ SectionAdjuster()

MPE::SectionAdjuster::SectionAdjuster ( )
protected

Member Function Documentation

◆ errMsg()

const char* MPE::SectionAdjuster::errMsg ( ) const

◆ fillPar()

virtual void MPE::SectionAdjuster::fillPar ( IOPar ) const
virtual

Reimplemented in MPE::HorizonAdjuster.

◆ getAttribCube()

virtual TrcKeyZSampling MPE::SectionAdjuster::getAttribCube ( const Attrib::SelSpec ) const
virtual
Returns
the cube in which I need the given attrib to track in activevolum.

Reimplemented in MPE::HorizonAdjuster.

◆ getAttributeSel()

virtual const Attrib::SelSpec* MPE::SectionAdjuster::getAttributeSel ( int  idx) const
inlinevirtual

Reimplemented in MPE::HorizonAdjuster.

◆ getNeededAttribs()

virtual void MPE::SectionAdjuster::getNeededAttribs ( TypeSet< Attrib::SelSpec > &  ) const
virtual

Reimplemented in MPE::HorizonAdjuster.

◆ getNrAttributes()

virtual int MPE::SectionAdjuster::getNrAttributes ( ) const
inlinevirtual

Reimplemented in MPE::HorizonAdjuster.

◆ getThresholdValue()

float MPE::SectionAdjuster::getThresholdValue ( ) const

◆ hasInitializedSetup()

virtual bool MPE::SectionAdjuster::hasInitializedSetup ( ) const
inlinevirtual

Reimplemented in MPE::HorizonAdjuster.

◆ is2D()

virtual bool MPE::SectionAdjuster::is2D ( ) const
inlinevirtual

◆ nextStep()

int MPE::SectionAdjuster::nextStep ( )
overridevirtual
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.

◆ removeOnFailure()

bool MPE::SectionAdjuster::removeOnFailure ( bool  yn)

If true, tracked nodes that does not meet certain constraits, e.g. thresholds, are removed. If not, the initial value is kept.

Returns
the previous status.

◆ removesOnFailure()

bool MPE::SectionAdjuster::removesOnFailure ( ) const

◆ reset()

virtual void MPE::SectionAdjuster::reset ( )
inlinevirtual

Reimplemented in MPE::HorizonAdjuster.

◆ sectionID()

mDeprecatedObs EM::SectionID MPE::SectionAdjuster::sectionID ( ) const

◆ setAttributeSel()

virtual void MPE::SectionAdjuster::setAttributeSel ( int  idx,
const Attrib::SelSpec  
)
inlinevirtual

Reimplemented in MPE::HorizonAdjuster.

◆ setPositions()

void MPE::SectionAdjuster::setPositions ( const TypeSet< TrcKey > &  targets,
const TypeSet< TrcKey > *  src = 0 
)

◆ setSeedId()

void MPE::SectionAdjuster::setSeedId ( int  )

◆ setSeedPosition()

void MPE::SectionAdjuster::setSeedPosition ( const TrcKey )

◆ setThresholdValue()

void MPE::SectionAdjuster::setThresholdValue ( float  val)

◆ setUndo()

void MPE::SectionAdjuster::setUndo ( bool  yn)
inline

◆ sKeyAdjuster()

static const char* MPE::SectionAdjuster::sKeyAdjuster ( )
staticprotected

◆ sKeyRemoveOnFailure()

static const char* MPE::SectionAdjuster::sKeyRemoveOnFailure ( )
staticprotected

◆ sKeyThreshold()

static const char* MPE::SectionAdjuster::sKeyThreshold ( )
staticprotected

◆ usePar()

virtual bool MPE::SectionAdjuster::usePar ( const IOPar )
virtual

Reimplemented in MPE::HorizonAdjuster.

Member Data Documentation

◆ errmsg_

BufferString MPE::SectionAdjuster::errmsg_
protected

◆ removeonfailure_

bool MPE::SectionAdjuster::removeonfailure_ = true
protected

◆ seedid_

int MPE::SectionAdjuster::seedid_ = 0
protected

◆ seedtk_

TrcKey MPE::SectionAdjuster::seedtk_ = TrcKey::udf()
protected

◆ setundo_

bool MPE::SectionAdjuster::setundo_ = true
protected

◆ thresholdval_

float MPE::SectionAdjuster::thresholdval_ = 0.5f
protected

◆ tks_

TypeSet<TrcKey> MPE::SectionAdjuster::tks_
protected

◆ tksrc_

TypeSet<TrcKey> MPE::SectionAdjuster::tksrc_
protected

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