inv_beamformer.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef INV_BEAMFORMER_H
#define INV_BEAMFORMER_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../inv_global.h"
#include "inv_beamformer_settings.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <QList>
 
//=============================================================================================================
// STL INCLUDES
//=============================================================================================================
 
#include <vector>
 
//=============================================================================================================
// DEFINE NAMESPACE INVLIB
//=============================================================================================================
 
namespace INVLIB
{
 
//=============================================================================================================
class INVSHARED_EXPORT InvBeamformer
{
public:
    typedef QSharedPointer<InvBeamformer> SPtr;
    typedef QSharedPointer<const InvBeamformer> ConstSPtr;
 
    //=========================================================================================================
    InvBeamformer();
 
    //=========================================================================================================
    inline bool isValid() const;
 
    //=========================================================================================================
    inline int nSources() const;
 
    //=========================================================================================================
    inline int nChannels() const;
 
    //=========================================================================================================
    inline int nOrient() const;
 
    //=========================================================================================================
    inline int nFreqs() const;
 
public:
    QString kind; 
 
    // --- Spatial filter weights ---
    std::vector<Eigen::MatrixXd> weights; 
 
    // --- Whitening & projection ---
    Eigen::MatrixXd whitener; 
    Eigen::MatrixXd proj;     
 
    // --- Source space info ---
    Eigen::VectorXi vertices;  
    int nVerticesLh = -1;      
    Eigen::MatrixX3f sourceNn; 
    bool isFreOri;             
    int nSourcesTotal;         
    QString srcType;           
    QString subject;           
 
    // --- Filter parameters ---
    QStringList chNames;             
    BeamformerWeightNorm weightNorm; 
    BeamformerPickOri pickOri;       
    BeamformerInversion inversion;   
    double reg;                      
    int rank;                        
 
    // --- Max-power orientation (if pickOri == MaxPower) ---
    Eigen::MatrixX3d maxPowerOri; 
 
    // --- Frequency info (DICS only) ---
    Eigen::VectorXd frequencies; 
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline bool InvBeamformer::isValid() const
{
    return !weights.empty() && weights[0].size() > 0;
}
 
//=============================================================================================================
 
inline int InvBeamformer::nSources() const
{
    return nSourcesTotal;
}
 
//=============================================================================================================
 
inline int InvBeamformer::nChannels() const
{
    return weights.empty() ? 0 : static_cast<int>(weights[0].cols());
}
 
//=============================================================================================================
 
inline int InvBeamformer::nOrient() const
{
    return isFreOri ? 3 : 1;
}
 
//=============================================================================================================
 
inline int InvBeamformer::nFreqs() const
{
    return static_cast<int>(weights.size());
}
 
} // NAMESPACE INVLIB
 
#endif // INV_BEAMFORMER_H