v2.0.0
Loading...
Searching...
No Matches
mne_cov_matrix.h File Reference

Legacy MNE-C noise covariance container preserved for cross-toolchain compatibility. More...

#include "mne_global.h"
#include <Eigen/Core>
#include <memory>
#include <QSharedPointer>
#include <QStringList>
Include dependency graph for mne_cov_matrix.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  MNELIB::MNECovMatrix
 Covariance matrix storage. More...

Namespaces

namespace  FIFFLIB
 FIFF file I/O, in-memory data structures and high-level readers/writers.
namespace  MNELIB
 Core MNE data structures (source spaces, source estimates, hemispheres).

Variables

constexpr auto MNE_COV_CH_UNKNOWN = -1
constexpr auto MNE_COV_CH_MEG_MAG = 0
constexpr auto MNE_COV_CH_MEG_GRAD = 1
constexpr auto MNE_COV_CH_EEG = 2

Detailed Description

Legacy MNE-C noise covariance container preserved for cross-toolchain compatibility.

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

Author
Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org
Since
2.0.0
Date
March 2026

MNELIB::MNECovMatrix mirrors the mneCovMatrixRec struct of the original MNE C tooling: a dense or diagonal noise covariance kept as a vector plus eigen-decomposition, used internally by routines ported verbatim from mne_inverse_operator. New code should prefer FIFFLIB::FiffCov; this class exists so legacy algorithms can be translated without rewriting their algebra.

Definition in file mne_cov_matrix.h.

Variable Documentation

◆ MNE_COV_CH_EEG

auto MNE_COV_CH_EEG = 2
inlineconstexpr

EEG [V].

Definition at line 54 of file mne_cov_matrix.h.

◆ MNE_COV_CH_MEG_GRAD

auto MNE_COV_CH_MEG_GRAD = 1
inlineconstexpr

Planar gradiometer [T/m].

Definition at line 53 of file mne_cov_matrix.h.

◆ MNE_COV_CH_MEG_MAG

auto MNE_COV_CH_MEG_MAG = 0
inlineconstexpr

Axial gradiometer or magnetometer [T].

Definition at line 52 of file mne_cov_matrix.h.

◆ MNE_COV_CH_UNKNOWN

auto MNE_COV_CH_UNKNOWN = -1
inlineconstexpr

Channel-type classification constants for the ch_class field in MNECovMatrix. Unknown channel type.

Definition at line 51 of file mne_cov_matrix.h.