ROOT logo
ROOT » MATH » FFTW » TFFTComplex

class TFFTComplex: public TVirtualFFT


 TFFTComplex
 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:
 1) Create an instance of TFFTComplex - this will allocate input and output
    arrays (unless an in-place transform is specified)
 2) Run the Init() function with the desired flags and settings
 3) Set the data (via SetPoints(), SetPoint() or SetPointComplex() functions)
 4) Run the Transform() function
 5) Get the output (via GetPoints(), GetPoint() or GetPointComplex() functions)
 6) Repeat steps 3)-5) as needed

 For a transform of the same size, but with different flags or sign, rerun the Init()
 function and continue with steps 3)-5)
 NOTE: 1) running Init() function will overwrite the input array! Don't set any data
          before running the Init() function
       2) FFTW computes unnormalized transform, so doing a transform followed by
          its inverse will lead to the original array scaled by the transform size


Function Members (Methods)

public:
TFFTComplex()
TFFTComplex(const TFFTComplex&)
TFFTComplex(Int_t n, Bool_t inPlace)
TFFTComplex(Int_t ndim, Int_t* n, Bool_t inPlace = kFALSE)
virtual~TFFTComplex()
voidTObject::AbstractMethod(const char* method) const
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTObject::Clear(Option_t* = "")
virtual TObject*TObject::Clone(const char* newname = "") const
virtual Int_tTObject::Compare(const TObject* obj) const
virtual voidTObject::Copy(TObject& object) const
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
static TVirtualFFT*TVirtualFFT::FFT(Int_t ndim, Int_t* n, Option_t* option)
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
static TVirtualFFT*TVirtualFFT::GetCurrentTransform()
static const char*TVirtualFFT::GetDefaultFFT()
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*TObject::GetIconName() const
virtual Int_t*GetN() const
virtual const char*TObject::GetName() const
virtual Int_tGetNdim() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
virtual voidGetPointComplex(Int_t ipoint, Double_t& re, Double_t& im, Bool_t fromInput = kFALSE) const
virtual voidGetPointComplex(const Int_t* ipoint, Double_t& re, Double_t& im, Bool_t fromInput = kFALSE) const
virtual Double_tGetPointReal(Int_t, Bool_t) const
virtual Double_tGetPointReal(const Int_t*, Bool_t) const
virtual voidGetPoints(Double_t* data, Bool_t fromInput = kFALSE) const
virtual voidGetPointsComplex(Double_t* data, Bool_t fromInput = kFALSE) const
virtual voidGetPointsComplex(Double_t* re, Double_t* im, Bool_t fromInput = kFALSE) const
virtual Double_t*GetPointsReal(Bool_t) const
virtual Int_tGetSign() const
virtual Int_tGetSize() const
virtual const char*TObject::GetTitle() const
virtual Option_t*GetTransformFlag() const
virtual Option_t*GetType() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTObject::Hash() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidInit(Option_t* flags, Int_t sign, const Int_t*)
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
virtual Bool_tIsInplace() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTObject::IsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
TFFTComplex&operator=(const TFFTComplex&)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTObject::Print(Option_t* option = "") const
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
static voidTVirtualFFT::SetDefaultFFT(const char* name = "")
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
static voidTObject::SetObjectStat(Bool_t stat)
virtual voidSetPoint(Int_t ipoint, Double_t re, Double_t im = 0)
virtual voidSetPoint(const Int_t* ipoint, Double_t re, Double_t im = 0)
virtual voidSetPointComplex(Int_t ipoint, TComplex& c)
virtual voidSetPoints(const Double_t* data)
virtual voidSetPointsComplex(const Double_t* re, const Double_t* im)
static voidTVirtualFFT::SetTransform(TVirtualFFT* fft)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp)
static TVirtualFFT*TVirtualFFT::SineCosine(Int_t ndim, Int_t* n, Int_t* r2rkind, Option_t* option)
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTransform()
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
protected:
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidTObject::MakeZombie()
UInt_tMapFlag(Option_t* flag)

Data Members

protected:
Option_t*fFlagstransform flags
void*fIninput array
Int_t*fNtransform sizes in each dimension
Int_tfNdimnumber of dimensions
void*fOutoutput array
void*fPlanfftw plan (the plan how to compute the transform)
Int_tfSignsign of the exponent of the transform (-1 is FFTW_FORWARD and +1 FFTW_BACKWARD)
Int_tfTotalSizetotal size of the transform
static TStringTVirtualFFT::fgDefaultdefault transformer
static TVirtualFFT*TVirtualFFT::fgFFTcurrent transformer

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

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. transforms
Allocates memory for the input array, and, if inPlace = kFALSE, for the output array
~TFFTComplex()
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
void Init(Option_t* flags, Int_t sign, const Int_t* )
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:
"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.
void Transform()
Computes the transform, specified in Init() function
void GetPoints(Double_t* data, Bool_t fromInput = kFALSE) const
Copies the output(or input) into the argument array
void GetPointComplex(Int_t ipoint, Double_t& re, Double_t& im, Bool_t fromInput = kFALSE) const
returns real and imaginary parts of the point #ipoint
void GetPointComplex(const Int_t* ipoint, Double_t& re, Double_t& im, Bool_t fromInput = kFALSE) const
For multidimensional transforms. Returns real and imaginary parts of the point #ipoint
void GetPointsComplex(Double_t* re, Double_t* im, Bool_t fromInput = kFALSE) const
Copies real and imaginary parts of the output (input) into the argument arrays
void GetPointsComplex(Double_t* data, Bool_t fromInput = kFALSE) const
Copies the output(input) into the argument array
void SetPoint(Int_t ipoint, Double_t re, Double_t im = 0)
sets real and imaginary parts of point # ipoint
void SetPoint(const Int_t* ipoint, Double_t re, Double_t im = 0)
For multidim. transforms. Sets real and imaginary parts of point # ipoint
void SetPointComplex(Int_t ipoint, TComplex& c)
void SetPoints(const Double_t* data)
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)
void SetPointsComplex(const Double_t* re, const Double_t* im)
set all points. the values are copied
UInt_t MapFlag(Option_t* flag)
allowed options:
"ES" - FFTW_ESTIMATE
"M" - FFTW_MEASURE
"P" - FFTW_PATIENT
"EX" - FFTW_EXHAUSTIVE
TFFTComplex()
Int_t * GetN() const
{return fN;}
Int_t GetNdim() const
{return fNdim;}
Int_t GetSize() const
{return fTotalSize;}
Option_t * GetType() const
{if (fSign==-1) return "C2CBackward"; else return "C2CForward";}
Int_t GetSign() const
{return fSign;}
Option_t * GetTransformFlag() const
{return fFlags;}
Bool_t IsInplace() const
{if (fOut) return kTRUE; else return kFALSE;}
Double_t GetPointReal(Int_t , Bool_t ) const
{return 0;}
Double_t GetPointReal(const Int_t* , Bool_t ) const
{return 0;}
Double_t* GetPointsReal(Bool_t ) const
{return 0;}