ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TFFTReal Class Reference

Definition at line 68 of file TFFTReal.h.

Public Member Functions

 TFFTReal ()
 
 TFFTReal (Int_t n, Bool_t inPlace=kFALSE)
 For 1d transforms n here is the physical size of the transform (see FFTW manual for more details) More...
 
 TFFTReal (Int_t ndim, Int_t *n, Bool_t inPlace=kFALSE)
 For multidimensional transforms 1st parameter is the # of dimensions, 2nd is the sizes (physical) of the transform in each dimension. More...
 
virtual ~TFFTReal ()
 clean-up More...
 
virtual void Init (Option_t *flags, Int_t sign, const Int_t *kind)
 Creates the fftw-plan. More...
 
virtual Int_t GetSize () const
 
virtual Int_tGetN () const
 
virtual Int_t GetNdim () const
 
virtual Option_tGetType () const
 Returns the type of the transform. More...
 
virtual Int_t GetSign () const
 
virtual Option_tGetTransformFlag () const
 
virtual Bool_t IsInplace () const
 
virtual void GetPoints (Double_t *data, Bool_t fromInput=kFALSE) const
 Copies the output (or input) points into the provided array, that should be big enough. More...
 
virtual Double_t GetPointReal (Int_t ipoint, Bool_t fromInput=kFALSE) const
 For 1d tranforms. Returns point #ipoint. More...
 
virtual Double_t GetPointReal (const Int_t *ipoint, Bool_t fromInput=kFALSE) const
 For multidim.transforms. Returns point #ipoint. More...
 
virtual void GetPointComplex (const Int_t *ipoint, Double_t &re, Double_t &im, Bool_t fromInput=kFALSE) const
 Only for input of HC2R and output of R2HC and for 1d. More...
 
virtual void GetPointComplex (Int_t ipoint, Double_t &re, Double_t &im, Bool_t fromInput=kFALSE) const
 Only for input of HC2R and output of R2HC. More...
 
virtual Double_tGetPointsReal (Bool_t fromInput=kFALSE) const
 Returns the output (or input) array. More...
 
virtual void GetPointsComplex (Double_t *, Double_t *, Bool_t) const
 
virtual void GetPointsComplex (Double_t *, Bool_t) const
 
virtual void SetPoint (Int_t ipoint, Double_t re, Double_t im=0)
 
virtual void SetPoint (const Int_t *ipoint, Double_t re, Double_t)
 Since multidimensional R2HC and HC2R transforms are not supported, third parameter is dummy. More...
 
virtual void SetPoints (const Double_t *data)
 Sets all points. More...
 
virtual void SetPointComplex (Int_t, TComplex &)
 
virtual void SetPointsComplex (const Double_t *, const Double_t *)
 
virtual void Transform ()
 Computes the transform, specified in Init() function. More...
 
 ClassDef (TFFTReal, 0)
 
- Public Member Functions inherited from TVirtualFFT
 TVirtualFFT ()
 
virtual ~TVirtualFFT ()
 
 ClassDef (TVirtualFFT, 0)
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (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 Clear (Option_t *="")
 
virtual TObjectClone (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () 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 * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. 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...
 
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...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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...
 
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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator 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

Int_t MapOptions (const Int_t *kind)
 transfers the r2r_kind parameters to fftw type More...
 
UInt_t MapFlag (Option_t *flag)
 allowed options: "ES" - FFTW_ESTIMATE "M" - FFTW_MEASURE "P" - FFTW_PATIENT "EX" - FFTW_EXHAUSTIVE 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

voidfIn
 
voidfOut
 
voidfPlan
 
Int_t fNdim
 
Int_t fTotalSize
 
Int_tfN
 
voidfKind
 
Option_tfFlags
 

Additional Inherited Members

- 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) }
 
- Static Public Member Functions inherited from TVirtualFFT
static TVirtualFFTFFT (Int_t ndim, Int_t *n, Option_t *option)
 Returns a pointer to the FFT of requested size and type. More...
 
static TVirtualFFTSineCosine (Int_t ndim, Int_t *n, Int_t *r2rkind, Option_t *option)
 Returns a pointer to a sine or cosine transform of requested size and kind. More...
 
static TVirtualFFTGetCurrentTransform ()
 static: return current fgFFT More...
 
static void SetTransform (TVirtualFFT *fft)
 static: set the current transfrom to parameter More...
 
