OpendTect  6.6
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Array3DFloodfill< T > Class Template Reference

Given an input array and a threshold, we use flood fill to find all the locations with values less (or greater) than the threshold based on seeds. User has the option to set inside or outside value on the output. More...

Inheritance diagram for Array3DFloodfill< T >:
[legend]

Classes

struct  Compartment
 

Public Member Functions

 Array3DFloodfill (const Array3D< T > &input, T threshold, bool aboveisovalue, Array3D< T > &output)
 
 ~Array3DFloodfill ()
 
void addSeed (int, int, int)
 
bool isAboveIsovalue () const
 
int maxNrThreads () const
 
od_int64 nrIterations () const
 
void setInsideValue (T val)
 
void setOutsideValue (T val)
 
void use6Neighbors (bool yn)
 
void useInputValue (bool yn)
 
- Public Member Functions inherited from ParallelTask
virtual ~ParallelTask ()
 
bool execute ()
 
virtual bool executeParallel (bool parallel)
 
int64_t nrDone () const
 May be -1, i.e. class does not report nrdone. More...
 
void setProgressMeter (ProgressMeter *)
 Must be called before execute() More...
 
int64_t totalNr () const
 
- 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 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
 
- 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 &)
 
virtual const name_typename () const
 
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

bool doWork (od_int64 start, od_int64 stop, int)
 
int getNextWorkCompartment ()
 
int getWorkCompartment (int, int, int) const
 
void returnCompartment (int)
 
void setOutput (int, int, int, bool addseed)
 
- Protected Member Functions inherited from ParallelTask
 ParallelTask (const char *nm=0)
 
 ParallelTask (const ParallelTask &)
 
void addToNrDone (int64_t increment)
 
int64_t calculateThreadSize (int64_t totalnr, int nrthreads, int thread) const
 
virtual int minThreadSize () const
 
void quickAddToNrDone (int64_t loopidx)
 
void resetNrDone ()
 
virtual bool stopAllOnFailure () const
 
- 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

bool aboveisovalue_
 
Threads::ConditionVar compartmentlock_
 
ObjectSet< Compartmentcompartments_
 
int compsz0_
 
int compsz1_
 
int compsz2_
 
const Array3D< T > & input_
 Not protected. More...
 
insideval_
 
Array3DImpl< bool > * isdefined_
 
int nrcomp0_
 
int nrcomp1_
 
int nrcomp2_
 
Array3D< T > & output_
 
outsideval_
 
TypeSet< int > permutation_
 
int sz0_
 
int sz1_
 
int sz2_
 
threshold_
 
int use6neighbors_
 
bool useinputval_
 
- 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 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 ()
 

Detailed Description

template<class T>
class Array3DFloodfill< T >

Given an input array and a threshold, we use flood fill to find all the locations with values less (or greater) than the threshold based on seeds. User has the option to set inside or outside value on the output.

Example: Given known array, threshold, T=float

         Array3DImpl<float> output( array.info() );
         Array3DFloodfill<float> floodfill( arr, threshold, max, output );
         floodfill.setOutsideValue( 1e+5 );

         floodfill.addSeed(0,0,0);

At least one seed's value should be bigger than the threshold if max (or smaller if !max)

         floodfill.execute();

<>

Constructor & Destructor Documentation

◆ Array3DFloodfill()

template<class T >
Array3DFloodfill< T >::Array3DFloodfill ( const Array3D< T > &  input,
threshold,
bool  aboveisovalue,
Array3D< T > &  output 
)
inline

◆ ~Array3DFloodfill()

template<class T >
Array3DFloodfill< T >::~Array3DFloodfill
inline

Member Function Documentation

◆ addSeed()

template<class T >
void Array3DFloodfill< T >::addSeed ( int  x0,
int  x1,
int  x2 
)
inline

◆ doWork()

template<class T >
bool Array3DFloodfill< T >::doWork ( od_int64  start,
od_int64  stop,
int   
)
inlineprotected

◆ getNextWorkCompartment()

