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

Classes
struct	BidsChannel
	Channel metadata record corresponding to one row in *_channels.tsv. More...
struct	BidsCoordinateSystem
	Coordinate system metadata from *_coordsystem.json. More...
struct	BidsDatasetDescription
	Dataset-level metadata from dataset_description.json. More...
struct	BidsElectrode
	Electrode position record corresponding to one row in *_electrodes.tsv. More...
struct	BidsEvent
	Single event annotation, typically parsed from or written to *_events.tsv. More...
class	BIDSPath
	BIDS-compliant path and filename construction. More...
class	BidsRawData
	Central container for a BIDS raw dataset, bundling electrophysiological data with all associated sidecar metadata. More...
class	BidsTsv
	Generic BIDS TSV file I/O. More...
class	AbstractFormatReader
	The AbstractFormatReader class provides a common interface for reading raw neurophysiology data from various file formats (EDF, BrainVision, etc.) used in BIDS datasets. More...
struct	BrainVisionMarker
	Marker entry from the .vmrk file. More...
struct	BrainVisionChannelInfo
	Channel info from the .vhdr header. More...
class	BrainVisionReader
	The BrainVisionReader reads BrainVision file triplets (.vhdr/.vmrk/.eeg) and exposes them through the AbstractFormatReader interface. More...
struct	EDFChannelInfo
	Channel-level metadata from the EDF header. More...
class	EDFReader
	The EDFReader reads European Data Format (EDF/EDF+) files and exposes them through the AbstractFormatReader interface. More...

Typedefs
using	BidsTsvRow = QMap<QString, QString>

Enumerations
enum class	BVBinaryFormat { INT_16 , INT_32 , IEEE_FLOAT_32 }
	Binary format enumeration for BrainVision data files. More...
enum class	BVOrientation { MULTIPLEXED , VECTORIZED }
	Data orientation enumeration. More...

Functions
QStringList	allowedElectrophysiologyDatatypes ()
QStringList	allowedDatatypes ()
QStringList	ieegAllowedExtensions ()
QStringList	eegAllowedExtensions ()
QMap< int, QString >	fiffKindToBidsType ()
QMap< QString, int >	bidsTypeToFiffKind ()
QMap< QString, int >	bidsCoordToFiffFrame ()
QMap< int, QString >	fiffFrameToBidsCoord ()
QStringList	ieegAllowedCoordSystems ()
QStringList	bidsEntityOrder ()
BIDSSHARED_EXPORT const char *	buildDateTime ()
BIDSSHARED_EXPORT const char *	buildHash ()
BIDSSHARED_EXPORT const char *	buildHashLong ()
bool	operator== (const BIDSPath &a, const BIDSPath &b)

Variables
const QString	BIDS_DATATYPE_MEG = QStringLiteral("meg")
const QString	BIDS_DATATYPE_EEG = QStringLiteral("eeg")
const QString	BIDS_DATATYPE_IEEG = QStringLiteral("ieeg")
const QString	BIDS_DATATYPE_ANAT = QStringLiteral("anat")
const QString	BIDS_DATATYPE_FUNC = QStringLiteral("func")
const QString	BIDS_DATATYPE_DWI = QStringLiteral("dwi")
const QString	BIDS_DATATYPE_PERF = QStringLiteral("perf")
const QString	BIDS_DATATYPE_BEH = QStringLiteral("beh")

Detailed Description

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

Typedef Documentation

◆ BidsTsvRow

using BIDSLIB::BidsTsvRow = QMap<QString, QString>

Represents a single row of a BIDS TSV file as a column-name → value map.

Definition at line 54 of file bids_tsv.h.

Enumeration Type Documentation

◆ BVBinaryFormat

enum class BIDSLIB::BVBinaryFormat

strong

Binary format enumeration for BrainVision data files.

Enumerator
INT_16
INT_32
IEEE_FLOAT_32

Definition at line 97 of file bids_brain_vision_reader.h.

◆ BVOrientation

enum class BIDSLIB::BVOrientation

strong

Data orientation enumeration.

Enumerator
MULTIPLEXED
VECTORIZED

Definition at line 108 of file bids_brain_vision_reader.h.

Function Documentation

◆ allowedDatatypes()

QStringList BIDSLIB::allowedDatatypes ( )

inline

All allowed BIDS datatypes.

Returns: List of all supported BIDS datatype strings (electrophysiology, imaging, and behavioral).

Definition at line 77 of file bids_const.h.

◆ allowedElectrophysiologyDatatypes()

QStringList BIDSLIB::allowedElectrophysiologyDatatypes ( )

inline

All allowed BIDS electrophysiology datatypes.

Returns: List containing the "meg", "eeg", and "ieeg" datatype strings.

Definition at line 67 of file bids_const.h.

◆ bidsCoordToFiffFrame()

QMap< QString, int > BIDSLIB::bidsCoordToFiffFrame ( )

inline

Maps BIDS coordinate system names to FIFF coordinate frame constants. Used for electrodes.tsv / coordsystem.json handling.

Returns: Map from BIDS coordinate system name to FIFF coordinate frame; unknown systems map to FIFFV_COORD_UNKNOWN.

Definition at line 179 of file bids_const.h.

◆ bidsEntityOrder()

QStringList BIDSLIB::bidsEntityOrder ( )

inline

Entity key ordering for BIDS filenames (per specification).

Returns: Entity keys (e.g. "sub", "ses", "task") in the order they must appear in a filename.

Definition at line 244 of file bids_const.h.

◆ bidsTypeToFiffKind()

