CONNECTIVITYLIB::Coherency Class Reference

Complex coherency core; produces magnitude-squared and imaginary-part reductions for downstream metrics. More...

#include <coherency.h>

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

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

Static Public Member Functions
static void	calculateAbs (Network &finalNetwork, ConnectivitySettings &connectivitySettings)
static void	calculateImag (Network &finalNetwork, 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

Complex coherency core; produces magnitude-squared and imaginary-part reductions for downstream metrics.

Shared core of the coherence / imaginary-coherence family.

compute fills the per-trial DPSS spectra and accumulates the cross- and auto-spectral sums in ConnectivitySettings::IntermediateSumData. The two public reductions then collapse the complex coherency to a real scalar per channel pair: calculateAbs returns |Coh_{xy}(f)|^2 (classical magnitude-squared coherence, symmetric, sensitive to zero-lag mixing) and calculateImag returns |Im(Coh_{xy}(f))|, the volume-conduction-robust imaginary coherence of Nolte et al. (2004).

Definition at line 93 of file coherency.h.

Inheritance diagram for CONNECTIVITYLIB::Coherency:

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for Coherency.

Definition at line 98 of file coherency.h.

SPtr

typedef QSharedPointer<Coherency> CONNECTIVITYLIB::Coherency::SPtr

Shared pointer type for Coherency.

Definition at line 97 of file coherency.h.

Constructor & Destructor Documentation

Coherency()

Coherency::Coherency ( )

explicit

Constructs a Coherency object.

Definition at line 56 of file coherency.cpp.

Member Function Documentation

calculateAbs()

void Coherency::calculateAbs ( Network & finalNetwork, ConnectivitySettings & connectivitySettings )

static

Calculates the absolute value of coherency of the rows of the data matrix.

Parameters

[out]	finalNetwork	The resulting network.
[in]	connectivitySettings	The input data and parameters.

Definition at line 62 of file coherency.cpp.

calculateImag()

void Coherency::calculateImag ( Network & finalNetwork, ConnectivitySettings & connectivitySettings )

static

Calculates the imaginary part of coherency of the rows of the data matrix.

Parameters

[out]	finalNetwork	The resulting network.
[in]	connectivitySettings	The input data and parameters.

Definition at line 133 of file coherency.cpp.

---

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

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