template<class T >
int Array3DFloodfill< T >::getNextWorkCompartment
inlineprotected

◆ getWorkCompartment()

template<class T >
int Array3DFloodfill< T >::getWorkCompartment ( int  x0,
int  x1,
int  x2 
) const
inlineprotected

◆ isAboveIsovalue()

template<class T >
bool Array3DFloodfill< T >::isAboveIsovalue ( ) const
inline

◆ maxNrThreads()

template<class T >
int Array3DFloodfill< T >::maxNrThreads ( ) const
inlinevirtual

Reimplemented from ParallelTask.

◆ nrIterations()

template<class T >
od_int64 Array3DFloodfill< T >::nrIterations ( ) const
inlinevirtual
Returns
the number of times the process should be run.

Implements ParallelTask.

◆ returnCompartment()

template<class T >
void Array3DFloodfill< T >::returnCompartment ( int  comp)
inlineprotected

◆ setInsideValue()

template<class T >
void Array3DFloodfill< T >::setInsideValue ( val)
inline

If udf, input value will be used.

◆ setOutput()

template<class T >
void Array3DFloodfill< T >::setOutput ( int  x0,
int  x1,
int  x2,
bool  addseed 
)
inlineprotected

◆ setOutsideValue()

template<class T >
void Array3DFloodfill< T >::setOutsideValue ( val)
inline

If udf, uDf(T) will be set. Must be set if use Marchingcubes.

◆ use6Neighbors()

template<class T >
void Array3DFloodfill< T >::use6Neighbors ( bool  yn)
inline

◆ useInputValue()

template<class T >
void Array3DFloodfill< T >::useInputValue ( bool  yn)
inline

Member Data Documentation

◆ aboveisovalue_

template<class T >
bool Array3DFloodfill< T >::aboveisovalue_
protected

◆ compartmentlock_

template<class T >
Threads::ConditionVar Array3DFloodfill< T >::compartmentlock_
protected

Protects the isused_ flags on the compartments.

◆ compartments_

template<class T >
ObjectSet<Compartment> Array3DFloodfill< T >::compartments_
protected

◆ compsz0_

template<class T >
int Array3DFloodfill< T >::compsz0_
protected

◆ compsz1_

template<class T >
int Array3DFloodfill< T >::compsz1_
protected

◆ compsz2_

template<class T >
int Array3DFloodfill< T >::compsz2_
protected

◆ input_

template<class T >
const Array3D<T>& Array3DFloodfill< T >::input_
protected

Not protected.

◆ insideval_

template<class T >
T Array3DFloodfill< T >::insideval_
protected

◆ isdefined_

template<class T >
Array3DImpl<bool>* Array3DFloodfill< T >::isdefined_
protected

The locks_ on the compartment protects 'its' part of the array.

◆ nrcomp0_

template<class T >
int Array3DFloodfill< T >::nrcomp0_
protected

◆ nrcomp1_

template<class T >
int Array3DFloodfill< T >::nrcomp1_
protected

◆ nrcomp2_

template<class T >
int Array3DFloodfill< T >::nrcomp2_
protected

◆ output_

template<class T >
Array3D<T>& Array3DFloodfill< T >::output_
protected

The locks_ on the compartment protects 'its' part of the array.

◆ outsideval_

template<class T >
T Array3DFloodfill< T >::outsideval_
protected

◆ permutation_

template<class T >
TypeSet<int> Array3DFloodfill< T >::permutation_
protected

◆ sz0_

template<class T >
int Array3DFloodfill< T >::sz0_
protected

◆ sz1_

template<class T >
int Array3DFloodfill< T >::sz1_
protected

◆ sz2_

template<class T >
int Array3DFloodfill< T >::sz2_
protected

◆ threshold_

template<class T >
T Array3DFloodfill< T >::threshold_
protected

◆ use6neighbors_

template<class T >
int Array3DFloodfill< T >::use6neighbors_
protected

◆ useinputval_

template<class T >
bool Array3DFloodfill< T >::useinputval_
protected

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