bids_raw_data.h File Reference

Central container for a BIDS raw recording — the BIDS-side analogue of FIFFLIB::FiffRawData, bundling raw signal I/O with every electrophysiology sidecar. More...

#include "bids_global.h"
#include "bids_event.h"
#include "bids_electrode.h"
#include "bids_coordinate_system.h"
#include "bids_path.h"
#include "readers/bids_abstract_format_reader.h"
#include <fiff/fiff_raw_data.h>
#include <QSharedPointer>
#include <QString>
#include <QList>
#include <QMap>

Include dependency graph for bids_raw_data.h:

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

Go to the source code of this file.

Classes
class	BIDSLIB::BidsRawData
	Central container for a BIDS raw dataset, bundling electrophysiological data with all associated sidecar metadata. More...
struct	BIDSLIB::BidsRawData::WriteOptions
	Options controlling how write() operates. More...

Namespaces
namespace	BIDSLIB
	BIDS dataset reading, writing, path construction, and sidecar metadata handling for iEEG/EEG/MEG.

Detailed Description

Central container for a BIDS raw recording — the BIDS-side analogue of FIFFLIB::FiffRawData, bundling raw signal I/O with every electrophysiology sidecar.

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.1.0

Date

March 2026

BidsRawData is the top-level object exposed by BIDSLIB: a single BidsRawData::read call walks a BIDSPath, picks the right format reader via BidsRawData::createReader, parses the raw data into a fully-populated FIFFLIB::FiffRawData, and then merges every sidecar BIDS defines for an electrophysiology recording — _channels.tsv (channel types, units, bad-channel marking), _electrodes.tsv plus _coordsystem.json (digitizer points and their reference frame), _events.tsv (trigger annotations) and the _<datatype>.json sidecar (line frequency, manufacturer, reference electrode, recording type) — into the resulting in-memory record.

BidsRawData::write reverses the process: it materialises the sub-XX/[ses-YY/]<datatype>/ tree, optionally copies the source raw file in, regenerates every TSV/JSON sidecar from the in-memory state, and emits the mandatory dataset_description.json at the root. Sidecar fields that are derivable from FiffInfo (sampling frequency, channel counts) are recomputed on write and applied on read so they cannot drift; only fields that carry information not already present in FiffInfo are stored as explicit members. The class is move-only because the embedded reader owns the open file handle of the raw recording.

Definition in file bids_raw_data.h.