fiff_named_matrix.h File Reference

Matrix paired with row and column name lists, the on-disk form of FIFFB_PROJ_ITEM / FIFFB_MNE_NAMED_MATRIX payloads. More...

#include "fiff_global.h"
#include "fiff_constants.h"
#include "fiff_types.h"
#include <Eigen/Core>
#include <QStringList>
#include <QSharedData>
#include <QSharedDataPointer>
#include <QSharedPointer>
#include <memory>

Include dependency graph for fiff_named_matrix.h:

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

Go to the source code of this file.

Classes
class	FIFFLIB::FiffNamedMatrix
	FIFF named matrix: dense / sparse Eigen matrix plus row-name and column-name string lists. More...

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

Functions
std::ostream &	FIFFLIB::operator<< (std::ostream &out, const FIFFLIB::FiffNamedMatrix &p_FiffNamedMatrix)
bool	FIFFLIB::operator== (const FiffNamedMatrix &a, const FiffNamedMatrix &b)

Detailed Description

Matrix paired with row and column name lists, the on-disk form of FIFFB_PROJ_ITEM / FIFFB_MNE_NAMED_MATRIX payloads.

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

September 2012

Several FIFF blocks store a matrix whose rows and columns refer to channel names (SSP projection vectors, CTF compensation matrices, forward gain matrices, MNE noise-covariance whiteners, ...). The on-disk representation is a FIFF_MNE_NROW + FIFF_MNE_NCOL pair plus a dense or sparse matrix tag plus two string-list tags with the row and column names. FiffNamedMatrix bundles all of that into a single object: the Eigen matrix and the two QStringList name vectors, with the same default-construction semantics as numpy.zeros + name lists in mne.SourceEstimate / mne.Forward.

Definition in file fiff_named_matrix.h.