v2.0.0
Loading...
Searching...
No Matches
fiff_annotations.h File Reference

FIFF / MNE annotations: time-tagged textual marks (BAD_*, EDGE, custom) with onset, duration and description. More...

#include "fiff_global.h"
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <QVariantMap>
#include <QVector>
Include dependency graph for fiff_annotations.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  FIFFLIB::FiffAnnotation
 One FIFF / MNE annotation: onset (s), duration (s) and description string. More...
class  FIFFLIB::FiffAnnotations
 Container for FiffAnnotation entries with FIFF, JSON and CSV serializers. More...

Namespaces

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

Detailed Description

FIFF / MNE annotations: time-tagged textual marks (BAD_*, EDGE, custom) with onset, duration and description.

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

Author
Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org
Since
2.2.0
Date
April 2026

Annotations are time-localized comments attached to a continuous recording: rejected segments (BAD_*''), recording edges (EDGE''), and arbitrary user-supplied marks. MNE-Python stores them as the mne.Annotations type and writes them under FIFFB_MNE_ANNOTATIONS; this header is the C++ mirror.

FiffAnnotation is one entry (onset in seconds since the recording start, duration, description string), FiffAnnotations is the container; together they expose JSON and CSV serialization so the same annotations can be exchanged with external tools that do not speak FIFF (eg. BIDS sidecar files).

Definition in file fiff_annotations.h.