fiff_explain.h File Reference

Static lookup table mapping every documented FIFF tag kind to a fixed-width human-readable label, used by the FIFF dumper / show_fiff tool. More...

#include "fiff_types.h"
#include "fiff_file.h"

Include dependency graph for fiff_explain.h:

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

Go to the source code of this file.

Classes
struct	FIFFLIB::FiffExplainEntry
	FIFF tag explanation entry: pairs a FIFF_* tag kind with the fixed-width label printed by show_fiff. More...

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

Detailed Description

Static lookup table mapping every documented FIFF tag kind to a fixed-width human-readable label, used by the FIFF dumper / show_fiff tool.

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

Author

Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org; Lorenz Esch loren.nosp@m.z.es.nosp@m.ch@tu.nosp@m.-ilm.nosp@m.enau..nosp@m.de; Ruben Doerfel doerf.nosp@m.elru.nosp@m.ben@a.nosp@m.ol.c.nosp@m.om; Andreas Griesshammer ag@fi.nosp@m.eldl.nosp@m.inein.nosp@m.c.co.nosp@m.m; 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

December 2016

Mirrors the _fiff_explanations table in MNE-C's fiff_explain.c and the mne.io.show_fiff helper in MNE-Python: a flat array of (kind, text) pairs that the show_fiff diagnostic walks to print a FIFF directory in a human-readable column layout. The text fields are padded to a constant width so the resulting columns align without post-processing.

Kept in-header (and static inside namespace FIFFLIB) so callers can include it from a single translation unit (typically the mne_show_fiff helper). Add new entries here when a new FIFF_* tag kind is introduced in fiff_constants.h / fiff_file.h so that the dumper does not show the new kind as a bare numeric code.

Definition in file fiff_explain.h.