OpendTect  7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InverseDistanceArray2DInterpol Class Reference

Interpolates 2D arrays using inverse distance method. More...

Inheritance diagram for InverseDistanceArray2DInterpol:
[legend]

Public Member Functions

 InverseDistanceArray2DInterpol ()
 
 ~InverseDistanceArray2DInterpol ()
 
bool canUseArrayAccess () const override
 
bool fillPar (IOPar &) const override
 
bool getCornersFirst () const
 
int getNrSteps () const
 
float getSearchRadius () const
 
int getStepSize () const
 
bool nothingToFill () const override
 
bool setArray (Array2D< float > &, TaskRunner *) override
 Set AFTER all settings. More...
 
bool setArray (ArrayAccess &, TaskRunner *) override
 Set AFTER all settings. More...
 
void setCornersFirst (bool n)
 
void setNrSteps (int n)
 
void setSearchRadius (float r)
 
void setStepSize (int n)
 
bool usePar (const IOPar &) override
 
- Public Member Functions inherited from Array2DInterpol
virtual ~Array2DInterpol ()
 
void doPolygonCrop ()
 
FillType getFillType () const
 
float getMaxHoleSize () const
 
virtual uiString infoMsg () const
 
bool isClassification () const
 
void setClassification (bool)
 
void setColStep (float r)
 
void setFillType (FillType)
 
void setMask (const Array2D< bool > *, OD::PtrPolicy=OD::UsePtr)
 
void setMaxHoleSize (float)
 
void setOrigin (const RowCol &)
 
void setRowStep (float r)
 
void setSampling (const TrcKeySampling &)
 Set both steps and the origin. More...
 
void setTrendOrder (PolyTrend::Order ord)
 
bool trimArray (int step, Array2D< char > &edgesmask)
 
uiString uiMessage () const override
 will be message() again 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 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
 
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 const char * sKeyCornersFirst ()
 
static const char * sKeyNrSteps ()
 
static const char * sKeySearchRadius ()
 
static const char * sKeyStepSize ()
 
- Static Public Member Functions inherited from Array2DInterpol
static const char * sKeyColStep ()
 
static const char * sKeyCropPolygon ()
 
static const char * sKeyFillType ()
 
static const char * sKeyMaxHoleSz ()
 
static const char * sKeyNrCells ()
 
static const char * sKeyNrCols ()
 
static const char * sKeyNrRows ()
 
static const char * sKeyOrigin ()
 
static const char * sKeyPolyNode ()
 
static const char * sKeyPolyNrofNodes ()
 
static const char * sKeyRowStep ()
 
- 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

bool doPrepare (int) override
 
bool doWork (od_int64, od_int64, int) override
 
od_int64 getNextIdx ()
 
virtual bool initFromArray (TaskRunner *)
 
od_int64 nrIterations () const override
 
void reportDone (od_int64)
 
uiString uiNrDoneText () const override
 will be nrDoneText() in 7.x More...
 
- Protected Member Functions inherited from Array2DInterpol
 Array2DInterpol ()
 
void excludeBigHoles (const bool *isdef, bool *shouldinterpol) const
 
void floodFillArrFrom (int seed, const bool *isdef, bool *shouldinterpol) const
 
void getNodesToFill (const bool *isdef, bool *shouldinterpol, TaskRunner *) const
 
bool isDefined (int idx) const
 
virtual void setFrom (od_int64 target, const od_int64 *sources, const float *weights, int nrsrc)
 
- 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

TypeSet< od_int64 > addedwithcursuport_
 
Threads::ConditionVarcondvar_
 
bool cornersfirst_
 
bool * curdefined_
 
TypeSet< od_int64 > definedidxs_
 
TypeSet< RowColneighbors_
 
TypeSet< float > neighborweights_
 
bool * nodestofill_
 
int nraddedthisstep_
 
int nrinitialdefined_
 
TypeSet< od_int64 > nrsources_
 
int nrsteps_
 
int nrthreads_
 
int nrthreadswaiting_
 
