ROOT 6.14/05 Reference Guide |
Advanced 2-dimensional orthogonal transform functions.
Class to carry out transforms of 2D 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:
Definition at line 16 of file TSpectrum2Transform.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 = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
enum | EDeprecatedStatusBits { kObjInCanvas = BIT(3) } |
enum | EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) } |
Public Member Functions | |
TSpectrum2Transform () | |
Default constructor. More... | |
TSpectrum2Transform (Int_t sizeX, Int_t sizeY) | |
The constructor creates TSpectrum2Transform object. More... | |
virtual | ~TSpectrum2Transform () |
Destructor. More... | |
void | Enhance (const Double_t **fSource, Double_t **fDest) |
This function transforms the source spectrum. More... | |
void | FilterZonal (const Double_t **fSource, Double_t **fDest) |
This function transforms the source spectrum. More... | |
void | SetDirection (Int_t direction) |
This function sets the direction of the transform: More... | |
void | SetEnhanceCoeff (Double_t enhanceCoeff) |
This function sets the enhancement coefficient: More... | |
void | SetFilterCoeff (Double_t filterCoeff) |
This function sets the filter coefficient: More... | |
void | SetRegion (Int_t xmin, Int_t xmax, Int_t ymin, Int_t ymax) |
This function sets the filtering or enhancement region: More... | |
void | SetTransformType (Int_t transType, Int_t degree) |
This function sets the following parameters for transform: More... | |
void | Transform (const Double_t **fSource, Double_t **fDest) |
This function transforms the source spectrum. More... | |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. More... | |
TObject (const TObject &object) | |
TObject copy ctor. More... | |
virtual | ~TObject () |
TObject destructor. 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... | |
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... | |
ULong_t | CheckedHash () |
Checked and record whether for this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More... | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. More... | |
virtual void | Clear (Option_t *="") |
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 abstract method. More... | |
virtual void | Copy (TObject &object) const |
Copy this to obj. 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 selected pad for instance with: gROOT->SetSelectedPad(gPad) . More... | |
virtual void | Dump () const |
Dump contents of object on stdout. More... | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. 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 void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. 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 const char * | GetIconName () const |
Returns mime type name of object. More... | |
virtual const char * | GetName () const |
Returns name of object. More... | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). More... | |
virtual Option_t * | GetOption () const |
virtual const char * | GetTitle () const |
Returns title of object. More... | |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. More... | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. More... | |
virtual ULong_t | Hash () const |
Return hash value for this object. More... | |
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. More... | |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. 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... | |
void | InvertBit (UInt_t f) |
virtual Bool_t | IsEqual (const TObject *obj) const |
Default equal comparison (objects are equal if they have the same address in memory). More... | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
virtual Bool_t | IsSortable () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
virtual void | ls (Option_t *option="") const |
The ls function lists the contents of a class on stdout. 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... | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. More... | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. More... | |
void | operator delete (void *ptr) |
Operator delete. More... | |
void | operator delete[] (void *ptr) |
Operator delete []. More... | |
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. 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 void | Print (Option_t *option="") const |
This method must be overridden when a class wants to print itself. 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... | |
void | ResetBit (UInt_t f) |
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... | |
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) |
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 | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. More... | |
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. More... | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. 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... | |
Protected Member Functions | |
void | BitReverse (Double_t *working_space, Int_t num) |
This function carries out bit-reverse reordering of data. More... | |
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. More... | |
void | FourCos2 (Double_t **working_matrix, Double_t *working_vector, Int_t numx, Int_t numy, Int_t direction, Int_t type) |
This function calculates 2D Fourier based transforms Function parameters: More... | |
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. More... | |
void | General2 (Double_t **working_matrix, Double_t *working_vector, Int_t numx, Int_t numy, Int_t direction, Int_t type, Int_t degree) |
This function calculates generalized (mixed) 2D transforms Function parameters: More... | |
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. More... | |
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: More... | |
void | Haar (Double_t *working_space, Int_t num, Int_t direction) |
This function calculates Haar transform of a part of data. More... | |
void | HaarWalsh2 (Double_t **working_matrix, Double_t *working_vector, Int_t numx, Int_t numy, Int_t direction, Int_t type) |
This function calculates 2D Haar and Walsh transforms Function parameters: More... | |
void | Walsh (Double_t *working_space, Int_t num) |
This function calculates Walsh transform of a part of data. More... | |
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). More... | |
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 More... | |
Int_t | fDirection |
forward or inverse transform More... | |
Double_t | fEnhanceCoeff |
multiplication coefficient applied in enhanced region; More... | |
Double_t | fFilterCoeff |
value set in the filtered region More... | |
Int_t | fSizeX |
x length of transformed data More... | |
Int_t | fSizeY |
y length of transformed data More... | |
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) More... | |
Int_t | fXmax |
last channel x of filtered or enhanced region More... | |
Int_t | fXmin |
first channel x of filtered or enhanced region More... | |
Int_t | fYmax |
last channel y of filtered or enhanced region More... | |
Int_t | fYmin |
first channel y of filtered or enhanced region More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from TObject | |
static Long_t | GetDtorOnly () |
Return destructor only flag. More... | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. More... | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. More... | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. More... | |
#include <TSpectrum2Transform.h>
anonymous enum |
Definition at line 30 of file TSpectrum2Transform.h.
TSpectrum2Transform::TSpectrum2Transform | ( | ) |
Default constructor.
Definition at line 39 of file TSpectrum2Transform.cxx.
The constructor creates TSpectrum2Transform object.
Its sizes 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 57 of file TSpectrum2Transform.cxx.
|
virtual |
Destructor.
Definition at line 99 of file TSpectrum2Transform.cxx.
This function carries out bit-reverse reordering of data.
Function parameters:
Definition at line 244 of file TSpectrum2Transform.cxx.
|
protected |
This function carries out bit-reverse reordering for Haar transform.
Function parameters:
Definition at line 405 of file TSpectrum2Transform.cxx.
This function transforms the source spectrum.
The calling program should fill in input parameters. Then it multiplies transformed coefficients in the given region by the given enhance_coeff and transforms it back
Function parameters:
This function transforms the source spectrum (for details see Transform function). Before the Enhance function is called the class must be created by constructor and the type of the transform as well as some other parameters must be set using a set of setter functions. The Enhance function multiplies transformed coefficients in the given region (fXmin, fXmax, fYmin, fYmax) by the given fEnhancCoeff and transforms it back. Enhanced data are written into dest spectrum.
Example to illustrate enhancement (class TSpectrumTransform2). To execute this example, do
root > .x Enhance2.C
Definition at line 2445 of file TSpectrum2Transform.cxx.
This function transforms the source spectrum.
The calling program should fill in input parameters. Then it sets transformed coefficients in the given region to the given filter_coeff and transforms it back Filtered data are written into dest spectrum.
Function parameters:
This function transforms the source spectrum (for details see Transform function). Before the FilterZonal function is called the class must be created by constructor and the type of the transform as well as some other parameters must be set using a set of setter functions. The FilterZonal function sets transformed coefficients in the given region (fXmin, fXmax) to the given fFilterCoeff and transforms it back. Filtered data are written into dest spectrum.
Example to illustrate zonal filtration (class TSpectrumTransform2). To execute this example, do
root > .x Filter2.C
Definition at line 2114 of file TSpectrum2Transform.cxx.
|
protected |
This function calculates 2D Fourier based transforms Function parameters:
Definition at line 778 of file TSpectrum2Transform.cxx.
|
protected |
This function calculates Fourier based transform of a part of data.
Function parameters:
Definition at line 283 of file TSpectrum2Transform.cxx.
|
protected |
This function calculates generalized (mixed) 2D transforms Function parameters:
Definition at line 1046 of file TSpectrum2Transform.cxx.
|
protected |
This function calculates generalized (mixed) transforms of different degrees.
Function parameters:
Definition at line 451 of file TSpectrum2Transform.cxx.
|
protected |
This function calculates inverse generalized (mixed) transforms Function parameters:
Definition at line 568 of file TSpectrum2Transform.cxx.
This function calculates Haar transform of a part of data.
Function parameters:
Definition at line 111 of file TSpectrum2Transform.cxx.
|
protected |
This function calculates 2D Haar and Walsh transforms Function parameters:
Definition at line 687 of file TSpectrum2Transform.cxx.
This function sets the direction of the transform:
Definition at line 2768 of file TSpectrum2Transform.cxx.
This function sets the enhancement coefficient:
Definition at line 2790 of file TSpectrum2Transform.cxx.
This function sets the filter coefficient:
Definition at line 2781 of file TSpectrum2Transform.cxx.
This function sets the filtering or enhancement region:
Definition at line 2748 of file TSpectrum2Transform.cxx.
This function sets the following parameters for transform:
Definition at line 2715 of file TSpectrum2Transform.cxx.
This function transforms the source spectrum.
The calling program should fill in input parameters. Transformed data are written into dest spectrum.
Function parameters:
Goal: to analyse experimental data using orthogonal transforms
[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 to illustrate Transform function (class TSpectrumTransform2). To execute this example, do
root > .x Transform2.C
Definition at line 1754 of file TSpectrum2Transform.cxx.
This function calculates Walsh transform of a part of data.
Function parameters:
Definition at line 190 of file TSpectrum2Transform.cxx.
|
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 21 of file TSpectrum2Transform.h.
|
protected |
forward or inverse transform
Definition at line 22 of file TSpectrum2Transform.h.
|
protected |
multiplication coefficient applied in enhanced region;
Definition at line 28 of file TSpectrum2Transform.h.
|
protected |
value set in the filtered region
Definition at line 27 of file TSpectrum2Transform.h.
|
protected |
x length of transformed data
Definition at line 18 of file TSpectrum2Transform.h.
|
protected |
y length of transformed data
Definition at line 19 of file TSpectrum2Transform.h.
|
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 20 of file TSpectrum2Transform.h.
|
protected |
last channel x of filtered or enhanced region
Definition at line 24 of file TSpectrum2Transform.h.
|
protected |
first channel x of filtered or enhanced region
Definition at line 23 of file TSpectrum2Transform.h.
|
protected |
last channel y of filtered or enhanced region
Definition at line 26 of file TSpectrum2Transform.h.
|
protected |
first channel y of filtered or enhanced region
Definition at line 25 of file TSpectrum2Transform.h.