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

Definition at line 53 of file TFFTRealComplex.h.

Public Member Functions

 TFFTRealComplex ()
 
 TFFTRealComplex (Int_t n, Bool_t inPlace)
 For 1d transforms Allocates memory for the input array, and, if inPlace = kFALSE, for the output array. More...
 
 TFFTRealComplex (Int_t ndim, Int_t *n, Bool_t inPlace)
 For ndim-dimensional transforms Second argurment contains sizes of the transform in each dimension. More...
 
virtual ~TFFTRealComplex ()
 Destroys the data arrays and the plan. More...
 
virtual void Init (Option_t *flags, Int_t, const Int_t *)
 Creates the fftw-plan. More...
 
virtual Int_t GetSize () const
 
virtual Int_tGetN () const
 
virtual Int_t GetNdim () const
 
virtual Option_tGetType () const
 
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
 Fills the array data with the computed transform. More...
 
virtual Double_t GetPointReal (Int_t ipoint, Bool_t fromInput=kFALSE) const
 Returns the real part of the point #ipoint from the output or the point #ipoint from the input. More...
 
virtual Double_t GetPointReal (const Int_t *ipoint, Bool_t fromInput=kFALSE) const
 Returns the real part of the point #ipoint from the output or the point #ipoint from the input. More...
 
virtual void GetPointComplex (Int_t ipoint, Double_t &re, Double_t &im, Bool_t fromInput=kFALSE) const
 Returns the point #ipoint. More...
 
virtual void GetPointComplex (const Int_t *ipoint, Double_t &re, Double_t &im, Bool_t fromInput=kFALSE) const
 For multidimensional transforms. More...
 
virtual Double_tGetPointsReal (Bool_t fromInput=kFALSE) const
 Returns the input array// One of the interface classes to the FFTW package, can be used directly or via the TVirtualFFT class. More...
 
virtual void GetPointsComplex (Double_t *re, Double_t *im, Bool_t fromInput=kFALSE) const
 Fills the argument arrays with the real and imaginary parts of the computed transform. More...
 
virtual void GetPointsComplex (Double_t *data, Bool_t fromInput=kFALSE) const
 Fills the argument arrays with the real and imaginary parts of the computed transform. More...
 
virtual void SetPoint (Int_t ipoint, Double_t re, Double_t im=0)
 Set the point #ipoint. More...
 
virtual void SetPoint (const Int_t *ipoint, Double_t re, Double_t im=0)
 For multidimensional transforms. Set the point #ipoint. More...
 
virtual void SetPoints (const Double_t *data)
 Set all input points. More...
 
virtual void SetPointComplex (Int_t ipoint, TComplex &c)
 Sets the point #ipoint (only the real part of the argument is taken) More...
 
virtual void SetPointsComplex (const Double_t *re, const Double_t *im)
 Set all points. Only the real array is used. More...
 
