firfilter.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FIRFILTER_DSP_H
#define FIRFILTER_DSP_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "dsp_global.h"
#include "filterkernel.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
#include <vector>
 
//=============================================================================================================
// DEFINE NAMESPACE UTILSLIB
//=============================================================================================================
 
namespace UTILSLIB
{
 
//=============================================================================================================
class DSPSHARED_EXPORT FirFilter
{
public:
    //=========================================================================================================
    enum FilterType
    {
        LowPass = 0,  
        HighPass = 1, 
        BandPass = 2, 
        BandStop = 3  
    };
 
    //=========================================================================================================
    enum DesignMethod
    {
        Cosine = 0,        
        ParksMcClellan = 1 
    };
 
    //=========================================================================================================
    static FilterKernel design(int iOrder,
                               FilterType type,
                               double dCutoffLow,
                               double dCutoffHigh,
                               double dSFreq,
                               double dTransition = 5.0,
                               DesignMethod method = Cosine);
 
    //=========================================================================================================
    static Eigen::RowVectorXd apply(const Eigen::RowVectorXd& vecData,
                                    FilterKernel& kernel);
 
    //=========================================================================================================
    static Eigen::RowVectorXd applyZeroPhase(const Eigen::RowVectorXd& vecData,
                                             FilterKernel& kernel);
 
    //=========================================================================================================
    static Eigen::MatrixXd applyZeroPhaseMatrix(const Eigen::MatrixXd& matData,
                                                FilterKernel& kernel,
                                                const Eigen::RowVectorXi& vecPicks = Eigen::RowVectorXi());
 
    //=========================================================================================================
    static Eigen::RowVectorXd designMne(double dSFreq, double dLFreq, double dHFreq);
 
    //=========================================================================================================
    static Eigen::MatrixXd filterData(const Eigen::MatrixXd& matData, double dSFreq, double dLFreq, double dHFreq);

    enum class FirWindow
    {
        Hann,   
        Hamming 
    };
 
    //=========================================================================================================
    static Eigen::RowVectorXd firwin2(int nTaps, const std::vector<double>& freq, const std::vector<double>& gain,
                                      FirWindow window = FirWindow::Hann);
 
    //=========================================================================================================
    static Eigen::MatrixXd filterDataZeroDouble(const Eigen::MatrixXd& matData, double dSFreq, double dLFreq, double dHFreq,
                                                FirWindow window = FirWindow::Hann);
 
private:
    static Eigen::MatrixXd overlapAddZeroPhase(const Eigen::MatrixXd& matData, const Eigen::RowVectorXd& h, Eigen::Index nEdge);
};
 
} // namespace UTILSLIB
 
#endif // FIRFILTER_DSP_H