fiff_cov.h File Reference

Noise / data covariance matrix as stored under FIFFB_MNE_COV, with channel names, kind, projector list and rank info. More...

#include "fiff_global.h"
#include "fiff_proj.h"
#include "fiff_types.h"
#include "fiff_info.h"
#include <QSharedDataPointer>
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <Eigen/Core>
#include <memory>

Include dependency graph for fiff_cov.h:

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

Go to the source code of this file.

Classes
class	FIFFLIB::FiffCov
	FIFF noise / data covariance: matrix, channel names, kind, applied projectors, bads, dof and optional whitening eigendecomposition. More...

Namespaces
namespace	FIFFLIB
	FIFF file I/O, in-memory data structures and high-level readers/writers.

Macros
#define	metatype_fiffcovsptr
#define	metatype_fiffcov

Functions
std::ostream &	FIFFLIB::operator<< (std::ostream &out, const FIFFLIB::FiffCov &p_FiffCov)
	Q_DECLARE_METATYPE (QSharedPointer< FIFFLIB::FiffCov >)
	Q_DECLARE_METATYPE (FIFFLIB::FiffCov)

Detailed Description

Noise / data covariance matrix as stored under FIFFB_MNE_COV, with channel names, kind, projector list and rank info.

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

Author

Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org; Christof Pieloth pielo.nosp@m.th@l.nosp@m.abp.h.nosp@m.twk-.nosp@m.leipz.nosp@m.ig.d.nosp@m.e; Lorenz Esch loren.nosp@m.z.es.nosp@m.ch@tu.nosp@m.-ilm.nosp@m.enau..nosp@m.de; Juan GPC jgarc.nosp@m.iapr.nosp@m.ieto@.nosp@m.mgh..nosp@m.harva.nosp@m.rd.e.nosp@m.du; Gabriel Motta gabri.nosp@m.elbe.nosp@m.nmott.nosp@m.a@gm.nosp@m.ail.c.nosp@m.om

Since

0.1.0

Date

October 2012

FiffCov is the C++ counterpart of MNE-Python's mne.Covariance. It holds the (typically channel × channel) covariance matrix, the channel-name list it is indexed by, the kind tag (FIFFV_MNE_NOISE_COV / FIFFV_MNE_SOURCE_COV / ...), the diagonal flag, the projector list that was active when the covariance was estimated (FiffProj), the bad-channel list, the nfree degrees of freedom and an optional pre-whitening eigendecomposition. The class is what FiffStream reads from / writes to *-cov.fif files and what the source-localization pipeline consumes to whiten the forward gain matrix and the measurement data.

Definition in file fiff_cov.h.

Macro Definition Documentation

metatype_fiffcov

#define metatype_fiffcov

Definition at line 374 of file fiff_cov.h.

metatype_fiffcovsptr

#define metatype_fiffcovsptr

Definition at line 369 of file fiff_cov.h.

Function Documentation

Q_DECLARE_METATYPE() [1/2]

Q_DECLARE_METATYPE

(

FIFFLIB::FiffCov

)

Provides QT META type declaration of the FIFFLIB::FiffCov type. For signal/slot usage.

Q_DECLARE_METATYPE() [2/2]

Q_DECLARE_METATYPE

(

QSharedPointer< FIFFLIB::FiffCov >

)

Provides QT META type declaration of the QSharedPointer<FIFFLIB::FiffCov> type. For signal/slot usage.