Advanced 1-dimensional orthogonal transform functions.

Author: Miroslav Morhac

Legacy Code

TSpectrumTransform is a legacy interface: there will be no bug fixes nor new developments. Therefore it is not recommended to use it in new long-term production code. But, depending on the context, using TSpectrumTransform might still be a valid solution. For modeling a spectrum fitting and estimating the background one can use RooFit while for deconvolution and unfolding one can use TUnfold.

Class to carry out transforms of 1D spectra, its filtering and enhancement. It allows to calculate classic Fourier, Cosine, Sin, Hartley, Walsh, Haar transforms as well as mixed transforms (Fourier- Walsh, Fourier-Haar, Walsh-Haar, Cosine-Walsh, Cosine-Haar, Sin-Walsh and Sin-Haar). All the transforms are fast.

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 18 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	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

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

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Public Member Functions
	TSpectrumTransform ()
	default constructor

	TSpectrumTransform (Int_t size)
	the constructor creates TSpectrumTransform object.

	~TSpectrumTransform () override
	Destructor.

void	Enhance (const Double_t source, Double_t destVector)
	This function transforms the source spectrum.

void	FilterZonal (const Double_t source, Double_t destVector)
	This function transforms the source spectrum.

TClass *	IsA () const override

void	SetDirection (Int_t direction)
	This function sets the direction of the transform:

void	SetEnhanceCoeff (Double_t enhanceCoeff)
	This function sets the enhancement coefficient:

void	SetFilterCoeff (Double_t filterCoeff)
	This function sets the filter coefficient:

void	SetRegion (Int_t xmin, Int_t xmax)
	This function sets the filtering or enhancement region:

void	SetTransformType (Int_t transType, Int_t degree)
	This function sets the following parameters for transform:

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	Transform (const Double_t source, Double_t destVector)
	This function transforms the source spectrum.

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

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

virtual	~TNamed ()
	TNamed destructor.

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

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

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

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

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

const char *	GetName () const override
	Returns name of object.

const char *	GetTitle () const override
	Returns title of object.

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

Bool_t	IsSortable () const override

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

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

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

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

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

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

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

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

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

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

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

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

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

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

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

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

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

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

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

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

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

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

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

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

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

virtual Option_t *	GetOption () const

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

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

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

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

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

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

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

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

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

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

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

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

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

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

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

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

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

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

void *	operator new[] (size_t sz)

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

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

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

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

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

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

void	ResetBit (UInt_t f)

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

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

void	SetBit (UInt_t f)

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

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

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

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

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

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

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

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

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

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

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

Protected Member Functions
void	BitReverse (Double_t *working_space, Int_t num)
	This function carries out bit-reverse reordering of data Function parameters:

void	BitReverseHaar (Double_t *working_space, Int_t shift, Int_t num, Int_t start)
	This function carries out bit-reverse reordering for Haar transform Function parameters:

void	Fourier (Double_t *working_space, Int_t num, Int_t hartley, Int_t direction, Int_t zt_clear)
	This function calculates Fourier based transform of a part of data Function parameters:

Int_t	GeneralExe (Double_t *working_space, Int_t zt_clear, Int_t num, Int_t degree, Int_t type)
	This function calculates generalized (mixed) transforms of different degrees Function parameters:

Int_t	GeneralInv (Double_t *working_space, Int_t num, Int_t degree, Int_t type)
	This function calculates inverse generalized (mixed) transforms Function parameters:

void	Haar (Double_t *working_space, Int_t num, Int_t direction)
	This function calculates Haar transform of a part of data Function parameters:

void	Walsh (Double_t *working_space, Int_t num)
	This function calculates Walsh transform of a part of data Function parameters:

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Attributes
Int_t	fDegree
	degree of mixed transform, applies only for Fourier-Walsh, Fourier-Haar, Walsh-Haar, Cosine-Walsh, Cosine-Haar, Sine-Walsh, Sine-Haar transforms

Int_t	fDirection
	forward or inverse transform

Double_t	fEnhanceCoeff
	multiplication coefficient applied in enhanced region;

Double_t	fFilterCoeff
	value set in the filtered region

Int_t	fSize
	length of transformed data

