FIRFilter.h

Go to the documentation of this file.

#ifndef GRT_FIR_FILTER_HEADER
#define GRT_FIR_FILTER_HEADER

#include "../CoreModules/PreProcessing.h"

GRT_BEGIN_NAMESPACE
 
class GRT_API FIRFilter : public PreProcessing{
public:
 enum FilterType
 {
 LPF=0, 
 HPF, 
 BPF 
 };

 FIRFilter(const FilterType filterType = LPF,const UINT numTaps = 50,const Float sampleRate = 100,const Float cutoffFrequency = 10,const Float gain = 1,const UINT numDimensions = 1);
 
 FIRFilter(const FIRFilter &rhs);
 
 virtual ~FIRFilter();
 
 FIRFilter& operator=(const FIRFilter &rhs);
 
 virtual bool deepCopyFrom(const PreProcessing *preProcessing);
 
 virtual bool process(const VectorFloat &inputVector);
 
 virtual bool reset();
 
 virtual bool clear();
 
 virtual bool save( std::fstream &file ) const;
 
 virtual bool load( std::fstream &file );

 bool buildFilter();
 
 Float filter(const Float x);
 
 VectorFloat filter(const VectorFloat &x);
 
 FilterType getFilterType() const;
 
 UINT getNumTaps() const;
 
 Float getSampleRate() const;
 
 Float getCutoffFrequency() const;
 
 Float getCutoffFrequencyLower() const;
 
 Float getCutoffFrequencyUpper() const;
 
 Float getGain() const;
 
 Vector< VectorFloat > getInputBuffer() const;
 
 VectorFloat getFilterCoefficents() const;
 
 bool setFilterType(const FilterType filterType);
 
 bool setNumTaps(const UINT numTaps);
 
 bool setSampleRate(const Float sampleRate);
 
 bool setCutoffFrequency(const Float cutoffFrequency);
 
 bool setCutoffFrequency(const Float cutoffFrequencyLower,const Float cutoffFrequencyUpper);
 
 bool setGain(const Float gain);

 static std::string getId();

 //Tell the compiler we are using the following functions from the MLBase class to stop hidden virtual function warnings
 using MLBase::save;
 using MLBase::load;

protected:
 FilterType filterType;
 UINT numTaps;
 Float sampleRate;
 Float cutoffFrequency;
 Float cutoffFrequencyLower;
 Float cutoffFrequencyUpper;
 Float gain;
 CircularBuffer< VectorFloat > y;
 VectorFloat z;
 
private:
 static const std::string id; 
 static RegisterPreProcessingModule< FIRFilter > registerModule;
};

GRT_END_NAMESPACE

#endif //GRT_FIR_FILTER_HEADER