fiff_ctf_comp.h File Reference

CTF / 4D Neuroimaging software gradient-compensation matrix block (FIFFB_MNE_CTF_COMP_DATA). More...

#include "fiff_global.h"
#include "fiff_types.h"
#include "fiff_named_matrix.h"
#include <QSharedPointer>
#include <Eigen/Core>
#include <memory>

Include dependency graph for fiff_ctf_comp.h:

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

Go to the source code of this file.

Classes
class	FIFFLIB::FiffCtfComp
	One CTF software-gradient compensation matrix: grade kind, calibration flag and the gradiometer × reference named matrix. More...

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

Detailed Description

CTF / 4D Neuroimaging software gradient-compensation matrix block (FIFFB_MNE_CTF_COMP_DATA).

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

CTF reference-gradient compensation suppresses environmental interference by subtracting a linear combination of reference-channel signals from each gradiometer. The compensation state is stored as a list of named matrices under FIFFB_MNE_CTF_COMP / FIFFB_MNE_CTF_COMP_DATA, one matrix per supported compensation grade. FiffCtfComp is the C++ wrapper for one of those matrices: a kind tag selecting the grade, save-as-calibrated flag, and a FiffNamedMatrix whose rows are the gradiometer channel names and columns the reference channels.

Combined with the source / destination grade fields tracked in FiffInfo this lets FiffRawData::compensate move continuously recorded data between compensation grades on demand, matching the mne.io.ctf.RawCTF._comp behaviour in MNE-Python.

Definition in file fiff_ctf_comp.h.