bids_electrode.h File Reference

Reader/writer for the BIDS _electrodes.tsv sidecar plus a bridge into FIFF digitizer-point space. More...

#include "bids_global.h"
#include <fiff/fiff_dig_point.h>
#include <fiff/fiff_dig_point_set.h>
#include <fiff/fiff_coord_trans.h>
#include <QString>
#include <QList>

Include dependency graph for bids_electrode.h:

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

Go to the source code of this file.

Classes
struct	BIDSLIB::BidsElectrode
	Electrode position record corresponding to one row in *_electrodes.tsv. More...

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

Detailed Description

Reader/writer for the BIDS _electrodes.tsv sidecar plus a bridge into FIFF digitizer-point space.

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

_electrodes.tsv lists one row per implanted/positioned electrode with REQUIRED name and x / y / z coordinates plus optional size / type / material / impedance metadata. Coordinates are interpreted in the frame named by the sibling _coordsystem.json (see BidsCoordinateSystem) using the unit declared there.

BidsElectrode::toFiffDigPoints converts a list of records into a FIFFLIB::FiffDigPointSet of EEG digitizer points so the rest of MNE-CPP — channel registration, forward modelling, 3-D rendering — can consume BIDS electrodes through the same interface it uses for FIFF digitization. An optional FiffCoordTrans is applied while converting so callers can request the points directly in head coordinates. Rows whose coordinate columns are n/a are silently dropped.

Spec: https://bids-specification.readthedocs.io/en/stable/modality-specific-files/electrophysiology.html#electrodes-description

Definition in file bids_electrode.h.