static const char * GetDefaultFFT ()
 static: return the name of the default fft More...
 
static void SetDefaultFFT (const char *name="")
 static: set name of default fft More...
 
- 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...
 
- Static Protected Attributes inherited from TVirtualFFT
static TVirtualFFTfgFFT = 0
 
static TString fgDefault = ""
 

#include <TFFTReal.h>

+ Inheritance diagram for TFFTReal:
+ Collaboration diagram for TFFTReal:

Constructor & Destructor Documentation

TFFTReal::TFFTReal ( )
TFFTReal::TFFTReal ( Int_t  n,
Bool_t  inPlace = kFALSE 
)

For 1d transforms n here is the physical size of the transform (see FFTW manual for more details)

Definition at line 83 of file TFFTReal.cxx.

TFFTReal::TFFTReal ( Int_t  ndim,
Int_t n,
Bool_t  inPlace = kFALSE 
)

For multidimensional transforms 1st parameter is the # of dimensions, 2nd is the sizes (physical) of the transform in each dimension.

Definition at line 103 of file TFFTReal.cxx.

TFFTReal::~TFFTReal ( )
virtual

clean-up

Definition at line 125 of file TFFTReal.cxx.

Member Function Documentation

TFFTReal::ClassDef ( TFFTReal  ,
 
)
virtual Int_t* TFFTReal::GetN ( ) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 91 of file TFFTReal.h.

virtual Int_t TFFTReal::GetNdim ( ) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 92 of file TFFTReal.h.

void TFFTReal::GetPointComplex ( const Int_t ipoint,
Double_t re,
Double_t im,
Bool_t  fromInput = kFALSE 
) const
virtual

Only for input of HC2R and output of R2HC and for 1d.

Implements TVirtualFFT.

Definition at line 277 of file TFFTReal.cxx.

void TFFTReal::GetPointComplex ( Int_t  ipoint,
Double_t re,
Double_t im,
Bool_t  fromInput = kFALSE 
) const
virtual

Only for input of HC2R and output of R2HC.

Implements TVirtualFFT.

Definition at line 257 of file TFFTReal.cxx.

Double_t TFFTReal::GetPointReal ( Int_t  ipoint,
Bool_t  fromInput = kFALSE 
) const
virtual

For 1d tranforms. Returns point #ipoint.

Implements TVirtualFFT.

Definition at line 231 of file TFFTReal.cxx.

Double_t TFFTReal::GetPointReal ( const Int_t ipoint,
Bool_t  fromInput = kFALSE 
) const
virtual

For multidim.transforms. Returns point #ipoint.

Implements TVirtualFFT.

Definition at line 244 of file TFFTReal.cxx.

void TFFTReal::GetPoints ( Double_t data,
Bool_t  fromInput = kFALSE 
) const
virtual

Copies the output (or input) points into the provided array, that should be big enough.

Implements TVirtualFFT.

Definition at line 221 of file TFFTReal.cxx.

virtual void TFFTReal::GetPointsComplex ( Double_t ,
Double_t ,
Bool_t   
) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 106 of file TFFTReal.h.

virtual void TFFTReal::GetPointsComplex ( Double_t ,
Bool_t   
) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 107 of file TFFTReal.h.

Double_t * TFFTReal::GetPointsReal ( Bool_t  fromInput = kFALSE) const
virtual

Returns the output (or input) array.

Implements TVirtualFFT.

Definition at line 285 of file TFFTReal.cxx.

Referenced by GetPointComplex(), GetPointReal(), and GetPoints().

virtual Int_t TFFTReal::GetSign ( ) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 94 of file TFFTReal.h.

virtual Int_t TFFTReal::GetSize ( ) const
inlinevirtual

Definition at line 90 of file TFFTReal.h.

virtual Option_t* TFFTReal::GetTransformFlag ( ) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 95 of file TFFTReal.h.

Option_t * TFFTReal::GetType ( ) const
virtual

Returns the type of the transform.

Implements TVirtualFFT.

Definition at line 205 of file TFFTReal.cxx.

void TFFTReal::Init ( Option_t flags,
Int_t  sign,
const Int_t kind 
)
virtual

Creates the fftw-plan.

NOTE: input and output arrays are overwritten during initialisation, so don't set any points, before running this function!!!!!

