Advanced 1-dimentional orthogonal transform functions.

Author: Miroslav Morhac

The original code in C has been repackaged as a C++ class by R.Brun

The algorithms in this class have been published in the following references:

C.V. Hampton, B. Lian, Wm. C. McHarris: Fast-Fourier-transform spectral enhancement techniques for gamma-ray spectroscopy.NIM A353 (1994) 280-284.
Morhac M., Matousek V., New adaptive Cosine-Walsh transform and its application to nuclear data compression, IEEE Transactions on Signal Processing 48 (2000) 2693.
Morhac M., Matousek V., Data compression using new fast adaptive Cosine-Haar transforms, Digital Signal Processing 8 (1998) 63.
Morhac M., Matousek V.: Multidimensional nuclear data compression using fast adaptive Walsh-Haar transform. Acta Physica Slovaca 51 (2001) 307.

Definition at line 32 of file TSpectrumTransform.h.

Public Types
enum	{ kTransformHaar =0, kTransformWalsh =1, kTransformCos =2, kTransformSin =3, kTransformFourier =4, kTransformHartley =5, kTransformFourierWalsh =6, kTransformFourierHaar =7, kTransformWalshHaar =8, kTransformCosWalsh =9, kTransformCosHaar =10, kTransformSinWalsh =11, kTransformSinHaar =12, kTransformForward =0, kTransformInverse =1 }

Public Types inherited from TObject
enum	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }

enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }

Public Member Functions
	TSpectrumTransform ()

	TSpectrumTransform (Int_t size)
	the constructor creates TSpectrumTransform object. More...

virtual	~TSpectrumTransform ()
	destructor More...

void	Enhance (const Double_t source, Double_t destVector)
	ONE-DIMENSIONAL ENHANCE ZONAL FUNCTION This function transforms the source spectrum. More...

void	FilterZonal (const Double_t source, Double_t destVector)
	ONE-DIMENSIONAL FILTER ZONAL FUNCTION This function transforms the source spectrum. More...

void	SetDirection (Int_t direction)
	SETTER FUNCION. More...

void	SetEnhanceCoeff (Double_t enhanceCoeff)
	SETTER FUNCION. More...

void	SetFilterCoeff (Double_t filterCoeff)
	SETTER FUNCION. More...

void	SetRegion (Int_t xmin, Int_t xmax)
	SETTER FUNCION. More...

void	SetTransformType (Int_t transType, Int_t degree)
	SETTER FUNCION. More...

void	Transform (const Double_t source, Double_t destVector)
	ONE-DIMENSIONAL TRANSFORM FUNCTION This function transforms the source spectrum. More...

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TString &name, const TString &title)

	TNamed (const TNamed &named)

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator. More...

virtual	~TNamed ()

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings (""). More...

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects. More...

virtual void	Copy (TObject &named) const
	Copy this to obj. More...

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer. More...

virtual const char *	GetName () const
	Returns name of object. More...

virtual const char *	GetTitle () const
	Returns title of object. More...

virtual ULong_t	Hash () const
	Return hash value for this object. More...

virtual Bool_t	IsSortable () const

virtual void	SetName (const char *name)
	Change (i.e. More...

virtual void	SetNameTitle (const char name, const char title)
	Change (i.e. set) all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Change (i.e. set) the title of the TNamed. More...

virtual void	ls (Option_t *option="") const
	List TNamed name and title. More...

virtual void	Print (Option_t *option="") const
	Print TNamed name and title. More...

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject. More...

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)
	TObject copy ctor. More...

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...

virtual	~TObject ()
	TObject destructor. More...

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. More...

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action. More...

virtual const char *	ClassName () const
	Returns name of class to which the object belongs. More...

virtual void	Delete (Option_t *option="")
	Delete this object. More...

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object. More...

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects. More...

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs. More...

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current pad. More...

virtual void	Dump () const
	Dump contents of object on stdout. More...

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g. More...

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray. More...

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py). More...

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...

virtual UInt_t	GetUniqueID () const
	Return the unique object id. More...

virtual const char *	GetIconName () const
	Returns mime type name of object. More...

virtual Option_t *	GetOption () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. More...

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname". More...

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl. More...

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas. More...

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...

