Convolver3D< T > Class Template Reference

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

Inheritance diagram for Convolver3D< T >:

Public Member Functions
	Convolver3D ()
void	setX (const Array3D< T > &, int first0=0, int first1=0, int first2=0)
void	setY (const Array3D< T > &, int first0=0, int first1=0, int first2=0)
void	setZ (Array3D< T > &z)
void	setNormalize (bool n)
void	setCorrelate (bool yn)
void	setHasUdfs (bool yn)
	Default is false. More...
virtual bool	executeParallel (bool)
uiString	message () const
uiString	nrDoneText () const
Public Member Functions inherited from ParallelTask
virtual	~ParallelTask ()
bool	execute ()
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
int64_t	nrDone () const
	May be -1, i.e. class does not report nrdone. More...
int64_t	totalNr () const
Public Member Functions inherited from Task
virtual	~Task ()
virtual uiRetVal	errorWithDetails () const
virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...
bool	workControlEnabled () const
virtual void	controlWork (Control)
virtual Control	getState () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
bool	operator== (const NamedCallBacker &oth) const
bool	operator== (const NamedObject &oth) const
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () 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	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
virtual bool	isCapsule () const
void	stopReceivingNotifications () const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual BufferString	getName () const
virtual void	setName (const char *nm)
bool	getNameFromPar (const IOPar &)
void	putNameInPar (IOPar &) const

Protected Member Functions
bool	shouldFFT () const
bool	doFFT ()
bool	doWork (od_int64, od_int64, int)
od_int64	nrIterations () const
Protected Member Functions inherited from ParallelTask
virtual int	maxNrThreads () const
virtual int	minThreadSize () const
virtual bool	stopAllOnFailure () const
	ParallelTask (const char *nm=0)
	ParallelTask (const ParallelTask &)
int64_t	calculateThreadSize (int64_t totalnr, int nrthreads, int thread) const
void	addToNrDone (int64_t increment)
void	quickAddToNrDone (int64_t loopidx)
void	resetNrDone ()
Protected Member Functions inherited from Task
	Task (const char *nm=0)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...

Protected Attributes
const Array3D< T > *	x_
int	xshift0_
int	xshift1_
int	xshift2_
const Array3D< T > *	y_
int	yshift0_
int	yshift1_
int	yshift2_
Array3D< T > *	z_
bool	normalize_
bool	correlate_
bool	hasudfs_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedCallBacker
Notifier< NamedCallBacker >	delnotif_
Threads::Atomic< bool >	delalreadytriggered_
Protected Attributes inherited from NamedObject
BufferString	name_

Private Member Functions
	mODTextTranslationClass (Convolver3D)

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }
Static Public Member Functions inherited from ParallelTask
static uiString	sPosFinished ()
static uiString	sTrcFinished ()
Static Public Member Functions inherited from Task
static uiString	stdMessage ()
static uiString	stdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Detailed Description

template<class T>
class Convolver3D< T >

Convolves (or correlates) two 3D signals.

Constructor & Destructor Documentation

template<class T >

Convolver3D< T >::Convolver3D ( )

inline

Member Function Documentation

template<class T >

bool Convolver3D< T >::doFFT ( )

inlineprotected

template<class T >

bool Convolver3D< T >::doWork ( od_int64  start, od_int64  stop, int    )

inlineprotected

template<class T >

bool Convolver3D< T >::executeParallel ( bool  parallel )

inlinevirtual

Runs the process the desired number of times.

Note

that the function has static threads (normally the same number as there are processors on the machine), and these static threads will be shared by all instances of ParallelTask::execute.

Reimplemented from ParallelTask.

template<class T>

uiString Convolver3D< T >::message ( ) const

inlinevirtual

Reimplemented from Task.

template<class T>

Convolver3D< T >::mODTextTranslationClass ( Convolver3D< T >  )

private

template<class T>

uiString Convolver3D< T >::nrDoneText ( ) const

inlinevirtual

Reimplemented from Task.

template<class T>

od_int64 Convolver3D< T >::nrIterations ( ) const

inlineprotectedvirtual

Returns

the number of times the process should be run.

Implements ParallelTask.

template<class T>

void Convolver3D< T >::setCorrelate ( bool  yn )

inline

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

template<class T>

void Convolver3D< T >::setHasUdfs ( bool  yn )

inline

Default is false.

template<class T>

void Convolver3D< T >::setNormalize ( bool  n )

inline

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

template<class T>

void Convolver3D< T >::setX ( const Array3D< T > &  x, int  first0 = 0, int  first1 = 0, int  first2 = 0  )

inline

template<class T>

void Convolver3D< T >::setY ( const Array3D< T > &  y, int  first0 = 0, int  first1 = 0, int  first2 = 0  )

inline

template<class T>

void Convolver3D< T >::setZ ( Array3D< T > &  z )

inline

template<class T >

bool Convolver3D< T >::shouldFFT ( ) const

inlineprotected

Member Data Documentation

template<class T>

bool Convolver3D< T >::correlate_

protected

template<class T>

bool Convolver3D< T >::hasudfs_

protected

template<class T>

bool Convolver3D< T >::normalize_

protected

template<class T>

const Array3D<T>* Convolver3D< T >::x_

protected

template<class T>

int Convolver3D< T >::xshift0_

protected

template<class T>

int Convolver3D< T >::xshift1_

protected

template<class T>

int Convolver3D< T >::xshift2_

protected

template<class T>

const Array3D<T>* Convolver3D< T >::y_

protected

template<class T>

int Convolver3D< T >::yshift0_

protected

template<class T>

int Convolver3D< T >::yshift1_

protected

template<class T>

int Convolver3D< T >::yshift2_

protected

template<class T>

Array3D<T>* Convolver3D< T >::z_

protected