network.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef NETWORK_H
#define NETWORK_H

//=============================================================================================================
// INCLUDES
//=============================================================================================================

#include "../connectivity_global.h"

//=============================================================================================================
// QT INCLUDES
//=============================================================================================================

#include <QSharedPointer>

//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================

#include <Eigen/Core>

//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================

//=============================================================================================================
// DEFINE NAMESPACE CONNECTIVITYLIB
//=============================================================================================================

namespace CONNECTIVITYLIB {

//=============================================================================================================
// CONNECTIVITYLIB FORWARD DECLARATIONS
//=============================================================================================================

class NetworkEdge;
class NetworkNode;

struct VisualizationInfo {
    QString sMethod = "Map";                                    
    QString sColormap = "Viridis";                                 
    Eigen::Vector4i colNodes = Eigen::Vector4i(255, 0, 0, 255); 
    Eigen::Vector4i colEdges = Eigen::Vector4i(255, 0, 0, 255); 
};

//=============================================================================================================
class CONNECTIVITYSHARED_EXPORT Network
{

public:
    typedef QSharedPointer<Network> SPtr;            
    typedef QSharedPointer<const Network> ConstSPtr; 
    //=========================================================================================================
    explicit Network(const QString& sConnectivityMethod = "Unknown",
                     double dThreshold = 0.0);

    //=========================================================================================================
    Eigen::MatrixXd getFullConnectivityMatrix(bool bGetMirroredVersion = true) const;

    //=========================================================================================================
    Eigen::MatrixXd getThresholdedConnectivityMatrix(bool bGetMirroredVersion = true) const;

    //=========================================================================================================
    const QList<QSharedPointer<NetworkEdge> >& getFullEdges() const;

    //=========================================================================================================
    const QList<QSharedPointer<NetworkEdge> >& getThresholdedEdges() const;

    //=========================================================================================================
    const QList<QSharedPointer<NetworkNode> >& getNodes() const;

    //=========================================================================================================
    QSharedPointer<NetworkEdge> getEdgeAt(int i);

    //=========================================================================================================
    QSharedPointer<NetworkNode> getNodeAt(int i);

    //=========================================================================================================
    qint16 getFullDistribution() const;

    //=========================================================================================================
    qint16 getThresholdedDistribution() const;

    //=========================================================================================================
    void setConnectivityMethod(const QString& sConnectivityMethod);

    //=========================================================================================================
    QString getConnectivityMethod() const;

    //=========================================================================================================
    QPair<double, double> getMinMaxFullWeights() const;

    //=========================================================================================================
    QPair<double, double> getMinMaxThresholdedWeights() const;

    //=========================================================================================================
    QPair<int,int> getMinMaxFullDegrees() const;

    //=========================================================================================================
    QPair<int,int> getMinMaxThresholdedDegrees() const;

    //=========================================================================================================
    QPair<int,int> getMinMaxFullIndegrees() const;

    //=========================================================================================================
    QPair<int,int> getMinMaxThresholdedIndegrees() const;

    //=========================================================================================================
    QPair<int,int> getMinMaxFullOutdegrees() const;

    //=========================================================================================================
    QPair<int,int> getMinMaxThresholdedOutdegrees() const;

    //=========================================================================================================
    void setThreshold(double dThreshold = 0.0);

    //=========================================================================================================
    double getThreshold();

    //=========================================================================================================
    void setFrequencyRange(float fLowerFreq, float fUpperFreq);

    //=========================================================================================================
    const QPair<float,float>& getFrequencyRange() const;

    //=========================================================================================================
    void append(QSharedPointer<NetworkEdge> newEdge);

    //=========================================================================================================
    void append(QSharedPointer<NetworkNode> newNode);

    //=========================================================================================================
    bool isEmpty() const;

    //=========================================================================================================
    void normalize();

    //=========================================================================================================
    VisualizationInfo getVisualizationInfo() const;

    //=========================================================================================================
    void setVisualizationInfo(const VisualizationInfo& visualizationInfo);

    //=========================================================================================================
    float getSamplingFrequency() const;

    //=========================================================================================================
    void setSamplingFrequency(float fSFreq);

    //=========================================================================================================
    int getUsedFreqBins() const;

    //=========================================================================================================
    void setUsedFreqBins(int iNumberFreqBins);

    //=========================================================================================================
    void setFFTSize(int iFFTSize);

    //=========================================================================================================
    int getFFTSize();

protected:
    QList<QSharedPointer<NetworkEdge> >     m_lFullEdges;               
    QList<QSharedPointer<NetworkEdge> >     m_lThresholdedEdges;        
    QList<QSharedPointer<NetworkNode> >     m_lNodes;                   
    Eigen::MatrixXd                         m_matDistMatrix;            
    QString                                 m_sConnectivityMethod;      
    QPair<double,double>                    m_minMaxFullWeights;        
    QPair<double,double>                    m_minMaxThresholdedWeights; 
    QPair<float,float>                      m_minMaxFrequency;          
    double                                  m_dThreshold;               
    float                                   m_fSFreq;                   
    int                                     m_iNumberFreqBins;          
    int                                     m_iFFTSize;                 
    VisualizationInfo                       m_visualizationInfo;        
};

//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // namespace CONNECTIVITYLIB

#ifndef metatype_networks
#define metatype_networks
Q_DECLARE_METATYPE(CONNECTIVITYLIB::Network);
#endif

#ifndef metatype_networkslist
#define metatype_networkslist
Q_DECLARE_METATYPE(QList<CONNECTIVITYLIB::Network>);
#endif

#ifndef metatype_networkssptr
#define metatype_networkssptr
Q_DECLARE_METATYPE(CONNECTIVITYLIB::Network::SPtr);
#endif

#ifndef metatype_networkssptrlist
#define metatype_networkssptrlist
Q_DECLARE_METATYPE(QList<CONNECTIVITYLIB::Network::SPtr>);
#endif

#endif // NETWORK_H