Spectral Granger Causality estimator; directional, MVAR-based. More...

#include <granger_causality.h>

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

Public Member Functions
	GrangerCausality ()
Public Member Functions inherited from CONNECTIVITYLIB::AbstractMetric
	AbstractMetric ()

Static Public Member Functions
static Network	calculate (ConnectivitySettings &connectivitySettings)

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

Spectral Granger Causality estimator; directional, MVAR-based.

Spectral Granger Causality estimator (Geweke 1982 formulation).

For every ordered channel pair (j -> i) the estimator fits an MVAR model to the trial-concatenated time series via MvarModel and evaluates the log ratio of the unconditional and conditional spectra of X_i, GC_{j->i}(f) = ln( S_{ii}(f) / ( S_{ii}(f) - (Sigma_{jj} - Sigma_{ij}^2 / Sigma_{ii}) * |H_{ij}(f)|^2 ) ). The resulting Network is directional and stores the band-averaged GC value as edge weight.

Since: 2.2.0

Definition at line 94 of file granger_causality.h.

Inheritance diagram for CONNECTIVITYLIB::GrangerCausality:

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for GrangerCausality.

Definition at line 99 of file granger_causality.h.

◆ SPtr

typedef QSharedPointer<GrangerCausality> CONNECTIVITYLIB::GrangerCausality::SPtr

Shared pointer type for GrangerCausality.

Definition at line 98 of file granger_causality.h.

Constructor & Destructor Documentation

◆ GrangerCausality()

GrangerCausality::GrangerCausality ( )

explicit

Constructs a GrangerCausality object.

Definition at line 51 of file granger_causality.cpp.

Member Function Documentation

◆ calculate()

Network GrangerCausality::calculate ( ConnectivitySettings & connectivitySettings )

static

Calculates spectral Granger causality between all channel pairs.

Parameters

[in] connectivitySettings The input data and parameters.

Returns: The connectivity information in form of a network structure.

Since: 2.2.0

Definition at line 57 of file granger_causality.cpp.

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

src/libraries/connectivity/metrics/granger_causality.h
src/libraries/connectivity/metrics/granger_causality.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members