fiff_dir_node.h File Reference

Recursive node of the parsed FIFF block tree (FIFFB_* hierarchy with directory entries and children). More...

#include "fiff_global.h"
#include "fiff_constants.h"
#include "fiff_types.h"
#include "fiff_dir_entry.h"
#include "fiff_id.h"
#include <QList>
#include <QSharedPointer>
#include <QStringList>
#include <memory>

Include dependency graph for fiff_dir_node.h:

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

Go to the source code of this file.

Classes
class	FIFFLIB::FiffDirNode
	Recursive FIFF block-tree node: block kind, block ID, directly contained directory entries and child sub-blocks. More...

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

Detailed Description

Recursive node of the parsed FIFF block tree (FIFFB_* hierarchy with directory entries and children).

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2017-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; Juan GPC jgarc.nosp@m.iapr.nosp@m.ieto@.nosp@m.mgh..nosp@m.harva.nosp@m.rd.e.nosp@m.du; 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

January 2017

A FIFF file is a flat tag stream bracketed by FIFFB_BLOCK_START / FIFFB_BLOCK_END markers. FiffDirNode is the tree the stream parser produces from those brackets: each node owns its block kind, its FiffId, the list of FiffDirEntry records that live directly inside its block, and a list of child FiffDirNode sub-blocks. Together with the random-access directory at the tail of the file this lets every downstream reader (FiffRawData, FiffEvoked, FiffInfo, FiffCov, ...) navigate to its block of interest with one call to FiffDirNode::dir_tree_find rather than rescanning the tag stream.

Mirrors the dir_tree object returned by mne.io.tree.dir_tree_find in MNE-Python so the same FIFFB_* search patterns can be used in both implementations.

Definition in file fiff_dir_node.h.