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. Computes complex input/output discrete Fourier transforms (DFT) in one or more dimensions. For the detailed information on the computed transforms please refer to the FFTW manual, chapter "What FFTW really computes".
How to use it:
For a transform of the same size, but with different flags or sign, rerun the Init() function and continue with steps 3)-5)
NOTE:
Definition at line 20 of file TFFTComplex.h.
Public Member Functions | |
TFFTComplex () | |
default | |
TFFTComplex (Int_t n, Bool_t inPlace) | |
For 1d transforms Allocates memory for the input array, and, if inPlace = kFALSE, for the output array. | |
TFFTComplex (Int_t ndim, Int_t *n, Bool_t inPlace=kFALSE) | |
For multidim. | |
~TFFTComplex () override | |
Destroys the data arrays and the plan. | |
Int_t * | GetN () const override |
Int_t | GetNdim () const override |
void | GetPointComplex (const Int_t *ipoint, Double_t &re, Double_t &im, Bool_t fromInput=kFALSE) const override |
For multidimensional transforms. Returns real and imaginary parts of the point #ipoint | |
void | GetPointComplex (Int_t ipoint, Double_t &re, Double_t &im, Bool_t fromInput=kFALSE) const override |
returns real and imaginary parts of the point #ipoint | |
Double_t | GetPointReal (const Int_t *, Bool_t) const override |
Double_t | GetPointReal (Int_t, Bool_t) const override |
void | GetPoints (Double_t *data, Bool_t fromInput=kFALSE) const override |
Copies the output(or input) into the argument array. | |
void | GetPointsComplex (Double_t *data, Bool_t fromInput=kFALSE) const override |
Copies the output(input) into the argument array. | |
void | GetPointsComplex (Double_t *re, Double_t *im, Bool_t fromInput=kFALSE) const override |
Copies real and imaginary parts of the output (input) into the argument arrays. | |
Double_t * | GetPointsReal (Bool_t) const override |
Int_t | GetSign () const override |
virtual Int_t | GetSize () const |
Option_t * | GetTransformFlag () const override |
Option_t * | GetType () const override |
void | Init (Option_t *flags, Int_t sign, const Int_t *) override |
Creates the fftw-plan. | |
TClass * | IsA () const override |
Bool_t | IsInplace () const override |
void | SetPoint (const Int_t *ipoint, Double_t re, Double_t im=0) override |
For multidim. transforms. Sets real and imaginary parts of point # ipoint. | |
void | SetPoint (Int_t ipoint, Double_t re, Double_t im=0) override |
sets real and imaginary parts of point # ipoint | |
void | SetPointComplex (Int_t ipoint, TComplex &c) override |
void | SetPoints (const Double_t *data) override |
set all points. | |
void | SetPointsComplex (const Double_t *re, const Double_t *im) override |
set all points. the values are copied | |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
void | Transform () override |
Computes the transform, specified in Init() function. | |
![]() | |
TVirtualFFT () | |
virtual | ~TVirtualFFT () |
destructor | |
TClass * | IsA () const override |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
![]() | |
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 | Clear (Option_t *="") |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. | |
virtual Int_t | Compare (const TObject *obj) const |
Compare abstract method. | |
virtual void | Copy (TObject &object) const |
Copy this to obj. | |
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 const char * | GetName () const |
Returns 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 const char * | GetTitle () const |
Returns title of object. | |
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. | |
virtual ULong_t | Hash () const |
Return hash value for this object. | |
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 |
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. | |
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 void | Print (Option_t *option="") const |
This method must be overridden when a class wants to print itself. | |
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 TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static TVirtualFFT * | FFT (Int_t ndim, Int_t *n, Option_t *option) |
Returns a pointer to the FFT of requested size and type. | |
static TVirtualFFT * | GetCurrentTransform () |
static: return current fgFFT | |
static const char * | GetDefaultFFT () |
static: return the name of the default fft | |
static void | SetDefaultFFT (const char *name="") |
static: set name of default fft | |
static void | SetTransform (TVirtualFFT *fft) |
static: set the current transfrom to parameter | |
static TVirtualFFT * | SineCosine (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. | |
![]() | |
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 | |
UInt_t | MapFlag (Option_t *flag) |
allowed options: | |
![]() | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). | |
void | MakeZombie () |
Protected Attributes | |
TString | fFlags |
void * | fIn |
Int_t * | fN |
Int_t | fNdim |
void * | fOut |
void * | fPlan |
Int_t | fSign |
Int_t | fTotalSize |
Additional Inherited Members | |
![]() | |
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 )) } |
![]() | |
enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
![]() | |
static TString | fgDefault = "" |
static TVirtualFFT * | fgFFT = nullptr |
#include <TFFTComplex.h>
TFFTComplex::TFFTComplex | ( | ) |
default
Definition at line 52 of file TFFTComplex.cxx.
For 1d transforms Allocates memory for the input array, and, if inPlace = kFALSE, for the output array.
Definition at line 67 of file TFFTComplex.cxx.
For multidim.
transforms Allocates memory for the input array, and, if inPlace = kFALSE, for the output array
Definition at line 86 of file TFFTComplex.cxx.
|
override |
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 109 of file TFFTComplex.cxx.
|
static |
|
inlinestaticconstexpr |
Definition at line 65 of file TFFTComplex.h.
|
inlinestatic |
Definition at line 65 of file TFFTComplex.h.
|
inlineoverridevirtual |
Implements TVirtualFFT.
Definition at line 41 of file TFFTComplex.h.
|
inlineoverridevirtual |
Implements TVirtualFFT.
Definition at line 42 of file TFFTComplex.h.
|
overridevirtual |
For multidimensional transforms. Returns real and imaginary parts of the point #ipoint
Implements TVirtualFFT.
Definition at line 203 of file TFFTComplex.cxx.
|
overridevirtual |
returns real and imaginary parts of the point #ipoint
Implements TVirtualFFT.
Definition at line 189 of file TFFTComplex.cxx.
Implements TVirtualFFT.
Definition at line 51 of file TFFTComplex.h.
Implements TVirtualFFT.
Definition at line 50 of file TFFTComplex.h.
Copies the output(or input) into the argument array.
Implements TVirtualFFT.
Definition at line 171 of file TFFTComplex.cxx.
|
overridevirtual |
Copies the output(input) into the argument array.
Implements TVirtualFFT.
Definition at line 239 of file TFFTComplex.cxx.
|
overridevirtual |
Copies real and imaginary parts of the output (input) into the argument arrays.
Implements TVirtualFFT.
Definition at line 221 of file TFFTComplex.cxx.
Implements TVirtualFFT.
Definition at line 54 of file TFFTComplex.h.
|
inlineoverridevirtual |
Implements TVirtualFFT.
Definition at line 45 of file TFFTComplex.h.
|
inlinevirtual |
Definition at line 43 of file TFFTComplex.h.
|
inlineoverridevirtual |
Implements TVirtualFFT.
Definition at line 46 of file TFFTComplex.h.
|
inlineoverridevirtual |
Implements TVirtualFFT.
Definition at line 44 of file TFFTComplex.h.
Creates the fftw-plan.
NOTE: input and output arrays are overwritten during initialisation, so don't set any points, before running this function!!!!!
2nd parameter: +1
Argument kind is dummy and doesn't need to be specified
Possible flag_options:
Implements TVirtualFFT.
Definition at line 140 of file TFFTComplex.cxx.
|
inlineoverridevirtual |
Reimplemented from TObject.
Definition at line 65 of file TFFTComplex.h.
|
inlineoverridevirtual |
Implements TVirtualFFT.
Definition at line 47 of file TFFTComplex.h.
allowed options:
Definition at line 318 of file TFFTComplex.cxx.
For multidim. transforms. Sets real and imaginary parts of point # ipoint.
Implements TVirtualFFT.
Definition at line 266 of file TFFTComplex.cxx.
sets real and imaginary parts of point # ipoint
Implements TVirtualFFT.
Definition at line 257 of file TFFTComplex.cxx.
Implements TVirtualFFT.
Definition at line 278 of file TFFTComplex.cxx.
|
overridevirtual |
set all points.
the values are copied. points should be ordered as follows: [re_0, im_0, re_1, im_1, ..., re_n, im_n)
Implements TVirtualFFT.
Definition at line 288 of file TFFTComplex.cxx.
set all points. the values are copied
Implements TVirtualFFT.
Definition at line 299 of file TFFTComplex.cxx.
|
overridevirtual |
|
inline |
Definition at line 65 of file TFFTComplex.h.
|
overridevirtual |
Computes the transform, specified in Init() function.
Implements TVirtualFFT.
Definition at line 158 of file TFFTComplex.cxx.
|
protected |
Definition at line 29 of file TFFTComplex.h.
|
protected |
Definition at line 22 of file TFFTComplex.h.
|
protected |
Definition at line 27 of file TFFTComplex.h.
|
protected |
Definition at line 25 of file TFFTComplex.h.
|
protected |
Definition at line 23 of file TFFTComplex.h.
|
protected |
Definition at line 24 of file TFFTComplex.h.
|
protected |
Definition at line 28 of file TFFTComplex.h.
|
protected |
Definition at line 26 of file TFFTComplex.h.