Logo ROOT   6.13/01
Reference Guide
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TFFTComplex Class Reference

Definition at line 47 of file TFFTComplex.h.

Public Member Functions

 TFFTComplex ()
 default More...
 
 TFFTComplex (Int_t n, Bool_t inPlace)
 For 1d transforms Allocates memory for the input array, and, if inPlace = kFALSE, for the output array. More...
 
 TFFTComplex (Int_t ndim, Int_t *n, Bool_t inPlace=kFALSE)
 For multidim. More...
 
virtual ~TFFTComplex ()
 Destroys the data arrays and the plan. More...
 
virtual Int_t * GetN () const
 
virtual Int_t GetNdim () const
 
virtual 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 More...
 
virtual 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. More...
 
virtual Double_t GetPointReal (Int_t, Bool_t) const
 
virtual Double_t GetPointReal (const Int_t *, Bool_t) const
 
virtual void GetPoints (Double_t *data, Bool_t fromInput=kFALSE) const
 Copies the output(or input) into the argument array. More...
 
virtual 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. More...
 
virtual void GetPointsComplex (Double_t *data, Bool_t fromInput=kFALSE) const
 Copies the output(input) into the argument array. More...
 
virtual Double_t * GetPointsReal (Bool_t) const
 
virtual Int_t GetSign () const
 
virtual Int_t GetSize () const
 
virtual Option_t * GetTransformFlag () const
 
virtual Option_t * GetType () const
 
virtual void Init (Option_t *flags, Int_t sign, const Int_t *)
 Creates the fftw-plan. More...
 
virtual Bool_t IsInplace () const
 
virtual void SetPoint (Int_t ipoint, Double_t re, Double_t im=0)
 sets real and imaginary parts of point # ipoint More...
 
virtual void SetPoint (const Int_t *ipoint, Double_t re, Double_t im=0)
 For multidim. transforms. Sets real and imaginary parts of point # ipoint. More...
 
virtual void SetPointComplex (Int_t ipoint, TComplex &c)
 
virtual void SetPoints (const Double_t *data)
 set all points. More...
 
virtual void SetPointsComplex (const Double_t *re, const Double_t *im)
 set all points. the values are copied More...
 
virtual void Transform ()
 Computes the transform, specified in Init() function. More...
 

Protected Member Functions

UInt_t MapFlag (Option_t *flag)
 allowed options: "ES" - FFTW_ESTIMATE "M" - FFTW_MEASURE "P" - FFTW_PATIENT "EX" - FFTW_EXHAUSTIVE More...
 

Protected Attributes

TString fFlags
 
void * fIn
 
Int_t * fN
 
Int_t fNdim
 
void * fOut
 
void * fPlan
 
Int_t fSign
 
Int_t fTotalSize
 

#include <TFFTComplex.h>

Inheritance diagram for TFFTComplex:
[legend]

Constructor & Destructor Documentation

◆ TFFTComplex() [1/3]

TFFTComplex::TFFTComplex ( )

default

Definition at line 49 of file TFFTComplex.cxx.

◆ TFFTComplex() [2/3]

