connectivitysettings.h File Reference

Input-data and parameter container shared by every functional-connectivity metric in CONNECTIVITYLIB. More...

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

Include dependency graph for connectivitysettings.h:

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

Go to the source code of this file.

Classes
class	CONNECTIVITYLIB::ConnectivitySettings
	Aggregates trial data, spectral cache and node geometry shared by all CONNECTIVITYLIB metrics. More...
struct	CONNECTIVITYLIB::ConnectivitySettings::IntermediateTrialData
	Per-trial intermediate frequency-domain data used during connectivity computation. More...
struct	CONNECTIVITYLIB::ConnectivitySettings::IntermediateSumData
	Accumulated cross-spectral and auto-spectral sums across trials for final metric normalization. More...

Namespaces
namespace	MNELIB
	Core MNE data structures (source spaces, source estimates, hemispheres).
namespace	FSLIB
	FreeSurfer surface, annotation and parcellation I/O for mne-cpp.
namespace	FIFFLIB
	FIFF file I/O, in-memory data structures and high-level readers/writers.
namespace	CONNECTIVITYLIB
	Functional connectivity metrics (coherence, PLV, cross-correlation, etc.).

Macros
#define	metatype_connectivitysettings

Detailed Description

Input-data and parameter container shared by every functional-connectivity metric in CONNECTIVITYLIB.

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; Daniel Strohmeier danie.nosp@m.l.st.nosp@m.rohme.nosp@m.ier@.nosp@m.gmail.nosp@m..com; 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

ConnectivitySettings carries the per-trial time-domain matrices, the derived per-trial cross-spectral data (DPSS tapered FFTs, CSDs and the imaginary-part variants needed by PLI / wPLI / dwPLI), and the accumulated cross-trial sums used to normalise the final estimates. Holding all of this in one object lets the dispatcher in Connectivity compute several metrics in one pass without re-tapering and re-FFT'ing the same trials: the IntermediateTrialData fields are filled lazily by the first metric that needs them and reused by everyone else.

The container also stores the spectral-domain parameters (sampling rate, FFT length, taper window name) and the 3D node positions used to lay out the resulting Network - the latter can be sourced either from a FiffInfo channel set (sensor space) or from a forward solution and FsSurfaceSet pair (source space).

Definition in file connectivitysettings.h.

Macro Definition Documentation

metatype_connectivitysettings

#define metatype_connectivitysettings

Definition at line 205 of file connectivitysettings.h.