CONNECTIVITYLIB::Coherence Class Reference

Magnitude-squared coherence estimator (symmetric, sensitive to zero-lag coupling). More...

#include <coherence.h>

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

Public Member Functions
	Coherence ()
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

Magnitude-squared coherence estimator (symmetric, sensitive to zero-lag coupling).

Computes magnitude-squared coherence between every pair of channels.

The actual cross-spectral and auto-spectral accumulation is shared with Coherency; this class only wraps the absolute-value branch and exposes a single calculate entry point that returns a Network whose edge weights are the band-averaged |coherency|^2 values in [0, 1].

Definition at line 89 of file coherence.h.

Inheritance diagram for CONNECTIVITYLIB::Coherence:

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for Coherence.

Definition at line 94 of file coherence.h.

SPtr

typedef QSharedPointer<Coherence> CONNECTIVITYLIB::Coherence::SPtr

Shared pointer type for Coherence.

Definition at line 93 of file coherence.h.

Constructor & Destructor Documentation

Coherence()

Coherence::Coherence ( )

explicit

Constructs a Coherence object.

Definition at line 55 of file coherence.cpp.

Member Function Documentation

calculate()

Network Coherence::calculate ( ConnectivitySettings & connectivitySettings )

static

Calculates the coherence 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 61 of file coherence.cpp.

---

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

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