virtual void Transform ()
 Computes the transform, specified in Init() function. More...
 
 ClassDef (TFFTRealComplex, 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

UInt_t MapFlag (Option_t *flag)
 allowed options: "ES" "M" "P" "EX" 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
 
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 <TFFTRealComplex.h>

+ Inheritance diagram for TFFTRealComplex:
+ Collaboration diagram for TFFTRealComplex:

Constructor & Destructor Documentation

TFFTRealComplex::TFFTRealComplex ( )
TFFTRealComplex::TFFTRealComplex ( Int_t  n,
Bool_t  inPlace 
)

For 1d transforms Allocates memory for the input array, and, if inPlace = kFALSE, for the output array.

Definition at line 69 of file TFFTRealComplex.cxx.

TFFTRealComplex::TFFTRealComplex ( Int_t  ndim,
Int_t n,
Bool_t  inPlace 
)

For ndim-dimensional transforms Second argurment contains sizes of the transform in each dimension.

Definition at line 91 of file TFFTRealComplex.cxx.

TFFTRealComplex::~TFFTRealComplex ( )
virtual

Destroys the data arrays and the plan.

However, some plan information stays around until the root session is over, and is reused if other plans of the same size are created

Definition at line 121 of file TFFTRealComplex.cxx.

Member Function Documentation

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

Implements TVirtualFFT.

Definition at line 74 of file TFFTRealComplex.h.

virtual Int_t TFFTRealComplex::GetNdim ( ) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 75 of file TFFTRealComplex.h.

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

Returns the point #ipoint.

For 1d, if ipoint > fN/2+1 (the point is in the Hermitian symmetric part), it is still returned. For >1d, only the first (roughly)half of points can be returned For 2d, see function GetPointComplex(Int_t *ipoint,...)

Implements TVirtualFFT.

Definition at line 245 of file TFFTRealComplex.cxx.

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

For multidimensional transforms.

Returns the point #ipoint. In case of transforms of more than 2 dimensions, only points from the first (roughly)half are returned, the rest being Hermitian symmetric

Implements TVirtualFFT.

Definition at line 290 of file TFFTRealComplex.cxx.

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

Returns the real part of the point #ipoint from the output or the point #ipoint from the input.

Implements TVirtualFFT.

Definition at line 210 of file TFFTRealComplex.cxx.

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

Returns the real part of the point #ipoint from the output or the point #ipoint from the input.

Implements TVirtualFFT.

Definition at line 224 of file TFFTRealComplex.cxx.

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

Fills the array data with the computed transform.

Only (roughly) a half of the transform is copied (exactly the output of FFTW), the rest being Hermitian symmetric with the first half

Implements TVirtualFFT.

Definition at line 186 of file TFFTRealComplex.cxx.

void TFFTRealComplex::GetPointsComplex ( Double_t re,
Double_t im,
Bool_t  fromInput = kFALSE 
) const
virtual

Fills the argument arrays with the real and imaginary parts of the computed transform.

Only (roughly) a half of the transform is copied, the rest being Hermitian symmetric with the first half

Implements TVirtualFFT.

Definition at line 382 of file TFFTRealComplex.cxx.

void TFFTRealComplex::GetPointsComplex ( Double_t data,
Bool_t  fromInput = kFALSE 
) const
virtual

Fills the argument arrays with the real and imaginary parts of the computed transform.

Only (roughly) a half of the transform is copied, the rest being Hermitian symmetric with the first half

Implements TVirtualFFT.

Definition at line 411 of file TFFTRealComplex.cxx.

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

Returns the input array// One of the interface classes to the FFTW package, can be used directly or via the TVirtualFFT class.

Only the basic interface of FFTW is implemented.

Implements TVirtualFFT.

Definition at line 368 of file TFFTRealComplex.cxx.

virtual Int_t TFFTRealComplex::GetSign ( ) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 77 of file TFFTRealComplex.h.

virtual Int_t TFFTRealComplex::GetSize ( ) const
inlinevirtual

Definition at line 73 of file TFFTRealComplex.h.

virtual Option_t* TFFTRealComplex::GetTransformFlag ( ) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 78 of file TFFTRealComplex.h.

virtual Option_t* TFFTRealComplex::GetType ( ) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 76 of file TFFTRealComplex.h.

void TFFTRealComplex::Init ( Option_t flags,
Int_t  ,
const Int_t  
)
virtual

Creates the fftw-plan.

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

Arguments sign and kind are dummy and not need to be specified Possible flag_options: "ES" (from "estimate") - no time in preparing the transform, but probably sub-optimal performanc "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.

Implements TVirtualFFT.

Definition at line 152 of file TFFTRealComplex.cxx.

virtual Bool_t TFFTRealComplex::IsInplace ( ) const
inlinevirtual

Implements TVirtualFFT.

Definition at line 79 of file TFFTRealComplex.h.

UInt_t TFFTRealComplex::MapFlag ( Option_t flag)
protected

allowed options: "ES" "M" "P" "EX"

Definition at line 489 of file TFFTRealComplex.cxx.

Referenced by Init().

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

Set the point #ipoint.

Implements TVirtualFFT.

Definition at line 439 of file TFFTRealComplex.cxx.

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

For multidimensional transforms. Set the point #ipoint.

Implements TVirtualFFT.

Definition at line 447 of file TFFTRealComplex.cxx.

void TFFTRealComplex::SetPointComplex ( Int_t  ipoint,
TComplex c 
)
virtual

Sets the point #ipoint (only the real part of the argument is taken)

Implements TVirtualFFT.

Definition at line 468 of file TFFTRealComplex.cxx.

void TFFTRealComplex::SetPoints ( const Double_t data)
virtual

Set all input points.

Implements TVirtualFFT.

Definition at line 458 of file TFFTRealComplex.cxx.

void TFFTRealComplex::SetPointsComplex ( const Double_t re,
const Double_t im 
)
virtual

Set all points. Only the real array is used.

Implements TVirtualFFT.

Definition at line 476 of file TFFTRealComplex.cxx.

void TFFTRealComplex::Transform ( )
virtual

Computes the transform, specified in Init() function.

Implements TVirtualFFT.

Definition at line 169 of file TFFTRealComplex.cxx.

Member Data Documentation

Option_t* TFFTRealComplex::fFlags
protected

Definition at line 61 of file TFFTRealComplex.h.

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

void* TFFTRealComplex::fIn
protected
Int_t* TFFTRealComplex::fN
protected
Int_t TFFTRealComplex::fNdim
protected
void* TFFTRealComplex::fOut
protected
void* TFFTRealComplex::fPlan
protected

Definition at line 57 of file TFFTRealComplex.h.

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

Int_t TFFTRealComplex::fTotalSize
protected

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