decoding_ssd.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef DECODING_SSD_H
#define DECODING_SSD_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "decoding_global.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// DEFINE NAMESPACE DECODINGLIB
//=============================================================================================================
 
namespace DECODINGLIB
{
 
//=============================================================================================================
class DECODINGSHARED_EXPORT DecodingSsd
{
public:
    //=========================================================================================================
    explicit DecodingSsd(int nComponents = 6,
                         double regParam = 0.05);
 
    //=========================================================================================================
    void fit(const Eigen::Ref<const Eigen::MatrixXd>& data,
             double sfreq,
             double signalLow, double signalHigh,
             double noiseLow, double noiseHigh);
 
    //=========================================================================================================
    Eigen::MatrixXd transform(const Eigen::Ref<const Eigen::MatrixXd>& data) const;
 
    //=========================================================================================================
    Eigen::MatrixXd fitTransform(const Eigen::Ref<const Eigen::MatrixXd>& data,
                                 double sfreq,
                                 double signalLow, double signalHigh,
                                 double noiseLow, double noiseHigh);
 
    //=========================================================================================================
    Eigen::MatrixXd apply(const Eigen::Ref<const Eigen::MatrixXd>& data) const;
 
    //=========================================================================================================
    const Eigen::MatrixXd& filters() const;
 
    //=========================================================================================================
    const Eigen::MatrixXd& patterns() const;
 
    //=========================================================================================================
    const Eigen::VectorXd& eigenvalues() const;
 
    //=========================================================================================================
    bool isFitted() const;
 
private:
    int m_nComponents;
    double m_regParam;
 
    Eigen::MatrixXd m_filters;
    Eigen::MatrixXd m_patterns;
    Eigen::VectorXd m_eigenvalues;
    bool m_fitted = false;

    static Eigen::MatrixXd bandpassFilter(const Eigen::MatrixXd& data,
                                          double sfreq,
                                          double lowFreq,
                                          double highFreq);
};
 
} // namespace DECODINGLIB
 
#endif // DECODING_SSD_H