1st parameter: Possible flag_options: "ES" (from "estimate") - no time in preparing the transform, but probably sub-optimal performance "M" (from "measure") - some time spend in finding the optimal way to do the transform "P" (from "patient") - more time spend in finding the optimal way to do the transform "EX" (from "exhaustive") - the most optimal way is found This option should be chosen depending on how many transforms of the same size and type are going to be done. Planning is only done once, for the first transform of this size and type. 2nd parameter is dummy and doesn't need to be specified 3rd parameter- transform kind for each dimension 4 different kinds of sine and cosine transforms are available DCT-I - kind=0 DCT-II - kind=1 DCT-III - kind=2 DCT-IV - kind=3 DST-I - kind=4 DST-II - kind=5 DSTIII - kind=6 DSTIV - kind=7

Implements TVirtualFFT.

Definition at line 171 of file TFFTReal.cxx.

virtual Bool_t TFFTReal::IsInplace ( ) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 96 of file TFFTReal.h.

UInt_t TFFTReal::MapFlag ( Option_t flag)
protected

allowed options: "ES" - FFTW_ESTIMATE "M" - FFTW_MEASURE "P" - FFTW_PATIENT "EX" - FFTW_EXHAUSTIVE

Definition at line 397 of file TFFTReal.cxx.

Referenced by Init().

Int_t TFFTReal::MapOptions ( const Int_t kind)
protected

transfers the r2r_kind parameters to fftw type

Definition at line 351 of file TFFTReal.cxx.

Referenced by Init().

void TFFTReal::SetPoint ( Int_t  ipoint,
Double_t  re,
Double_t  im = 0 
)
virtual

Implements TVirtualFFT.

Definition at line 305 of file TFFTReal.cxx.

void TFFTReal::SetPoint ( const Int_t ipoint,
Double_t  re,
Double_t   
)
virtual

Since multidimensional R2HC and HC2R transforms are not supported, third parameter is dummy.

Implements TVirtualFFT.

Definition at line 327 of file TFFTReal.cxx.

virtual void TFFTReal::SetPointComplex ( Int_t  ,
TComplex  
)
inlinevirtual

Implements TVirtualFFT.

Definition at line 112 of file TFFTReal.h.

void TFFTReal::SetPoints ( const Double_t data)
virtual

Sets all points.

Implements TVirtualFFT.

Definition at line 342 of file TFFTReal.cxx.

virtual void TFFTReal::SetPointsComplex ( const Double_t ,
const Double_t  
)
inlinevirtual

Implements TVirtualFFT.

Definition at line 113 of file TFFTReal.h.

void TFFTReal::Transform ( )
virtual

Computes the transform, specified in Init() function.

Implements TVirtualFFT.

Definition at line 192 of file TFFTReal.cxx.

Member Data Documentation

Option_t* TFFTReal::fFlags
protected

Definition at line 77 of file TFFTReal.h.

Referenced by GetTransformFlag(), Init(), and TFFTReal().

void* TFFTReal::fIn
protected

Definition at line 70 of file TFFTReal.h.

Referenced by GetPointsReal(), Init(), SetPoint(), SetPoints(), TFFTReal(), and ~TFFTReal().

void* TFFTReal::fKind
protected

Definition at line 76 of file TFFTReal.h.

Referenced by GetPointComplex(), GetType(), Init(), MapOptions(), SetPoint(), TFFTReal(), and ~TFFTReal().

Int_t* TFFTReal::fN
protected

Definition at line 75 of file TFFTReal.h.

Referenced by GetN(), GetPointComplex(), GetPointReal(), Init(), SetPoint(), TFFTReal(), and ~TFFTReal().

Int_t TFFTReal::fNdim
protected

Definition at line 73 of file TFFTReal.h.

Referenced by GetNdim(), GetPointReal(), Init(), MapOptions(), SetPoint(), and TFFTReal().

void* TFFTReal::fOut
protected

Definition at line 71 of file TFFTReal.h.

Referenced by GetPointsReal(), Init(), TFFTReal(), and ~TFFTReal().

void* TFFTReal::fPlan
protected

Definition at line 72 of file TFFTReal.h.

Referenced by Init(), TFFTReal(), Transform(), and ~TFFTReal().

Int_t TFFTReal::fTotalSize
protected

Definition at line 74 of file TFFTReal.h.

Referenced by GetPointReal(), GetPoints(), GetSize(), SetPoint(), SetPoints(), and TFFTReal().


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