MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Types | Public Member Functions | Static Public Member Functions | Static Protected Member Functions | List of all members
CONNECTIVITYLIB::Correlation Class Reference

This class computes the correlation metric. More...

#include <correlation.h>

Public Types

typedef QSharedPointer< CorrelationSPtr
typedef QSharedPointer< const CorrelationConstSPtr
- Public Types inherited from CONNECTIVITYLIB::AbstractMetric
typedef QSharedPointer< AbstractMetricSPtr
typedef QSharedPointer< const AbstractMetricConstSPtr

Public Member Functions

 Correlation ()
- Public Member Functions inherited from CONNECTIVITYLIB::AbstractMetric
 AbstractMetric ()

Static Public Member Functions

static Network calculate (ConnectivitySettings &connectivitySettings)

Static Protected Member Functions

static Eigen::MatrixXd compute (const ConnectivitySettings::IntermediateTrialData &inputData)
static void reduce (Eigen::MatrixXd &resultData, const Eigen::MatrixXd &data)

Additional Inherited Members

- Static Public Attributes inherited from CONNECTIVITYLIB::AbstractMetric
static bool m_bStorageModeIsActive = false
static int m_iNumberBinStart = -1
static int m_iNumberBinAmount = -1

Detailed Description

This class computes the correlation metric.

This class computes the correlation metric.

Definition at line 81 of file correlation.h.

Inheritance diagram for CONNECTIVITYLIB::Correlation:
Inheritance graph

Member Typedef Documentation

◆ ConstSPtr

Const shared pointer type for Correlation.

Definition at line 86 of file correlation.h.

◆ SPtr

Shared pointer type for Correlation.

Definition at line 85 of file correlation.h.

Constructor & Destructor Documentation

◆ Correlation()

Correlation::Correlation ( )

Constructs a Correlation object.

Definition at line 73 of file correlation.cpp.

Member Function Documentation

◆ calculate()

Network Correlation::calculate ( ConnectivitySettings connectivitySettings)

Calculates the correlation coefficient between the rows of the data matrix.

[in]connectivitySettingsThe input data and parameters.
The connectivity information in form of a network structure.

Definition at line 79 of file correlation.cpp.

◆ compute()

MatrixXd Correlation::compute ( const ConnectivitySettings::IntermediateTrialData inputData)

Calculates the connectivity matrix for a given input data matrix based on the correlation coefficient.

[in]inputDataThe input data.
The connectivity matrix.

Definition at line 163 of file correlation.cpp.

◆ reduce()

void Correlation::reduce ( Eigen::MatrixXd &  resultData,
const Eigen::MatrixXd &  data 

Sums up (reduces) the in parallel processed connectivity matrix.

[out]resultDataThe result data.
[in]dataThe incoming, temporary result data.

Definition at line 184 of file correlation.cpp.

The documentation for this class was generated from the following files: