inv_cmne.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef INV_CMNE_H
#define INV_CMNE_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../inv_global.h"
#include "../inv_source_estimate.h"
#include "inv_cmne_settings.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
#include <Eigen/Dense>
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
#ifndef WASMBUILD
namespace UTILSLIB
{
struct PythonRunnerResult;
}
#endif
 
//=============================================================================================================
// DEFINE NAMESPACE INVLIB
//=============================================================================================================
 
namespace INVLIB
{
 
//=============================================================================================================
struct INVSHARED_EXPORT InvCMNEResult
{
    InvSourceEstimate stcDspm;        
    InvSourceEstimate stcSensing;     
    InvSourceEstimate stcCmne;        
    InvSourceEstimate stcLstmPredict; 
    Eigen::MatrixXd matKernelDspm;    
};
 
//=============================================================================================================
class INVSHARED_EXPORT InvCMNE
{
public:
    //=========================================================================================================
    static InvCMNEResult compute(
        const Eigen::MatrixXd& matEvoked,
        const Eigen::MatrixXd& matGain,
        const Eigen::MatrixXd& matNoiseCov,
        const Eigen::MatrixXd& matSrcCov,
        const InvCMNESettings& settings);
 
    //=========================================================================================================
    static bool applyCmne(const Eigen::MatrixXd& matDspmData,
                          const QString& onnxModelPath,
                          Eigen::MatrixXd& sensing,
                          Eigen::MatrixXd& prediction,
                          Eigen::MatrixXd& cmne);
 
    //=========================================================================================================
    static Eigen::MatrixXd controlEstimate(const Eigen::MatrixXd& matDspmData, int lookBack);
 
    //=========================================================================================================
    static Eigen::MatrixXd zScoreRectify(const Eigen::MatrixXd& matStcData);
 
    //=========================================================================================================
#ifndef WASMBUILD
    static UTILSLIB::PythonRunnerResult trainLstm(
        const QString& fwdPath,
        const QString& covPath,
        const QString& epochsPath,
        const QString& outOnnxPath,
        const InvCMNESettings& settings,
        const QString& gtStcPrefix = {},
        int hiddenSize = 256,
        int numLayers = 1,
        int trainEpochs = 50,
        double learningRate = 1e-3,
        int batchSize = 64,
        const QString& finetuneOnnxPath = {},
        const QString& pythonExe = QStringLiteral("python3"));
#endif
 
private:
    //=========================================================================================================
    static Eigen::MatrixXd computeDspmKernel(
        const Eigen::MatrixXd& matGain,
        const Eigen::MatrixXd& matNoiseCov,
        const Eigen::MatrixXd& matSrcCov,
        double lambda2);
 
    static Eigen::MatrixXd standardize(const Eigen::MatrixXd& matStcData);
};
 
} // namespace INVLIB
 
#endif // INV_CMNE_H