Lets any 1D orthogonal transform (GenericTransformND::GenericTransform1D) be extended to ND. Most transform fftw can be implemented as a subclass of GenericTransformND. More...

#include <transform.h>

Inheritance diagram for GenericTransformND:

[legend]

Classes
class	Transform1D

Public Member Functions
	GenericTransformND ()

virtual	~GenericTransformND ()

bool	getDir () const

const ArrayNDInfo &	getInputInfo () const

bool	run (bool parallel)

bool	setDir (bool forward)

void	setInput (const float *)

void	setInput (const float_complex *)

bool	setInputInfo (const ArrayNDInfo &)

void	setOutput (float *)

void	setOutput (float_complex *)

void	setSampling (int)

void	setScope (int nr, const int *batchstarts)

void	setScope (int nr, int batchsampling)

Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=nullptr)

virtual	~SequentialTask ()

virtual int	doStep ()

bool	execute () override

Public Member Functions inherited from ReportingTask
	ReportingTask (const ReportingTask &)=delete

virtual	~ReportingTask ()

void	getProgress (const ReportingTask &)

ReportingTask &	operator= (const ReportingTask &)=delete

void	setSimpleMeter (bool yn, int repperc)

int	simpleMeterStep () const

bool	useSimpleMeter () const

Public Member Functions inherited from Task
	Task (const Task &)=delete

virtual	~Task ()

virtual void	controlWork (Control)

virtual void	enableWorkControl (bool=true)
	Must be called before execute()

virtual uiRetVal	errorWithDetails () const

virtual Control	getState () const

virtual od_int64	nrDone () const

Task &	operator= (const Task &)=delete

virtual od_int64	totalNr () const

virtual uiString	uiMessage () const

virtual uiString	uiNrDoneText () const

bool	workControlEnabled () const

Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=nullptr)

	NamedCallBacker (const NamedCallBacker &)=delete

	~NamedCallBacker ()

virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const

NamedCallBacker &	operator= (const NamedCallBacker &)=delete

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.

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.

CallBacker &	operator= (const CallBacker &)=delete

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
virtual Transform1D *	createTransform () const =0

int	nextStep () override

virtual bool	setup ()

Protected Member Functions inherited from SequentialTask
virtual bool	doFinish (bool success, od_ostream *=nullptr)

virtual bool	doPrepare (od_ostream *=nullptr)

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