Bool_t	IsOnHeap () const

Bool_t	IsZombie () const

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself. More...

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list. More...

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list. More...

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename. More...

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out". More...

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object. More...

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id. More...

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory. More...

void *	operator new (size_t sz)

void *	operator new[] (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz, void *vp)

void	operator delete (void *ptr)
	Operator delete. More...

void	operator delete[] (void *ptr)
	Operator delete []. More...

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f. More...

void	SetBit (UInt_t f)

void	ResetBit (UInt_t f)

Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

void	InvertBit (UInt_t f)

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. More...

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. More...

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. More...

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. More...

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete. More...

Protected Member Functions
void	BitReverse (Double_t *working_space, Int_t num)
	AUXILIARY FUNCION // // This function carries out bir-reverse reordering of data // Function parameters: // -working_space-pointer to vector of processed data // -num-length of processed data // //. More...

void	BitReverseHaar (Double_t *working_space, Int_t shift, Int_t num, Int_t start)
	AUXILIARY FUNCION // // This function carries out bir-reverse reordering for Haar transform // Function parameters: // -working_space-pointer to vector of processed data // -shift-shift of position of processing // -start-initial position of processed data // -num-length of processed data // //. More...

void	Fourier (Double_t *working_space, Int_t num, Int_t hartley, Int_t direction, Int_t zt_clear)
	AUXILIARY FUNCION // // This function calculates Fourier based transform of a part of data // Function parameters: // -working_space-pointer to vector of transformed data // -num-length of processed data // -hartley-1 if it is Hartley transform, 0 othewise // -direction-forward or inverse transform // //. More...

Int_t	GeneralExe (Double_t *working_space, Int_t zt_clear, Int_t num, Int_t degree, Int_t type)
	AUXILIARY FUNCION // // This function calculates generalized (mixed) transforms of different degrees// Function parameters: // -working_space-pointer to vector of transformed data // -zt_clear-flag to clear imaginary data before staring // -num-length of processed data // -degree-degree of transform (see manual) // -type-type of mixed transform (see manual) // //. More...

Int_t	GeneralInv (Double_t *working_space, Int_t num, Int_t degree, Int_t type)
	AUXILIARY FUNCION // // This function calculates inverse generalized (mixed) transforms // Function parameters: // -working_space-pointer to vector of transformed data // -num-length of processed data // -degree-degree of transform (see manual) // -type-type of mixed transform (see manual) // //. More...

void	Haar (Double_t *working_space, Int_t num, Int_t direction)
	AUXILIARY FUNCION // // This function calculates Haar transform of a part of data // Function parameters: // -working_space-pointer to vector of transformed data // -num-length of processed data // -direction-forward or inverse transform // //. More...

void	Walsh (Double_t *working_space, Int_t num)
	AUXILIARY FUNCION // // This function calculates Walsh transform of a part of data // Function parameters: // -working_space-pointer to vector of transformed data // -num-length of processed data // //. More...

Protected Member Functions inherited from TObject
void	MakeZombie ()

virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

Protected Attributes
Int_t	fSize

Int_t	fTransformType

Int_t	fDegree

Int_t	fDirection

Int_t	fXmin

Int_t	fXmax

Double_t	fFilterCoeff

Double_t	fEnhanceCoeff

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Additional Inherited Members
Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...

static void	SetDtorOnly (void *obj)
	Set destructor only flag. More...

static Bool_t	GetObjectStat ()
	Get status of object stat flag. More...

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable. More...

#include <TSpectrumTransform.h>

Inheritance diagram for TSpectrumTransform:

Collaboration diagram for TSpectrumTransform:

Member Enumeration Documentation

anonymous enum

Enumerator
kTransformHaar
kTransformWalsh
kTransformCos
kTransformSin
kTransformFourier
kTransformHartley
kTransformFourierWalsh
kTransformFourierHaar
kTransformWalshHaar
kTransformCosWalsh
kTransformCosHaar
kTransformSinWalsh
kTransformSinHaar
kTransformForward
kTransformInverse

Definition at line 45 of file TSpectrumTransform.h.

Constructor & Destructor Documentation

TSpectrumTransform::TSpectrumTransform ( )

