abstractmetric.h File Reference

Common static knobs shared by every functional-connectivity estimator in CONNECTIVITYLIB. More...

#include "../connectivity_global.h"
#include <QSharedPointer>
#include <QVector>
#include <Eigen/Core>

Include dependency graph for abstractmetric.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	CONNECTIVITYLIB::AbstractMetric
	Static control knobs (storage mode, frequency band) shared by all CONNECTIVITYLIB metrics. More...

Namespaces
namespace	CONNECTIVITYLIB
	Functional connectivity metrics (coherence, PLV, cross-correlation, etc.).

Detailed Description

Common static knobs shared by every functional-connectivity estimator in CONNECTIVITYLIB.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2018-2026 MNE-CPP Authors

Author

Lorenz Esch loren.nosp@m.z.es.nosp@m.ch@tu.nosp@m.-ilm.nosp@m.enau..nosp@m.de; Gabriel Motta gabri.nosp@m.elbe.nosp@m.nmott.nosp@m.a@gm.nosp@m.ail.c.nosp@m.om; Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org

Since

0.1.0

Date

January 2018

Every metric in CONNECTIVITYLIB (Coherence, Imaginary Coherence, PLI, wPLI, dwPLI, USPLI, PLV, cross-correlation, Granger Causality, DTF, PDC) reads the same global control flags from AbstractMetric so that the dispatcher in Connectivity can decide once - before any FFT runs - whether intermediate per-trial spectra should be cached for reuse (storage mode) and which frequency-bin window the metrics should average over.

The frequency-bin window is expressed as [m_iNumberBinStart, m_iNumberBinStart + m_iNumberBinAmount). All metrics collapse the spectral output to a single scalar per channel pair by averaging the magnitude (or squared magnitude, depending on the metric) over exactly this window, so callers select an EEG band (e.g. alpha 8-12 Hz) once and every estimator returns a comparable band-limited connectivity matrix.

Definition in file abstractmetric.h.