inv_source_estimate.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef INV_SOURCE_ESTIMATE_H
#define INV_SOURCE_ESTIMATE_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "inv_global.h"
#include "inv_types.h"
#include "inv_focal_dipole.h"
#include "inv_source_coupling.h"
#include "inv_connectivity.h"
 
#include <fs/fs_label.h>
 
//=============================================================================================================
// STL INCLUDES
//=============================================================================================================
 
#include <vector>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
#include <QList>
#include <QIODevice>
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
//=============================================================================================================
// DEFINE NAMESPACE INVLIB
//=============================================================================================================
 
namespace INVLIB
{
 
//=============================================================================================================
// MNELIB FORWARD DECLARATIONS
//=============================================================================================================
 
//=============================================================================================================
class INVSHARED_EXPORT InvSourceEstimate
{
public:
    typedef QSharedPointer<InvSourceEstimate> SPtr;             
    typedef QSharedPointer<const InvSourceEstimate> ConstSPtr;  
 
    //=========================================================================================================
    InvSourceEstimate();
 
    //=========================================================================================================
    InvSourceEstimate(const Eigen::MatrixXd &p_sol, const Eigen::VectorXi &p_vertices, float p_tmin, float p_tstep);
 
    //=========================================================================================================
    InvSourceEstimate(const InvSourceEstimate& p_SourceEstimate);
 
    //=========================================================================================================
    InvSourceEstimate(QIODevice &p_IODevice);
 
    //=========================================================================================================
    void clear();
 
    //=========================================================================================================
    InvSourceEstimate reduce(qint32 start, qint32 n);
 
    //=========================================================================================================
    static bool read(QIODevice &p_IODevice, InvSourceEstimate& p_stc);
 
    //=========================================================================================================
    bool write(QIODevice &p_IODevice);
 
    //=========================================================================================================
    static InvSourceEstimate read_w(const QString& path);
 
    //=========================================================================================================
    void write_w(const QString& path) const;
 
    //=========================================================================================================
    inline bool isEmpty() const;
 
    //=========================================================================================================
    InvSourceEstimate& operator= (const InvSourceEstimate &rhs);
 
    //=========================================================================================================
    int samples() const;
 
    //=========================================================================================================
    Eigen::VectorXi getIndicesByLabel(const QList<FSLIB::FsLabel> &lPickedLabels, bool bIsClustered) const;
 
public:
    Eigen::MatrixXd data;           
    Eigen::VectorXi vertices;       
    Eigen::RowVectorXf times;       
    float tmin;                     
    float tstep;                    
 
    // --- Metadata ---
    InvEstimateMethod   method;         
    InvSourceSpaceType  sourceSpaceType;
    InvOrientationType  orientationType;
 
    // --- Positions (for discrete source spaces: sEEG contacts, ECoG electrodes, custom ROIs) ---
    Eigen::MatrixX3f    positions;      
 
    // --- Coupling layer (e.g. RAP-MUSIC correlated N-tuples on the grid) ---
    std::vector<InvSourceCoupling> couplings;   
 
    // --- Focal layer (e.g. ECD off-grid dipoles) ---
    std::vector<InvFocalDipole>    focalDipoles; 
 
    // --- Connectivity layer (pairwise source connectivity) ---
    std::vector<InvConnectivity>   connectivity; 
 
    //=========================================================================================================
    inline bool hasGridData() const;
 
    //=========================================================================================================
    inline bool hasCouplings() const;
 
    //=========================================================================================================
    inline bool hasFocalDipoles() const;
 
    //=========================================================================================================
    inline bool hasPositions() const;
 
    //=========================================================================================================
    inline bool hasConnectivity() const;
 
private:
    //=========================================================================================================
    void update_times();
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline bool InvSourceEstimate::isEmpty() const
{
    return tstep == -1;
}
 
//=============================================================================================================
 
inline bool InvSourceEstimate::hasGridData() const
{
    return data.size() > 0;
}
 
//=============================================================================================================
 
inline bool InvSourceEstimate::hasCouplings() const
{
    return !couplings.empty();
}
 
//=============================================================================================================
 
inline bool InvSourceEstimate::hasFocalDipoles() const
{
    return !focalDipoles.empty();
}
 
//=============================================================================================================
 
inline bool InvSourceEstimate::hasPositions() const
{
    return positions.rows() > 0;
}
 
//=============================================================================================================
 
inline bool InvSourceEstimate::hasConnectivity() const
{
    return !connectivity.empty();
}
} //NAMESPACE
 
#endif // INV_SOURCE_ESTIMATE_H