fiff_io.h File Reference

High-level convenience reader/writer that loads a whole FIFF measurement file into FIFFLIB containers in one call. More...

#include "fiff_global.h"
#include "fiff_info.h"
#include "fiff_types.h"
#include "fiff_raw_data.h"
#include "fiff_evoked.h"
#include "fiff_stream.h"
#include <QList>
#include <QFile>
#include <QIODevice>
#include <QSharedPointer>
#include <QDebug>

Include dependency graph for fiff_io.h:

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

Go to the source code of this file.

Classes
class	FiffIO

Detailed Description

High-level convenience reader/writer that loads a whole FIFF measurement file into FIFFLIB containers in one call.

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

Author

Florian Schlembach fschl.nosp@m.emba.nosp@m.ch@we.nosp@m.b.de; 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; 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

November 2013

Most callers want to open a FIFF file and immediately get back a FiffRawData (for *-raw.fif''), a @ref FiffEvokedSet (for *-ave.fif''), a FiffCov (for ``*-cov.fif''), or the appropriate combination without micromanaging FiffStream and the directory tree. FiffIO provides exactly that one-call facade: it sniffs the top-level FIFF blocks (FIFFB_RAW_DATA, FIFFB_EVOKED, FIFFB_MNE_COV, ...), invokes the matching specialized reader and exposes the results as ready-to-use shared pointers, with parity to the mne.io.read_raw_fif / mne.read_evokeds / mne.read_cov front-end of MNE-Python. */

---

INCLUDES

---

QT INCLUDES

---

DEFINE NAMESPACE FIFFLIB

namespace FIFFLIB {

---

/**

One-call FIFF reader/writer: opens a file, dispatches to the right specialized loader and returns ready-to-use FIFFLIB containers.

Sniffs the FIFF block tree, dispatches FiffRawData / FiffEvokedSet / FiffCov / FiffInfo loaders as appropriate, and returns shared pointers so the resulting objects can be freely passed across the rest of the pipeline. Front-end parity with mne.io.read_raw_fif and friends.

Definition in file fiff_io.h.