Skip to main content

Crate bids_ieeg

Crate bids_ieeg 

Source
Expand description

Intracranial EEG (iEEG) support for BIDS datasets.

Provides typed access to iEEG-specific files including electrode positions (with size, hemisphere, group, and type), channels, events, coordinate systems, and iEEG metadata. Supports both ECoG (electrocorticography) and SEEG (stereoelectroencephalography) data.

Signal data reading is supported for all BIDS-iEEG formats (EDF, BDF, BrainVision) via IeegLayout::read_data, which delegates to the bids-eeg crate’s high-performance readers. Types like EegData, ReadOptions, and Annotation are re-exported for convenience.

See: https://bids-specification.readthedocs.io/en/stable/modality-specific-files/intracranial-electroencephalography.html

Re-exports§

pub use layout::IeegLayout;
pub use metadata::IeegMetadata;

Modules§

layout
High-level iEEG interface on top of BidsLayout.
metadata
Typed iEEG metadata from JSON sidecars.

Structs§

Annotation
A time-stamped annotation from EDF+, BDF+, or BrainVision marker files.
EegData
Raw EEG signal data read from a data file.
IeegCoordSystem
iEEG coordinate system from _coordsystem.json.
IeegElectrode
An iEEG electrode with size, hemisphere, group, and type.
IeegSummary
ReadOptions
Options for reading EEG data files.

Functions§

read_brainvision
Read EEG data from BrainVision format (.vhdr + .eeg/.dat).
read_edf
Read EEG data from an EDF (European Data Format) or BDF (BioSemi) file.
read_eeg_data
Detect format from file extension and read EEG data.
read_ieeg_electrodes