TSpectrumTransform::TSpectrumTransform ( Int_t size )

the constructor creates TSpectrumTransform object.

Its size must be > than zero and must be power of 2. It sets default transform type to be Cosine transform. Transform parameters can be changed using setter functions.

Definition at line 84 of file TSpectrumTransform.cxx.

TSpectrumTransform::~TSpectrumTransform ( )

virtual

destructor

Definition at line 115 of file TSpectrumTransform.cxx.

Member Function Documentation

void TSpectrumTransform::BitReverse	(	Double_t *	working_space,
		Int_t	num
	)

protected

AUXILIARY FUNCION // // This function carries out bir-reverse reordering of data // Function parameters: // -working_space-pointer to vector of processed data // -num-length of processed data // //.

Definition at line 272 of file TSpectrumTransform.cxx.

Referenced by Enhance(), FilterZonal(), and Transform().

void TSpectrumTransform::BitReverseHaar	(	Double_t *	working_space,
		Int_t	shift,
		Int_t	num,
		Int_t	start
	)

protected

AUXILIARY FUNCION // // This function carries out bir-reverse reordering for Haar transform // Function parameters: // -working_space-pointer to vector of processed data // -shift-shift of position of processing // -start-initial position of processed data // -num-length of processed data // //.

Definition at line 441 of file TSpectrumTransform.cxx.

Referenced by Enhance(), FilterZonal(), and Transform().

void TSpectrumTransform::Enhance	(	const Double_t *	source,
		Double_t *	destVector
	)

ONE-DIMENSIONAL ENHANCE ZONAL FUNCTION This function transforms the source spectrum.

The calling program should fill in input parameters. Then it multiplies transformed coefficients in the given region (fXmin, fXmax) by the given fEnhanceCoeff and transforms it back Processed data are written into dest spectrum.

Function parameters: source-pointer to the vector of source spectrum, its length should be size except for inverse FOURIER, FOUR-WALSh, FOUR-HAAR transform. These need 2*size length to supply real and imaginary coefficients. destVector-pointer to the vector of dest data, its length should be size except for direct FOURIER, FOUR-WALSh, FOUR-HAAR. These need 2*size length to store real and imaginary coefficients

Begin_Html

Definition at line 2096 of file TSpectrumTransform.cxx.

void TSpectrumTransform::FilterZonal	(	const Double_t *	source,
		Double_t *	destVector
	)

ONE-DIMENSIONAL FILTER ZONAL FUNCTION This function transforms the source spectrum.

The calling program should fill in input parameters. Then it sets transformed coefficients in the given region (fXmin, fXmax) to the given fFilterCoeff and transforms it back. Filtered data are written into dest spectrum.

Function parameters: source-pointer to the vector of source spectrum, its length should be size except for inverse FOURIER, FOUR-WALSH, FOUR-HAAR transform. These need 2*size length to supply real and imaginary coefficients. destVector-pointer to the vector of dest data, its length should be size except for direct FOURIER, FOUR-WALSH, FOUR-HAAR. These need 2*size length to store real and imaginary coefficients

Begin_Html

Definition at line 1487 of file TSpectrumTransform.cxx.

void TSpectrumTransform::Fourier	(	Double_t *	working_space,
		Int_t	num,
		Int_t	hartley,
		Int_t	direction,
		Int_t	zt_clear
	)

protected

AUXILIARY FUNCION // // This function calculates Fourier based transform of a part of data // Function parameters: // -working_space-pointer to vector of transformed data // -num-length of processed data // -hartley-1 if it is Hartley transform, 0 othewise // -direction-forward or inverse transform // //.

Definition at line 315 of file TSpectrumTransform.cxx.

Referenced by Enhance(), FilterZonal(), and Transform().

int TSpectrumTransform::GeneralExe	(	Double_t *	working_space,
		Int_t	zt_clear,
		Int_t	num,
		Int_t	degree,
		Int_t	type
	)

protected

AUXILIARY FUNCION // // This function calculates generalized (mixed) transforms of different degrees// Function parameters: // -working_space-pointer to vector of transformed data // -zt_clear-flag to clear imaginary data before staring // -num-length of processed data // -degree-degree of transform (see manual) // -type-type of mixed transform (see manual) // //.

