fft Class Reference

Wrap FFTW. More...

#include <FFT.h>

List of all members.

Public Member Functions

bool Backward (double *aReDataIn=NULL, double *aImDataIn=NULL)
 FFT-backwards a complex data vector.
bool Forward (double *aReDataIn=NULL, double *aImDataIn=NULL)
 FFT-forwards a complex data vector.
double * GetIm (void)
 Returns the imaginary part vector after the last FFT.
double * GetNorm (void)
 Returns the norm vector after the last FFT.
double * GetNorm2 (void)
 Returns the squared norm vector after the last FFT.
double * GetPhase (void)
 Returns the phase after the last FFT.
double * GetRe (void)
 Returns the real part vector after the last FFT.
Constructors and destructors



 fft (const int asize, const string aplan="FFTW_ESTIMATE")
 Constructor of the fft class.
virtual ~fft (void)
 Destructor of the fft class.

Detailed Description

Wrap FFTW.

Author:
Florent Robinet

Constructor & Destructor Documentation

fft::fft ( const int  asize,
const string  aplan = "FFTW_ESTIMATE" 
)

Constructor of the fft class.

A FFT plan is contructed for a given input size. Several plan are supported: "FFTW_ESTIMATE", "FFTW_MEASURE" and "FFTW_PATIENT".

Parameters:
asize FFT length
aplan FFT plan
fft::~fft ( void   )  [virtual]

Destructor of the fft class.


Member Function Documentation

bool fft::Backward ( double *  aReDataIn = NULL,
double *  aImDataIn = NULL 
)

FFT-backwards a complex data vector.

The input data vector is defined by 2 arrays for the real and imaginary parts. A pointer to NULL can be used to set vectors to 0.0. These vectors should have the size of the FFT length defined in fft(): NO size check is performed!

Parameters:
aReDataIn data vector real part
aImDataIn data vector imaginary part
bool fft::Forward ( double *  aReDataIn = NULL,
double *  aImDataIn = NULL 
)

FFT-forwards a complex data vector.

The input data vector is defined by 2 arrays for the real and imaginary parts. A pointer to NULL can be used to set vectors to 0.0. These vectors should have the size of the FFT length defined in fft(): NO size check is performed!

Parameters:
aReDataIn data vector real part
aImDataIn data vector imaginary part
double * fft::GetIm ( void   ) 

Returns the imaginary part vector after the last FFT.

The vector has the size of the FFT length. NULL is returned if this function fails. The user is in charge of deleting the returned array.

double * fft::GetNorm ( void   ) 

Returns the norm vector after the last FFT.

The vector has the size of the FFT length. NULL is returned if this function fails. The user is in charge of deleting the returned array.

double * fft::GetNorm2 ( void   ) 

Returns the squared norm vector after the last FFT.

The vector has the size of the FFT length. NULL is returned if this function fails. The user is in charge of deleting the returned array.

double * fft::GetPhase ( void   ) 

Returns the phase after the last FFT.

The vector has the size of the FFT length. NULL is returned if this function fails. The user is in charge of deleting the returned array.

double * fft::GetRe ( void   ) 

Returns the real part vector after the last FFT.

The vector has the size of the FFT length. NULL is returned if this function fails. The user is in charge of deleting the returned array.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Friends Defines

Generated on 28 Jul 2015 by  doxygen 1.6.1