v2.0.0
Loading...
Searching...
No Matches
correlation.h
Go to the documentation of this file.
1//=============================================================================================================
34
35#ifndef CORRELATION_H
36#define CORRELATION_H
37
38//=============================================================================================================
39// INCLUDES
40//=============================================================================================================
41
43
44#include "abstractmetric.h"
46
47//=============================================================================================================
48// QT INCLUDES
49//=============================================================================================================
50
51#include <QSharedPointer>
52
53//=============================================================================================================
54// EIGEN INCLUDES
55//=============================================================================================================
56
57#include <Eigen/Core>
58
59//=============================================================================================================
60// FORWARD DECLARATIONS
61//=============================================================================================================
62
63//=============================================================================================================
64// DEFINE NAMESPACE CONNECTIVITYLIB
65//=============================================================================================================
66
67namespace CONNECTIVITYLIB
68{
69
70//=============================================================================================================
71// CONNECTIVITYLIB FORWARD DECLARATIONS
72//=============================================================================================================
73
74class Network;
75
76//=============================================================================================================
92{
93public:
94 typedef QSharedPointer<Correlation> SPtr;
95 typedef QSharedPointer<const Correlation> ConstSPtr;
96
97 //=========================================================================================================
101 explicit Correlation();
102
103 //=========================================================================================================
111 static Network calculate(ConnectivitySettings& connectivitySettings);
112
113protected:
114 //=========================================================================================================
122 static Eigen::MatrixXd compute(const ConnectivitySettings::IntermediateTrialData& inputData);
123
124 //=========================================================================================================
131 static void reduce(Eigen::MatrixXd& resultData,
132 const Eigen::MatrixXd& data);
133};
134
135//=============================================================================================================
136// INLINE DEFINITIONS
137//=============================================================================================================
138} // namespace CONNECTIVITYLIB
139
140#endif // CORRELATION_H
Export/import macros for the CONNECTIVITYLIB functional-connectivity library.
#define CONNECTIVITYSHARED_EXPORT
Input-data and parameter container shared by every functional-connectivity metric in CONNECTIVITYLIB.
Common static knobs shared by every functional-connectivity estimator in CONNECTIVITYLIB.
Functional connectivity metrics (coherence, PLV, cross-correlation, etc.).
Aggregates trial data, spectral cache and node geometry shared by all CONNECTIVITYLIB metrics.
Per-trial intermediate frequency-domain data used during connectivity computation.
static Eigen::MatrixXd compute(const ConnectivitySettings::IntermediateTrialData &inputData)
static Network calculate(ConnectivitySettings &connectivitySettings)
QSharedPointer< const Correlation > ConstSPtr
Definition correlation.h:95
static void reduce(Eigen::MatrixXd &resultData, const Eigen::MatrixXd &data)
QSharedPointer< Correlation > SPtr
Definition correlation.h:94
Graph container for one connectivity metric; nodes + weighted edges + threshold/visualisation state.
Definition network.h:106