od_int64 prevsupportsize_
 
float searchradius_
 
bool shouldend_
 
int stepidx_
 
int stepsize_
 
TypeSet< od_int64 > todothisstep_
 
int totalnr_
 
bool waitforall_
 
- Protected Attributes inherited from Array2DInterpol
Array2D< float > * arr_
 
ArrayAccessarrsetter_
 
float colstep_
 
bool croppoly_
 
FillType filltype_
 
bool isclassification_
 
const Array2D< bool > * mask_
 
bool maskismine_
 
float maxholesize_
 
int nrcells_
 
int nrcols_
 
int nrrows_
 
RowCol origin_
 
ODPolygon< double > * poly_
 
float rowstep_
 
Stats::CalcSetupstatsetup_
 
PolyTrendtrend_
 
- 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 Array2DInterpol
enum  FillType { HolesOnly , ConvexHull , Full , Polygon }
 
- 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
 

Detailed Description

Interpolates 2D arrays using inverse distance method.

Parameters:

  1. searchradius - sets the search radius. Should have the same unit as given in setRowStep and getColStep. If undefined, all defined nodes will be used, and no other settings will be used.
  2. stepsize/nrsteps - sets how many nodes that will be done in each step. Each step will only use points defined in previous steps (not really true as shortcuts are made). In general, larger steps gives faster interpolation, but lower quality. If stepsize is 10, and nrsteps is 10, a border of maximum 100 nodes will be interpolated around the defined positions.
  3. cornersfirst - if true, algorithm will only interpolate nodes that has the same number of support (i.e. neigbors) within +-stepsize, before reevaluating which nodes to do next. Enabling cornersfirst will give high quality output at the expense of speed.

    <>

Constructor & Destructor Documentation

◆ InverseDistanceArray2DInterpol()

InverseDistanceArray2DInterpol::InverseDistanceArray2DInterpol ( )

◆ ~InverseDistanceArray2DInterpol()

InverseDistanceArray2DInterpol::~InverseDistanceArray2DInterpol ( )

Member Function Documentation

◆ canUseArrayAccess()

bool InverseDistanceArray2DInterpol::canUseArrayAccess ( ) const
inlineoverridevirtual

Reimplemented from Array2DInterpol.

◆ doPrepare()

bool InverseDistanceArray2DInterpol::doPrepare ( int  nrthreads)
overrideprotectedvirtual

Called once, before any doWork is called.

Reimplemented from Array2DInterpol.

◆ doWork()

bool InverseDistanceArray2DInterpol::doWork ( od_int64  ,
od_int64  ,
int   
)
overrideprotected

◆ fillPar()

bool InverseDistanceArray2DInterpol::fillPar ( IOPar ) const
overridevirtual

Reimplemented from Array2DInterpol.

Reimplemented in InvDistHor3DGridder.

◆ getCornersFirst()

bool InverseDistanceArray2DInterpol::getCornersFirst ( ) const
inline

◆ getNextIdx()

od_int64 InverseDistanceArray2DInterpol::getNextIdx ( )
protected

◆ getNrSteps()

int InverseDistanceArray2DInterpol::getNrSteps ( ) const
inline

◆ getSearchRadius()

float InverseDistanceArray2DInterpol::getSearchRadius ( ) const
inline

◆ getStepSize()

int InverseDistanceArray2DInterpol::getStepSize ( ) const
inline

◆ initFromArray()

virtual bool InverseDistanceArray2DInterpol::initFromArray ( TaskRunner )
protectedvirtual

Reimplemented in InvDistHor3DGridder.

◆ nothingToFill()

bool InverseDistanceArray2DInterpol::nothingToFill ( ) const
inlineoverridevirtual

Reimplemented from Array2DInterpol.

◆ nrIterations()

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

Implements ParallelTask.

◆ reportDone()

void InverseDistanceArray2DInterpol::reportDone ( od_int64  )
protected

◆ setArray() [1/2]

bool InverseDistanceArray2DInterpol::setArray ( Array2D< float > &  ,
TaskRunner  
)
overridevirtual