TFFTComplex::TFFTComplex ( 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 64 of file TFFTComplex.cxx.

◆ TFFTComplex() [3/3]

TFFTComplex::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

Definition at line 83 of file TFFTComplex.cxx.

◆ ~TFFTComplex()

TFFTComplex::~TFFTComplex ( )
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 106 of file TFFTComplex.cxx.

Member Function Documentation

◆ GetN()

virtual Int_t* TFFTComplex::GetN ( ) const
inlinevirtual

Definition at line 68 of file TFFTComplex.h.

◆ GetNdim()

virtual Int_t TFFTComplex::GetNdim ( ) const
inlinevirtual

Definition at line 69 of file TFFTComplex.h.

◆ GetPointComplex() [1/2]

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

returns real and imaginary parts of the point #ipoint

Definition at line 184 of file TFFTComplex.cxx.

◆ GetPointComplex() [2/2]

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

For multidimensional transforms. Returns real and imaginary parts of the point #ipoint.

Definition at line 198 of file TFFTComplex.cxx.

◆ GetPointReal() [1/2]

virtual Double_t TFFTComplex::GetPointReal ( Int_t  ,
Bool_t   
) const
inlinevirtual

Definition at line 77 of file TFFTComplex.h.

◆ GetPointReal() [2/2]

virtual Double_t TFFTComplex::GetPointReal ( const Int_t *  ,
Bool_t   
) const
inlinevirtual

Definition at line 78 of file TFFTComplex.h.

◆ GetPoints()

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

Copies the output(or input) into the argument array.

Definition at line 166 of file TFFTComplex.cxx.

◆ GetPointsComplex() [1/2]

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

Copies real and imaginary parts of the output (input) into the argument arrays.

Definition at line 216 of file TFFTComplex.cxx.

◆ GetPointsComplex() [2/2]

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

Copies the output(input) into the argument array.

Definition at line 234 of file TFFTComplex.cxx.

◆ GetPointsReal()

virtual Double_t* TFFTComplex::GetPointsReal ( Bool_t  ) const
inlinevirtual

Definition at line 81 of file TFFTComplex.h.

◆ GetSign()

virtual Int_t TFFTComplex::GetSign ( ) const
inlinevirtual

Definition at line 72 of file TFFTComplex.h.

◆ GetSize()

virtual Int_t TFFTComplex::GetSize ( ) const
inlinevirtual

Definition at line 70 of file TFFTComplex.h.

◆ GetTransformFlag()

virtual Option_t* TFFTComplex::GetTransformFlag ( ) const
inlinevirtual

Definition at line 73 of file TFFTComplex.h.

◆ GetType()

virtual Option_t* TFFTComplex::GetType ( ) const
inlinevirtual

Definition at line 71 of file TFFTComplex.h.

◆ Init()

void TFFTComplex::Init ( Option_t *  flags,
Int_t  sign,
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!!!!!

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.

Definition at line 135 of file TFFTComplex.cxx.

◆ IsInplace()

virtual Bool_t TFFTComplex::IsInplace ( ) const
inlinevirtual

Definition at line 74 of file TFFTComplex.h.

◆ MapFlag()

UInt_t TFFTComplex::MapFlag ( Option_t *  flag)
protected

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

Definition at line 313 of file TFFTComplex.cxx.

◆ SetPoint() [1/2]

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

sets real and imaginary parts of point # ipoint

Definition at line 252 of file TFFTComplex.cxx.

◆ SetPoint() [2/2]

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

For multidim. transforms. Sets real and imaginary parts of point # ipoint.

Definition at line 261 of file TFFTComplex.cxx.

◆ SetPointComplex()

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

Definition at line 273 of file TFFTComplex.cxx.

◆ SetPoints()

void TFFTComplex::SetPoints ( const Double_t *  data)
virtual

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)

Definition at line 283 of file TFFTComplex.cxx.

◆ SetPointsComplex()

void TFFTComplex::SetPointsComplex ( const Double_t *  re,
const Double_t *  im 
)
virtual

set all points. the values are copied

Definition at line 294 of file TFFTComplex.cxx.

◆ Transform()

void TFFTComplex::Transform ( )
virtual

Computes the transform, specified in Init() function.

Definition at line 153 of file TFFTComplex.cxx.

Member Data Documentation

◆ fFlags

TString TFFTComplex::fFlags
protected

Definition at line 56 of file TFFTComplex.h.

◆ fIn

void* TFFTComplex::fIn
protected

Definition at line 49 of file TFFTComplex.h.

◆ fN

Int_t* TFFTComplex::fN
protected

Definition at line 54 of file TFFTComplex.h.

◆ fNdim

Int_t TFFTComplex::fNdim
protected

Definition at line 52 of file TFFTComplex.h.

◆ fOut

void* TFFTComplex::fOut
protected

Definition at line 50 of file TFFTComplex.h.

◆ fPlan

void* TFFTComplex::fPlan
protected

Definition at line 51 of file TFFTComplex.h.

◆ fSign

Int_t TFFTComplex::fSign
protected

Definition at line 55 of file TFFTComplex.h.

◆ fTotalSize

Int_t TFFTComplex::fTotalSize
protected

Definition at line 53 of file TFFTComplex.h.

Libraries for TFFTComplex:
[legend]

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