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

Inheritance diagram for Convolver3D< T >:

Public Member Functions
	Convolver3D ()

bool	executeParallel (bool) override

void	setCorrelate (bool yn)

void	setHasUdfs (bool yn)
	Default is false. More...

void	setNormalize (bool n)

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)

uiString	uiMessage () const override
	will be message() again in 7.x More...

uiString	uiNrDoneText () const override
	will be nrDoneText() in 7.x More...

Public Member Functions inherited from ParallelTask
virtual	~ParallelTask ()

void	doParallel (bool yn)

bool	execute () override

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 CallBacker *	trueCaller ()

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_type &	name () const override

NamedObject &	operator= (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	doFFT ()

bool	doWork (od_int64, od_int64, int) override

od_int64	nrIterations () const override

bool	shouldFFT () const

bool	shouldFFT () const

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

ProgressMeter *	progressMeter () 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
bool	correlate_

bool	hasudfs_

bool	normalize_

const Array3D< T > *	x_

int	xshift0_

int	xshift1_

int	xshift2_

const Array3D< T > *	y_

int	yshift0_

int	yshift1_

int	yshift2_

Array3D< T > *	z_

Protected Attributes inherited from Task
Control	control_

Threads::ConditionVar *	workcontrolcondvar_

Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_

Notifier< NamedCallBacker >	delnotif_

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

Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

Detailed Description

template<class T>
class Convolver3D< T >

Convolves (or correlates) two 3D signals.

<>

Constructor & Destructor Documentation

◆ Convolver3D()

template<class T >

Convolver3D< T >::Convolver3D

inline

Member Function Documentation

◆ doFFT()

template<class T >

bool Convolver3D< T >::doFFT

inlineprotected

◆ doWork()

template<class T >

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

inlineoverrideprotected

◆ executeParallel()

template<class T >

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

inlineoverridevirtual

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.

◆ nrIterations()

template<class T >

od_int64 Convolver3D< T >::nrIterations ( ) const

inlineoverrideprotectedvirtual

Returns: the number of times the process should be run.

Implements ParallelTask.

◆ setCorrelate()

template<class T >

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

inline

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

◆ setHasUdfs()

template<class T >

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

inline

Default is false.

◆ setNormalize()

template<class T >

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

inline

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

◆ setX()

template<class T >

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

inline

◆ setY()

template<class T >

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

inline

◆ setZ()

template<class T >

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

inline

◆ shouldFFT() [1/2]

template<class T >

bool Convolver3D< T >::shouldFFT

inlineprotected

◆ shouldFFT() [2/2]

bool Convolver3D< float >::shouldFFT ( ) const

inlineprotected

◆ uiMessage()

template<class T >

uiString Convolver3D< T >::uiMessage ( ) const

inlineoverridevirtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

template<class T >

uiString Convolver3D< T >::uiNrDoneText ( ) const

inlineoverridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

◆ correlate_

template<class T >

bool Convolver3D< T >::correlate_

protected

◆ hasudfs_

template<class T >

bool Convolver3D< T >::hasudfs_

protected

◆ normalize_

template<class T >

bool Convolver3D< T >::normalize_

protected

◆ x_

template<class T >

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

protected

◆ xshift0_

template<class T >

int Convolver3D< T >::xshift0_

protected

◆ xshift1_

template<class T >

int Convolver3D< T >::xshift1_

protected

◆ xshift2_

template<class T >

int Convolver3D< T >::xshift2_

protected

◆ y_

template<class T >

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

protected

◆ yshift0_

template<class T >

int Convolver3D< T >::yshift0_

protected

◆ yshift1_

template<class T >

int Convolver3D< T >::yshift1_

protected

◆ yshift2_

template<class T >

int Convolver3D< T >::yshift2_

protected

◆ z_

template<class T >

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

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class T> class Convolver3D< T >

Constructor & Destructor Documentation

◆ Convolver3D()

Member Function Documentation

◆ doFFT()

◆ doWork()

◆ executeParallel()

◆ nrIterations()

◆ setCorrelate()

◆ setHasUdfs()

◆ setNormalize()

◆ setX()

◆ setY()

◆ setZ()

◆ shouldFFT() [1/2]

◆ shouldFFT() [2/2]

◆ uiMessage()

◆ uiNrDoneText()

Member Data Documentation

◆ correlate_

◆ hasudfs_

◆ normalize_

◆ x_

◆ xshift0_

◆ xshift1_

◆ xshift2_

◆ y_

◆ yshift0_

◆ yshift1_

◆ yshift2_

◆ z_

template<class T>
class Convolver3D< T >