GenericTransformND Class Reference

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

Inheritance diagram for GenericTransformND:

Classes
class	Transform1D

Public Member Functions
	GenericTransformND ()
bool	setInputInfo (const ArrayNDInfo &)
const ArrayNDInfo &	getInputInfo () const
void	setInput (const float *)
void	setInput (const float_complex *)
void	setOutput (float *)
void	setOutput (float_complex *)
void	setSampling (int)
void	setScope (int nr, int batchsampling)
void	setScope (int nr, const int *batchstarts)
bool	setDir (bool forward)
bool	getDir () const
bool	run (bool parallel)
	~GenericTransformND ()
Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=0)
virtual	~SequentialTask ()
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
ProgressMeter *	progressMeter ()
const ProgressMeter *	progressMeter () const
virtual int	doStep ()
bool	execute ()
Public Member Functions inherited from Task
virtual	~Task ()
virtual uiString	message () const
virtual uiString	nrDoneText () const
virtual int64_t	nrDone () const
virtual int64_t	totalNr () const
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
virtual bool	setup ()
int	nextStep ()
virtual Transform1D *	createTransform () const =0
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
ObjectSet< Transform1D >	transforms_
ObjectSet< int >	transforms1dstarts_
TypeSet< int >	nr1dtransforms_
bool	forward_
int	sampling_
int	batchsampling_
const int *	batchstarts_
int	nr_
ArrayNDInfo *	info_
int	curdim_
bool	parallel_
const float_complex *	cinput_
const float *	rinput_
float_complex *	coutput_
float *	routput_
Protected Attributes inherited from SequentialTask
ProgressMeter *	progressmeter_
int	lastupdate_
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_

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }
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 Task
static uiString	stdMessage ()
static uiString	stdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

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

(

)

Member Function Documentation

virtual Transform1D* GenericTransformND::createTransform ( ) const

protectedpure virtual

Implemented in DWT, and Fourier::CC.

bool GenericTransformND::getDir ( ) const

inline

const ArrayNDInfo& GenericTransformND::getInputInfo

(

)

const

int GenericTransformND::nextStep ( )

protectedvirtual

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.

bool GenericTransformND::run

(

bool

parallel

)

bool GenericTransformND::setDir

(

bool

forward

)

void GenericTransformND::setInput

(

const float *

)

void GenericTransformND::setInput

(

const float_complex *

)

bool GenericTransformND::setInputInfo

(

const ArrayNDInfo &

)

void GenericTransformND::setOutput

(

float *

)

void GenericTransformND::setOutput

(

float_complex *

)

void GenericTransformND::setSampling

(

int

)

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

Parameters

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

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

Parameters

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

virtual bool GenericTransformND::setup ( )

protectedvirtual

Reimplemented in DWT, and Fourier::CC.

Member Data Documentation

int GenericTransformND::batchsampling_

protected

const int* GenericTransformND::batchstarts_

protected

const float_complex* GenericTransformND::cinput_

protected

float_complex* GenericTransformND::coutput_

protected

int GenericTransformND::curdim_

protected

bool GenericTransformND::forward_

protected

ArrayNDInfo* GenericTransformND::info_

protected

TypeSet<int> GenericTransformND::nr1dtransforms_

protected

int GenericTransformND::nr_

protected

bool GenericTransformND::parallel_

protected

const float* GenericTransformND::rinput_

protected

float* GenericTransformND::routput_

protected

int GenericTransformND::sampling_

protected

ObjectSet<int> GenericTransformND::transforms1dstarts_

protected

ObjectSet<Transform1D> GenericTransformND::transforms_

protected