Int_t	fTransformType
	type of transformation (Haar, Walsh, Cosine, Sine, Fourier, Hartley, Fourier-Walsh, Fourier-Haar, Walsh-Haar, Cosine-Walsh, Cosine-Haar, Sine-Walsh, Sine-Haar)

Int_t	fXmax
	last channel of filtered or enhanced region

Int_t	fXmin
	first channel of filtered or enhanced region

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

#include <TSpectrumTransform.h>

Inheritance diagram for TSpectrumTransform:

[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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

Definition at line 31 of file TSpectrumTransform.h.

Constructor & Destructor Documentation

◆ TSpectrumTransform() [1/2]

TSpectrumTransform::TSpectrumTransform ( )

default constructor

Definition at line 40 of file TSpectrumTransform.cxx.

◆ TSpectrumTransform() [2/2]

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 56 of file TSpectrumTransform.cxx.

◆ ~TSpectrumTransform()

TSpectrumTransform::~TSpectrumTransform ( )

override

Destructor.

Definition at line 85 of file TSpectrumTransform.cxx.

Member Function Documentation

◆ BitReverse()

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

protected

This function carries out bit-reverse reordering of data Function parameters:

working_space-pointer to vector of processed data
num-length of processed data

Definition at line 227 of file TSpectrumTransform.cxx.

◆ BitReverseHaar()

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

protected

This function carries out bit-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 386 of file TSpectrumTransform.cxx.

◆ Class()

static TClass * TSpectrumTransform::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TSpectrumTransform::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TSpectrumTransform::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 71 of file TSpectrumTransform.h.

◆ DeclFileName()

static const char * TSpectrumTransform::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 71 of file TSpectrumTransform.h.

◆ Enhance()

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

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

Example - script Enhance.c:

Fig. 1 Original spectrum (black line) and enhanced spectrum (red line) using Cosine transform (channels 0-1024 were multiplied by 2)

Script:

Example to illustrate Enhance function (class TSpectrumTransform). To execute this example, do:

root > .x Enhance.C

void Enhance() {
   Int_t i;
   Double_t nbins = 4096;
   Double_t xmin = 0;
   Double_t xmax = (Double_t)nbins;
   Double_t * source = new Double_t[nbins];
   Double_t * dest = new Double_t[nbins];
   TH1F *h = new TH1F("h","Enhancement using Cosine transform",nbins,xmin,xmax);
   TH1F *d = new TH1F("d","",nbins,xmin,xmax);
   TFile *f = new TFile("spectra/TSpectrum.root");
   h=(TH1F*) f->Get("transform1;1");
   for (i = 0; i < nbins; i++) source[i]=h->GetBinContent(i + 1);
   TCanvas *Transform1 = gROOT->GetListOfCanvases()->FindObject("Transform1");
   if (!Transform1) Transform1 = new TCanvas("Transform","Transform1",10,10,1000,700);
   h->SetAxisRange(700,1024);
   h->Draw("L");
   TSpectrum *s = new TSpectrum();
   TSpectrumTransform *t = new TSpectrumTransform(4096);
   t->SetTransformType(t->kTransformCos,0);
   t->SetRegion(0, 1024);
   t->SetEnhanceCoeff(2);
   t->Enhance(source,dest);
   for (i = 0; i < nbins; i++) d->SetBinContent(i + 1,dest[i]);
   d->SetLineColor(kRed);
   d->Draw("SAME L");
}

Definition at line 1779 of file TSpectrumTransform.cxx.

◆ FilterZonal()

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

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

Example - script Filter.c:

Fig. 1 Original spectrum (black line) and filtered spectrum (red line) using Cosine transform and zonal filtration (channels 2048-4095 were set to 0)

Script:

Example to illustrate FilterZonal function (class TSpectrumTransform). To execute this example, do:

root > .x Filter.C

#include <TSpectrum>
#include <TSpectrumTransform>
void Filter() {
   Int_t i;
   Double_t nbins = 4096;
   Double_t xmin = 0;
   Double_t xmax = (Double_t)nbins;
   Double_t * source = new Double_t[nbins];
   Double_t * dest = new Double_t[nbins];
   TH1F *h = new TH1F("h","Zonal filtering using Cosine transform",nbins,xmin,xmax);
   TH1F *d = new TH1F("d","",nbins,xmin,xmax);
   TFile *f = new TFile("spectra/TSpectrum.root");
   h=(TH1F*) f->Get("transform1;1");
   for (i = 0; i < nbins; i++) source[i]=h->GetBinContent(i + 1);
   TCanvas *Transform1 = gROOT->GetListOfCanvases()->FindObject("Transform1");
   if (!Transform1) Transform1 = new TCanvas("Transform","Transform1",10,10,1000,700);
   h->SetAxisRange(700,1024);
   h->Draw("L");
   TSpectrum *s = new TSpectrum();
   TSpectrumTransform *t = new TSpectrumTransform(4096);
   t->SetTransformType(t->kTransformCos,0);
   t->SetRegion(2048, 4095);
   t->FilterZonal(source,dest);
   for (i = 0; i < nbins; i++) d->SetBinContent(i + 1,dest[i]);
   d->SetLineColor(kRed);
   d->Draw("SAME L");
}

Definition at line 1269 of file TSpectrumTransform.cxx.

◆ Fourier()

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

protected

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 otherwise
direction-forward or inverse transform

Definition at line 265 of file TSpectrumTransform.cxx.

◆ GeneralExe()

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

protected

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 431 of file TSpectrumTransform.cxx.

◆ GeneralInv()

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

protected

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 547 of file TSpectrumTransform.cxx.

◆ Haar()

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

protected

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 96 of file TSpectrumTransform.cxx.

◆ IsA()

TClass * TSpectrumTransform::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TNamed.

Definition at line 71 of file TSpectrumTransform.h.

◆ SetDirection()

void TSpectrumTransform::SetDirection ( Int_t direction )

This function sets the direction of the transform:

direction (forward or inverse)

Definition at line 2278 of file TSpectrumTransform.cxx.

◆ SetEnhanceCoeff()

void TSpectrumTransform::SetEnhanceCoeff ( Double_t enhanceCoeff )

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 2300 of file TSpectrumTransform.cxx.

◆ SetFilterCoeff()

void TSpectrumTransform::SetFilterCoeff ( Double_t filterCoeff )

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 2291 of file TSpectrumTransform.cxx.

◆ SetRegion()

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

This function sets the filtering or enhancement region:

xmin, xmax

Definition at line 2264 of file TSpectrumTransform.cxx.

◆ SetTransformType()

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

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 2237 of file TSpectrumTransform.cxx.

◆ Streamer()

void TSpectrumTransform::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TNamed.

◆ StreamerNVirtual()

void TSpectrumTransform::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 71 of file TSpectrumTransform.h.

◆ Transform()

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

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

Transform methods

Goal: to analyse experimental data using orthogonal transforms

orthogonal transforms can be successfully used for the processing of nuclear spectra (not only)
they can be used to remove high frequency noise, to increase signal-to-background ratio as well as to enhance low intensity components [1], to carry out e.g. Fourier analysis etc.
we have implemented the function for the calculation of the commonly used orthogonal transforms as well as functions for the filtration and enhancement of experimental data

References:

[1] C.V. Hampton, B. Lian, Wm. C. McHarris: Fast-Fourier-transform spectral enhancement techniques for gamma-ray spectroscopy. NIM A353 (1994) 280-284.

[2] Morhac; M., Matouoek V., New adaptive Cosine-Walsh transform and its application to nuclear data compression, IEEE Transactions on Signal Processing 48 (2000) 2693.

[3] Morhac; M., Matouoek V., Data compression using new fast adaptive Cosine-Haar transforms, Digital Signal Processing 8 (1998) 63.

[4] Morhac; M., Matouoek V.: Multidimensional nuclear data compression using fast adaptive Walsh-Haar transform. Acta Physica Slovaca 51 (2001) 307.

Example - script Transform.c:

Fig. 1 Original gamma-ray spectrum

Fig. 2 Transformed spectrum from Fig. 1 using Cosine transform

Script:

Example to illustrate Transform function (class TSpectrumTransform). To execute this example, do:

root > .x Transform.C

#include <TSpectrum>
#include <TSpectrumTransform>
void Transform() {
   Int_t i;
   Double_t nbins = 4096;
   Double_t xmin = 0;
   Double_t xmax = (Double_t)nbins;
   Double_t * source = new Double_t[nbins];
   Double_t * dest = new Double_t[nbins];
   TH1F *h = new TH1F("h","Transformed spectrum using Cosine transform",nbins,xmin,xmax);
   TFile *f = new TFile("spectra/TSpectrum.root");
   h=(TH1F*) f->Get("transform1;1");
   for (i = 0; i < nbins; i++) source[i]=h->GetBinContent(i + 1);
   TCanvas *Transform1 = gROOT->GetListOfCanvases()->FindObject("Transform1");
   if (!Transform1) Transform1 = new TCanvas("Transform","Transform1",10,10,1000,700);
   TSpectrum *s = new TSpectrum();
   TSpectrumTransform *t = new TSpectrumTransform(4096);
   t->SetTransformType(t->kTransformCos,0);
   t->SetDirection(t->kTransformForward);
   t->Transform(source,dest);
   for (i = 0; i < nbins; i++) h->SetBinContent(i + 1,dest[i]);
   h->SetLineColor(kRed);
   h->Draw("L");
}

Definition at line 741 of file TSpectrumTransform.cxx.

◆ Walsh()

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

protected

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 174 of file TSpectrumTransform.cxx.

Member Data Documentation

◆ fDegree

Int_t TSpectrumTransform::fDegree

protected

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 23 of file TSpectrumTransform.h.

◆ fDirection

Int_t TSpectrumTransform::fDirection

protected

forward or inverse transform

Definition at line 24 of file TSpectrumTransform.h.

◆ fEnhanceCoeff

Double_t TSpectrumTransform::fEnhanceCoeff

protected

multiplication coefficient applied in enhanced region;

Definition at line 28 of file TSpectrumTransform.h.

◆ fFilterCoeff

Double_t TSpectrumTransform::fFilterCoeff

protected

value set in the filtered region

Definition at line 27 of file TSpectrumTransform.h.

◆ fSize

Int_t TSpectrumTransform::fSize

protected

length of transformed data

Definition at line 21 of file TSpectrumTransform.h.

◆ fTransformType

Int_t TSpectrumTransform::fTransformType

protected

type of transformation (Haar, Walsh, Cosine, Sine, Fourier, Hartley, Fourier-Walsh, Fourier-Haar, Walsh-Haar, Cosine-Walsh, Cosine-Haar, Sine-Walsh, Sine-Haar)

Definition at line 22 of file TSpectrumTransform.h.

◆ fXmax

Int_t TSpectrumTransform::fXmax

protected

last channel of filtered or enhanced region

Definition at line 26 of file TSpectrumTransform.h.

◆ fXmin

Int_t TSpectrumTransform::fXmin

protected

first channel of filtered or enhanced region

Definition at line 25 of file TSpectrumTransform.h.

Libraries for TSpectrumTransform:

[legend]

The documentation for this class was generated from the following files:

hist/spectrum/inc/TSpectrumTransform.h
hist/spectrum/src/TSpectrumTransform.cxx

Legacy Code

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TSpectrumTransform() [1/2]

◆ TSpectrumTransform() [2/2]

◆ ~TSpectrumTransform()

Member Function Documentation

◆ BitReverse()

◆ BitReverseHaar()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ Enhance()

Example - script Enhance.c:

Script:

◆ FilterZonal()

Example - script Filter.c:

Script:

◆ Fourier()

◆ GeneralExe()

◆ GeneralInv()

◆ Haar()

◆ IsA()

◆ SetDirection()

◆ SetEnhanceCoeff()

◆ SetFilterCoeff()

◆ SetRegion()

◆ SetTransformType()

◆ Streamer()

◆ StreamerNVirtual()

◆ Transform()

Transform methods

References:

Example - script Transform.c:

Script:

◆ Walsh()

Member Data Documentation

◆ fDegree

◆ fDirection

◆ fEnhanceCoeff

◆ fFilterCoeff

◆ fSize

◆ fTransformType

◆ fXmax

◆ fXmin