Definition at line 491 of file TSpectrumTransform.cxx.

Referenced by Enhance(), FilterZonal(), and Transform().

int TSpectrumTransform::GeneralInv	(	Double_t *	working_space,
		Int_t	num,
		Int_t	degree,
		Int_t	type
	)

protected

AUXILIARY FUNCION // // This function calculates inverse generalized (mixed) transforms // Function parameters: // -working_space-pointer to vector of transformed data // -num-length of processed data // -degree-degree of transform (see manual) // -type-type of mixed transform (see manual) // //.

Definition at line 612 of file TSpectrumTransform.cxx.

Referenced by Enhance(), FilterZonal(), and Transform().

void TSpectrumTransform::Haar	(	Double_t *	working_space,
		Int_t	num,
		Int_t	direction
	)

protected

AUXILIARY FUNCION // // This function calculates Haar transform of a part of data // Function parameters: // -working_space-pointer to vector of transformed data // -num-length of processed data // -direction-forward or inverse transform // //.

Definition at line 131 of file TSpectrumTransform.cxx.

Referenced by Enhance(), FilterZonal(), and Transform().

void TSpectrumTransform::SetDirection ( Int_t direction )

SETTER FUNCION.

This function sets the direction of the transform: -direction (forward or inverse)

Definition at line 2741 of file TSpectrumTransform.cxx.

void TSpectrumTransform::SetEnhanceCoeff ( Double_t enhanceCoeff )

SETTER FUNCION.

This function sets the enhancement coefficient: -enhanceCoeff - after the transform the enhanced region (xmin, xmax) is multiplied by this coefficient. Applies only for enhancement operation.

Definition at line 2771 of file TSpectrumTransform.cxx.

void TSpectrumTransform::SetFilterCoeff ( Double_t filterCoeff )

SETTER FUNCION.

This function sets the filter coefficient: -filterCoeff - after the transform the filtered region (xmin, xmax) is replaced by this coefficient. Applies only for filtereng operation.

Definition at line 2758 of file TSpectrumTransform.cxx.

void TSpectrumTransform::SetRegion	(	Int_t	xmin,
		Int_t	xmax
	)

SETTER FUNCION.

This function sets the filtering or enhancement region: -xmin, xmax

Definition at line 2723 of file TSpectrumTransform.cxx.

void TSpectrumTransform::SetTransformType	(	Int_t	transType,
		Int_t	degree
	)

SETTER FUNCION.

This function sets the following parameters for transform: -transType - type of transform (Haar, Walsh, Cosine, Sine, Fourier, Hartley, Fourier-Walsh, Fourier-Haar, Walsh-Haar, Cosine-Walsh, Cosine-Haar, Sine-Walsh, Sine-Haar) -degree - degree of mixed transform, applies only for Fourier-Walsh, Fourier-Haar, Walsh-Haar, Cosine-Walsh, Cosine-Haar, Sine-Walsh, Sine-Haar transforms

Definition at line 2691 of file TSpectrumTransform.cxx.

void TSpectrumTransform::Transform	(	const Double_t *	source,
		Double_t *	destVector
	)

ONE-DIMENSIONAL TRANSFORM FUNCTION This function transforms the source spectrum.

The calling program should fill in input parameters. Transformed data are written into dest spectrum.

Function parameters: source-pointer to the vector of source spectrum, its length should be size except for inverse FOURIER, FOUR-WALSH, FOUR-HAAR transform. These need 2*size length to supply real and imaginary coefficients. destVector-pointer to the vector of dest data, its length should be size except for direct FOURIER, FOUR-WALSH, FOUR-HAAR. These need 2*size length to store real and imaginary coefficients

Begin_Html

Definition at line 744 of file TSpectrumTransform.cxx.

void TSpectrumTransform::Walsh	(	Double_t *	working_space,
		Int_t	num
	)

protected

AUXILIARY FUNCION // // This function calculates Walsh transform of a part of data // Function parameters: // -working_space-pointer to vector of transformed data // -num-length of processed data // //.

Definition at line 214 of file TSpectrumTransform.cxx.

Referenced by Enhance(), FilterZonal(), and Transform().