QMap< QString, int > BIDSLIB::bidsTypeToFiffKind ( )

inline

Maps BIDS channel type strings back to FIFF channel kind constants. Reference: BIDS specification Appendix VII.

Returns: Map from BIDS channel type (e.g. "SEEG") to FIFF channel kind (e.g. FIFFV_SEEG_CH).

Definition at line 150 of file bids_const.h.

◆ buildDateTime()

const char * BIDSLIB::buildDateTime ( )

Returns build date and time.

Returns: Null-terminated string with the library build date and time.

Definition at line 23 of file bids_global.cpp.

◆ buildHash()

const char * BIDSLIB::buildHash ( )

Returns abbreviated build git hash.

Returns: Null-terminated string with the short git commit hash of the build.

Definition at line 30 of file bids_global.cpp.

◆ buildHashLong()

const char * BIDSLIB::buildHashLong ( )

Returns full build git hash.

Returns: Null-terminated string with the full git commit hash of the build.

Definition at line 37 of file bids_global.cpp.

◆ eegAllowedExtensions()

QStringList BIDSLIB::eegAllowedExtensions ( )

inline

Supported raw data file extensions for EEG in BIDS.

Returns: List of lowercase extensions including the leading dot (e.g. ".vhdr", ".bdf").

Definition at line 107 of file bids_const.h.

◆ fiffFrameToBidsCoord()

QMap< int, QString > BIDSLIB::fiffFrameToBidsCoord ( )

inline

Maps FIFF coordinate frame constants to BIDS coordinate system names.

Returns: Map from FIFF coordinate frame to the BIDS coordinate system name written for it.

Definition at line 198 of file bids_const.h.

◆ fiffKindToBidsType()

QMap< int, QString > BIDSLIB::fiffKindToBidsType ( )

inline

Maps FIFF channel kind constants to BIDS channel type strings. Reference: BIDS specification Appendix VII.

Returns: Map from FIFF channel kind (e.g. FIFFV_EEG_CH) to BIDS channel type (e.g. "EEG").

Definition at line 126 of file bids_const.h.

◆ ieegAllowedCoordSystems()

QStringList BIDSLIB::ieegAllowedCoordSystems ( )

inline

Allowed coordinate systems for iEEG electrodes (BIDS-iEEG spec).

Returns: List of coordinate system names accepted in an iEEG coordsystem.json.

Definition at line 217 of file bids_const.h.

◆ ieegAllowedExtensions()

QStringList BIDSLIB::ieegAllowedExtensions ( )

inline

Supported raw data file extensions for iEEG in BIDS.

Returns: List of lowercase extensions including the leading dot (e.g. ".vhdr", ".edf").

Definition at line 93 of file bids_const.h.

◆ operator==()

bool BIDSLIB::operator==	(	const BIDSPath &	a,
		const BIDSPath &	b )

inline

Definition at line 392 of file bids_path.h.

Variable Documentation

◆ BIDS_DATATYPE_ANAT

const QString BIDSLIB::BIDS_DATATYPE_ANAT = QStringLiteral("anat")

Definition at line 56 of file bids_const.h.

◆ BIDS_DATATYPE_BEH

const QString BIDSLIB::BIDS_DATATYPE_BEH = QStringLiteral("beh")

Definition at line 60 of file bids_const.h.

◆ BIDS_DATATYPE_DWI

const QString BIDSLIB::BIDS_DATATYPE_DWI = QStringLiteral("dwi")

Definition at line 58 of file bids_const.h.

◆ BIDS_DATATYPE_EEG

const QString BIDSLIB::BIDS_DATATYPE_EEG = QStringLiteral("eeg")

Definition at line 54 of file bids_const.h.

◆ BIDS_DATATYPE_FUNC

const QString BIDSLIB::BIDS_DATATYPE_FUNC = QStringLiteral("func")

Definition at line 57 of file bids_const.h.

◆ BIDS_DATATYPE_IEEG

const QString BIDSLIB::BIDS_DATATYPE_IEEG = QStringLiteral("ieeg")

Definition at line 55 of file bids_const.h.

◆ BIDS_DATATYPE_MEG

const QString BIDSLIB::BIDS_DATATYPE_MEG = QStringLiteral("meg")

BIDS datatype strings used in directory and filename construction.

Definition at line 53 of file bids_const.h.

◆ BIDS_DATATYPE_PERF

const QString BIDSLIB::BIDS_DATATYPE_PERF = QStringLiteral("perf")

Definition at line 59 of file bids_const.h.

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ BidsTsvRow

Enumeration Type Documentation

◆ BVBinaryFormat

◆ BVOrientation

Function Documentation

◆ allowedDatatypes()

◆ allowedElectrophysiologyDatatypes()

◆ bidsCoordToFiffFrame()

◆ bidsEntityOrder()

◆ bidsTypeToFiffKind()

◆ buildDateTime()

◆ buildHash()

◆ buildHashLong()

◆ eegAllowedExtensions()

◆ fiffFrameToBidsCoord()

◆ fiffKindToBidsType()

◆ ieegAllowedCoordSystems()

◆ ieegAllowedExtensions()

◆ operator==()

Variable Documentation

◆ BIDS_DATATYPE_ANAT

◆ BIDS_DATATYPE_BEH

◆ BIDS_DATATYPE_DWI

◆ BIDS_DATATYPE_EEG

◆ BIDS_DATATYPE_FUNC

◆ BIDS_DATATYPE_IEEG

◆ BIDS_DATATYPE_MEG

◆ BIDS_DATATYPE_PERF