decoding_csp.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef DECODING_CSP_H
#define DECODING_CSP_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "decoding_global.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// STL INCLUDES
//=============================================================================================================
 
#include <vector>
 
//=============================================================================================================
// DEFINE NAMESPACE DECODINGLIB
//=============================================================================================================
 
namespace DECODINGLIB{
 
//=============================================================================================================
class DECODINGSHARED_EXPORT DecodingCsp
{
public:
    //=========================================================================================================
    enum class TransformMode {
        AveragePower,   
        CspSpace        
    };
 
    //=========================================================================================================
    explicit DecodingCsp(int nComponents = 4,
                         TransformMode transformInto = TransformMode::AveragePower,
                         bool useLog = true);
 
    //=========================================================================================================
    void fit(const std::vector<Eigen::MatrixXd>& epochs,
             const Eigen::VectorXi& y);
 
    //=========================================================================================================
    Eigen::MatrixXd transform(const std::vector<Eigen::MatrixXd>& epochs) const;
 
    //=========================================================================================================
    Eigen::MatrixXd fitTransform(const std::vector<Eigen::MatrixXd>& epochs,
                                 const Eigen::VectorXi& y);
 
    //=========================================================================================================
    Eigen::MatrixXd inverseTransform(const Eigen::MatrixXd& X) const;
 
    //=========================================================================================================
    const Eigen::MatrixXd& filters() const;
 
    //=========================================================================================================
    const Eigen::MatrixXd& patterns() const;
 
    //=========================================================================================================
    const Eigen::VectorXd& mean() const;
 
    //=========================================================================================================
    const Eigen::VectorXd& stddev() const;
 
    //=========================================================================================================
    bool isFitted() const;
 
private:
    int m_nComponents;
    TransformMode m_transformInto;
    bool m_useLog;
 
    Eigen::MatrixXd m_filters;      
    Eigen::MatrixXd m_patterns;     
    Eigen::VectorXd m_mean;         
    Eigen::VectorXd m_std;          
    bool m_fitted = false;

    Eigen::MatrixXd computePowerFeatures(
        const std::vector<Eigen::MatrixXd>& epochs) const;
};
 
} // namespace DECODINGLIB
 
#endif // DECODING_CSP_H