Set AFTER all settings.

Reimplemented from Array2DInterpol.

◆ setArray() [2/2]

bool InverseDistanceArray2DInterpol::setArray ( ArrayAccess ,
TaskRunner  
)
overridevirtual

Set AFTER all settings.

Trend is active only when setTrendOrder is called

Reimplemented from Array2DInterpol.

◆ setCornersFirst()

void InverseDistanceArray2DInterpol::setCornersFirst ( bool  n)
inline

◆ setNrSteps()

void InverseDistanceArray2DInterpol::setNrSteps ( int  n)
inline

◆ setSearchRadius()

void InverseDistanceArray2DInterpol::setSearchRadius ( float  r)
inline

◆ setStepSize()

void InverseDistanceArray2DInterpol::setStepSize ( int  n)
inline

◆ sKeyCornersFirst()

static const char* InverseDistanceArray2DInterpol::sKeyCornersFirst ( )
static

◆ sKeyNrSteps()

static const char* InverseDistanceArray2DInterpol::sKeyNrSteps ( )
static

◆ sKeySearchRadius()

static const char* InverseDistanceArray2DInterpol::sKeySearchRadius ( )
static

◆ sKeyStepSize()

static const char* InverseDistanceArray2DInterpol::sKeyStepSize ( )
static

◆ uiNrDoneText()

uiString InverseDistanceArray2DInterpol::uiNrDoneText ( ) const
inlineoverrideprotectedvirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

◆ usePar()

bool InverseDistanceArray2DInterpol::usePar ( const IOPar )
overridevirtual

Reimplemented from Array2DInterpol.

Reimplemented in InvDistHor3DGridder.

Member Data Documentation

◆ addedwithcursuport_

TypeSet<od_int64> InverseDistanceArray2DInterpol::addedwithcursuport_
protected

◆ condvar_

Threads::ConditionVar& InverseDistanceArray2DInterpol::condvar_
protected

◆ cornersfirst_

bool InverseDistanceArray2DInterpol::cornersfirst_
protected

◆ curdefined_

bool* InverseDistanceArray2DInterpol::curdefined_
protected

◆ definedidxs_

TypeSet<od_int64> InverseDistanceArray2DInterpol::definedidxs_
protected

◆ neighbors_

TypeSet<RowCol> InverseDistanceArray2DInterpol::neighbors_
protected

◆ neighborweights_

TypeSet<float> InverseDistanceArray2DInterpol::neighborweights_
protected

◆ nodestofill_

bool* InverseDistanceArray2DInterpol::nodestofill_
protected

◆ nraddedthisstep_

int InverseDistanceArray2DInterpol::nraddedthisstep_
protected

◆ nrinitialdefined_

int InverseDistanceArray2DInterpol::nrinitialdefined_
protected

◆ nrsources_

TypeSet<od_int64> InverseDistanceArray2DInterpol::nrsources_
protected

◆ nrsteps_

int InverseDistanceArray2DInterpol::nrsteps_
protected

◆ nrthreads_

int InverseDistanceArray2DInterpol::nrthreads_
protected

◆ nrthreadswaiting_

int InverseDistanceArray2DInterpol::nrthreadswaiting_
protected

◆ prevsupportsize_

od_int64 InverseDistanceArray2DInterpol::prevsupportsize_
protected

◆ searchradius_

float InverseDistanceArray2DInterpol::searchradius_
protected

◆ shouldend_

bool InverseDistanceArray2DInterpol::shouldend_
protected

◆ stepidx_

int InverseDistanceArray2DInterpol::stepidx_
protected

◆ stepsize_

int InverseDistanceArray2DInterpol::stepsize_
protected

◆ todothisstep_

TypeSet<od_int64> InverseDistanceArray2DInterpol::todothisstep_
protected

◆ totalnr_

int InverseDistanceArray2DInterpol::totalnr_
protected

◆ waitforall_

bool InverseDistanceArray2DInterpol::waitforall_
protected

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