connectivity.h File Reference

Front-end dispatcher that runs the requested connectivity metrics over a ConnectivitySettings batch. More...

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

Include dependency graph for connectivity.h:

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

Go to the source code of this file.

Classes
class	CONNECTIVITYLIB::Connectivity
	Runs the selected functional-connectivity metrics over a ConnectivitySettings batch. More...

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

Detailed Description

Front-end dispatcher that runs the requested connectivity metrics over a ConnectivitySettings batch.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2017-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

March 2017

Connectivity is the single entry point used by GUI plugins (rtfwd, connectivity-estimator) and the mne_dipole_fit / batch tools to compute one or more functional-connectivity estimates from the same set of trials. The caller fills a ConnectivitySettings object with the trial data, sampling frequency, FFT length, taper window, source/sensor node positions, and the list of method names ("COH", "IMAGCOH", "PLI", "WPLI", "DSWPLI", "USPLI", "PLV", "COR", "XCOR", "GC", "DTF", "PDC"), and Connectivity::calculate dispatches to the corresponding metric implementations and returns one Network per method.

Trial preprocessing (DPSS tapering, FFT, cross- and auto-spectral sums) is cached in the shared ConnectivitySettings::IntermediateSumData so that running several metrics over the same data set does not recompute the FFTs - the dispatcher therefore amortises the spectral cost across all selected estimators in a single pass.

Definition in file connectivity.h.