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

Convolves (or correlates) two 2D signals. More...

Inheritance diagram for Convolver2D< T >:
[legend]

Public Member Functions

 Convolver2D ()
 
 ~Convolver2D ()
 
 ~Convolver2D ()
 
const Array2D< T > * getX () const
 
const Array2D< T > * getY () const
 
od_int64 nrIterations () const
 
od_int64 nrIterations () const
 
void setCorrelate (bool yn)
 
void setNormalize (bool n)
 
void setX (const Array2D< T > &, bool hasudfs)
 
void setY (const Array2D< T > &, bool hasudfs)
 
void setZ (Array2D< T > &z)
 
- 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 doNonFFTWork (od_int64, od_int64, int)
 
bool doPrepare (int)
 
bool doWork (od_int64 start, od_int64 stop, int)
 
bool doWork (od_int64, od_int64, int)
 
bool shouldFFT () const
 
bool shouldFFT () const
 
- 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 maxNrThreads () 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 correlate_
 
Fourier::CCfft_
 
bool normalize_
 
bool updatexf_
 
bool updateyf_
 
const Array2D< T > * x_
 
float_complex * xf_
 
bool xhasudfs_
 
const Array2D< T > * y_
 
float_complex * yf_
 
bool yhasudfs_
 
Array2D< T > * z_
 
float_complex * zf_
 
- 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 Convolver2D< T >

Convolves (or correlates) two 2D signals.

Constructor & Destructor Documentation

◆ Convolver2D()

template<class T >
Convolver2D< T >::Convolver2D
inline

◆ ~Convolver2D() [1/2]

template<class T >
Convolver2D< T >::~Convolver2D

◆ ~Convolver2D() [2/2]

Convolver2D< float >::~Convolver2D ( )

Member Function Documentation

◆ doNonFFTWork()

template<class T >
bool Convolver2D< T >::doNonFFTWork ( od_int64  start,
od_int64  stop,
int   
)
inlineprotected

◆ doPrepare()

template<class T >
bool Convolver2D< T >::doPrepare ( int  nrthreads)
protectedvirtual

Called once, before any doWork is called.

Reimplemented from ParallelTask.

◆ doWork() [1/2]

bool Convolver2D< float >::doWork ( od_int64  start,
od_int64  stop,
int   
)
protected

◆ doWork() [2/2]

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

◆ getX()

template<class T >
const Array2D<T>* Convolver2D< T >::getX ( ) const
inline

◆ getY()

template<class T >
const Array2D<T>* Convolver2D< T >::getY ( ) const
inline

◆ nrIterations() [1/2]

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

Implements ParallelTask.

◆ nrIterations() [2/2]

od_int64 Convolver2D< float >::nrIterations ( ) const
inlinevirtual
Returns
the number of times the process should be run.

Implements ParallelTask.

◆ setCorrelate()

template<class T >
void Convolver2D< T >::setCorrelate ( bool  yn)
inline

If true, the convolution will be replaced by a correllation.

◆ setNormalize()

template<class T >
void Convolver2D< T >::setNormalize ( bool  n)
inline

If true, the sum will be divided by the sum of Y.

◆ setX()

template<class T >
void Convolver2D< T >::setX ( const Array2D< T > &  x,
bool  hasudfs 
)
inline

◆ setY()

template<class T >
void Convolver2D< T >::setY ( const Array2D< T > &  y,
bool  hasudfs 
)
inline

◆ setZ()

template<class T >
void Convolver2D< T >::setZ ( Array2D< T > &  z)
inline

◆ shouldFFT() [1/2]

template<class T >
bool Convolver2D< T >::shouldFFT
inlineprotected

◆ shouldFFT() [2/2]

bool Convolver2D< float >::shouldFFT ( ) const
inlineprotected

Member Data Documentation

◆ correlate_

template<class T >
bool Convolver2D< T >::correlate_
protected

◆ fft_

template<class T >
Fourier::CC* Convolver2D< T >::fft_
protected

◆ normalize_

template<class T >
bool Convolver2D< T >::normalize_
protected

◆ updatexf_

template<class T >
bool Convolver2D< T >::updatexf_
protected

◆ updateyf_

template<class T >
bool Convolver2D< T >::updateyf_
protected

◆ x_

template<class T >
const Array2D<T>* Convolver2D< T >::x_
protected

◆ xf_

template<class T >
float_complex* Convolver2D< T >::xf_
protected

◆ xhasudfs_

template<class T >
bool Convolver2D< T >::xhasudfs_
protected

◆ y_

template<class T >
const Array2D<T>* Convolver2D< T >::y_
protected

◆ yf_

template<class T >
float_complex* Convolver2D< T >::yf_
protected

◆ yhasudfs_

template<class T >
bool Convolver2D< T >::yhasudfs_
protected

◆ z_

template<class T >
Array2D<T>* Convolver2D< T >::z_
protected

◆ zf_

template<class T >
float_complex* Convolver2D< T >::zf_
protected

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