void	updateProgressMeter (bool forced=false, od_int64 *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
int	batchsampling_

const int *	batchstarts_

const float_complex *	cinput_

float_complex *	coutput_

int	curdim_

bool	forward_

ArrayNDInfo *	info_

TypeSet< int >	nr1dtransforms_

int	nr_

bool	parallel_

const float *	rinput_

float *	routput_

int	sampling_

ObjectSet< int >	transforms1dstarts_

ObjectSet< Transform1D >	transforms_

Protected Attributes inherited from Task
Control	control_ = Task::Run

Threads::ConditionVar *	workcontrolcondvar_ = nullptr

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 SequentialTask
static int	ErrorOccurred ()

static int	Finished ()

static int	MoreToDo ()

static int	WarningAvailable ()

Static Public Member Functions inherited from ReportingTask
static PtrMan< ProgressMeter >	getTextProgressMeter (od_ostream &, const IOPar *iop=nullptr)

static bool	needSimpleLogging (const IOPar &)

static const char *	sKeySimpleLogging ()

static const char *	sKeySimpleLoggingStep ()

Static Public Member Functions inherited from Task
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

Lets any 1D orthogonal transform (GenericTransformND::GenericTransform1D) be extended to ND. Most transform fftw can be implemented as a subclass of GenericTransformND.

<>

Constructor & Destructor Documentation

◆ GenericTransformND()

GenericTransformND::GenericTransformND ( )

◆ ~GenericTransformND()

virtual GenericTransformND::~GenericTransformND ( )

virtual

Member Function Documentation

◆ createTransform()

virtual Transform1D * GenericTransformND::createTransform ( ) const

protectedpure virtual

Implemented in Fourier::CC, and DWT.

◆ getDir()

bool GenericTransformND::getDir ( ) const

inline

◆ getInputInfo()

const ArrayNDInfo & GenericTransformND::getInputInfo ( ) const

◆ nextStep()

int GenericTransformND::nextStep ( )

overrideprotectedvirtual

Return values

MoreToDo()	Not finished. Call me again.
Finished()	Nothing more to do.
ErrorOccurred()	Something went wrong.

Note: if function returns a value greater than cMoreToDo(), it should be interpreted as cMoreToDo().

Implements SequentialTask.

◆ run()

bool GenericTransformND::run ( bool parallel )

◆ setDir()

bool GenericTransformND::setDir ( bool forward )

◆ setInput() [1/2]

void GenericTransformND::setInput ( const float * )

◆ setInput() [2/2]

void GenericTransformND::setInput ( const float_complex * )

◆ setInputInfo()

bool GenericTransformND::setInputInfo ( const ArrayNDInfo & )

◆ setOutput() [1/2]

void GenericTransformND::setOutput ( float * )

◆ setOutput() [2/2]

void GenericTransformND::setOutput ( float_complex * )

◆ setSampling()

void GenericTransformND::setSampling ( int )

◆ setScope() [1/2]

void GenericTransformND::setScope	(	int	nr,
		const int *	batchstarts )

Parameters

nr	number of signals
batchstarts	pointer to array with the indices of the signal starts.

◆ setScope() [2/2]

void GenericTransformND::setScope	(	int	nr,
		int	batchsampling )

Parameters

nr	number of signals
batchsampling	number of samples between signal starts.

◆ setup()

virtual bool GenericTransformND::setup ( )

protectedvirtual

Reimplemented in Fourier::CC, and DWT.

Member Data Documentation

◆ batchsampling_

int GenericTransformND::batchsampling_

protected

◆ batchstarts_

const int* GenericTransformND::batchstarts_

protected

◆ cinput_

const float_complex* GenericTransformND::cinput_

protected

◆ coutput_

float_complex* GenericTransformND::coutput_

protected

◆ curdim_

int GenericTransformND::curdim_

protected

◆ forward_

bool GenericTransformND::forward_

protected

◆ info_

ArrayNDInfo* GenericTransformND::info_

protected

◆ nr1dtransforms_

TypeSet<int> GenericTransformND::nr1dtransforms_

protected

◆ nr_

int GenericTransformND::nr_

protected

◆ parallel_

bool GenericTransformND::parallel_

protected

◆ rinput_

const float* GenericTransformND::rinput_

protected

◆ routput_

float* GenericTransformND::routput_

protected

◆ sampling_

int GenericTransformND::sampling_

protected

◆ transforms1dstarts_

ObjectSet<int> GenericTransformND::transforms1dstarts_

protected

◆ transforms_

ObjectSet<Transform1D> GenericTransformND::transforms_

protected

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GenericTransformND()

◆ ~GenericTransformND()

Member Function Documentation

◆ createTransform()

◆ getDir()

◆ getInputInfo()

◆ nextStep()

◆ run()

◆ setDir()

◆ setInput() [1/2]

◆ setInput() [2/2]

◆ setInputInfo()

◆ setOutput() [1/2]

◆ setOutput() [2/2]

◆ setSampling()

◆ setScope() [1/2]

◆ setScope() [2/2]

◆ setup()

Member Data Documentation

◆ batchsampling_

◆ batchstarts_

◆ cinput_

◆ coutput_

◆ curdim_

◆ forward_

◆ info_

◆ nr1dtransforms_

◆ nr_

◆ parallel_

◆ rinput_

◆ routput_

◆ sampling_

◆ transforms1dstarts_

◆ transforms_