FFT.h

Go to the documentation of this file.

#ifndef GRT_FFT_HEADER
#define GRT_FFT_HEADER

#include "../../CoreModules/FeatureExtraction.h"
#include "FastFourierTransform.h"

GRT_BEGIN_NAMESPACE

class FFT : public FeatureExtraction
{
public:
 FFT(UINT fftWindowSize=512,UINT hopSize=1,UINT numDimensions=1,UINT fftWindowFunction=RECTANGULAR_WINDOW,bool computeMagnitude=true,bool computePhase=true);
    
    FFT(const FFT &rhs);
    
 virtual ~FFT(void);
    
    FFT& operator=(const FFT &rhs);

    virtual bool deepCopyFrom(const FeatureExtraction *featureExtraction);
    
    virtual bool computeFeatures(const VectorFloat &inputVector);

    virtual bool computeFeatures(const MatrixFloat &inputMatrix);

    virtual bool clear();
    
    virtual bool reset();
    
    virtual bool saveModelToFile( std::fstream &file ) const;
    
    virtual bool loadModelFromFile( std::fstream &file );
    
    bool init(UINT fftWindowSize,UINT hopSize,UINT numDimensions,UINT windowFunction,bool computeMagnitude,bool computePhase,DataType inputType = DATA_TYPE_VECTOR,DataType outputType = DATA_TYPE_VECTOR);
    
    bool update(const Float x);
    
    bool update(const VectorFloat &x);

    bool update(const MatrixFloat &x);
    
    UINT getHopSize();
    
    UINT getDataBufferSize();
    
    UINT getFFTWindowSize();
    
    UINT getFFTWindowFunction();
    
    UINT getHopCounter();
    
    bool getComputeMagnitude(){ if(initialized){ return computeMagnitude; } return false; }
    
    bool getComputePhase(){ if(initialized){ return computePhase; } return false; }
    
    Vector< FastFourierTransform > getFFTResults(){ return fft; }
    
    Vector< FastFourierTransform >& getFFTResultsPtr(){ return fft; }
    
    VectorFloat getFrequencyBins(const unsigned int sampleRate);
    
    bool setHopSize(UINT hopSize);
    
    bool setFFTWindowSize(UINT fftWindowSize);
    
    bool setFFTWindowFunction(UINT fftWindowFunction);
    
    bool setComputeMagnitude(bool computeMagnitude);
    
    bool setComputePhase(bool computePhase);
    
    using FeatureExtraction::saveModelToFile;
    using FeatureExtraction::loadModelFromFile;
    
protected:
    bool isPowerOfTwo(UINT x);                                   
    bool validateFFTWindowFunction(UINT fftWindowFunction);

    UINT hopSize;                                               
    UINT dataBufferSize;                                        
    UINT fftWindowSize;                                         
    UINT fftWindowFunction;                                     
    UINT hopCounter;                                            
    bool computeMagnitude;                                      
    bool computePhase;                                          
    VectorFloat tempBuffer;                                     
    CircularBuffer< VectorFloat > dataBuffer;                  
    Vector< FastFourierTransform > fft;                         
    std::map< unsigned int, unsigned int > windowSizeMap;       
    
    static RegisterFeatureExtractionModule< FFT > registerModule;
    
public:
    enum FFTWindowFunctionOptions{RECTANGULAR_WINDOW=0,BARTLETT_WINDOW,HAMMING_WINDOW,HANNING_WINDOW};
};

GRT_END_NAMESPACE

#endif //GRT_FFT_HEADER