CONNECTIVITYLIB::Correlation Class Reference

Pearson correlation estimator; broadband, zero-lag time-domain baseline. More...

#include <correlation.h>

Public Types
typedef QSharedPointer< Correlation >	SPtr
typedef QSharedPointer< const Correlation >	ConstSPtr
Public Types inherited from CONNECTIVITYLIB::AbstractMetric
typedef QSharedPointer< AbstractMetric >	SPtr
typedef QSharedPointer< const AbstractMetric >	ConstSPtr

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

Pearson correlation estimator; broadband, zero-lag time-domain baseline.

Computes the trial-averaged Pearson correlation coefficient between every channel pair from the raw time-domain trial data.

Per-trial correlation matrices are computed in parallel via QtConcurrent::mappedReduced and summed in reduce. The result is a symmetric matrix in [-1, 1]; it is broadband, zero-lag and does not reject volume conduction, so it is mainly useful as a baseline against the spectral and phase-based estimators.

Definition at line 88 of file correlation.h.

Inheritance diagram for CONNECTIVITYLIB::Correlation:

Member Typedef Documentation

ConstSPtr

typedef QSharedPointer<const Correlation> CONNECTIVITYLIB::Correlation::ConstSPtr

Const shared pointer type for Correlation.

Definition at line 93 of file correlation.h.

SPtr

typedef QSharedPointer<Correlation> CONNECTIVITYLIB::Correlation::SPtr

Shared pointer type for Correlation.

Definition at line 92 of file correlation.h.

Constructor & Destructor Documentation

Correlation()

Correlation::Correlation ( )

explicit

Constructs a Correlation object.

Definition at line 53 of file correlation.cpp.

Member Function Documentation

calculate()

Network Correlation::calculate ( ConnectivitySettings & connectivitySettings )

static

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

Parameters

[in]

connectivitySettings

The input data and parameters.

Returns

The connectivity information in form of a network structure.

Definition at line 59 of file correlation.cpp.

compute()

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

staticprotected

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

Parameters

[in]

inputData

The input data.

Returns

The connectivity matrix.

Definition at line 143 of file correlation.cpp.

reduce()

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

staticprotected

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

Parameters

[out]	resultData	The result data.
[in]	data	The incoming, temporary result data.

Definition at line 164 of file correlation.cpp.

---

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

• src/libraries/connectivity/metrics/correlation.h
• src/libraries/connectivity/metrics/correlation.cpp