BIDSLIB::BidsElectrode Struct Reference

Electrode position record corresponding to one row in *_electrodes.tsv. More...

#include <bids_electrode.h>

Static Public Member Functions
static QList< BidsElectrode >	readTsv (const QString &sFilePath)
	Read a BIDS *_electrodes.tsv file.
static bool	writeTsv (const QString &sFilePath, const QList< BidsElectrode > &electrodes)
	Write a BIDS *_electrodes.tsv file.
static FIFFLIB::FiffDigPointSet	toFiffDigPoints (const QList< BidsElectrode > &electrodes, const FIFFLIB::FiffCoordTrans &trans=FIFFLIB::FiffCoordTrans())
	Convert a list of BIDS electrodes to a FIFF digitizer point set.

Public Attributes
QString	name
QString	x
QString	y
QString	z
QString	size
QString	type
QString	material
QString	impedance

Detailed Description

Electrode position record corresponding to one row in *_electrodes.tsv.

Definition at line 70 of file bids_electrode.h.

Member Function Documentation

readTsv()

QList< BidsElectrode > BidsElectrode::readTsv ( const QString & sFilePath )

static

Read a BIDS *_electrodes.tsv file.

Parameters

[in]

sFilePath

Path to the electrodes.tsv file.

Returns

List of electrode records.

Definition at line 68 of file bids_electrode.cpp.

toFiffDigPoints()

FIFFLIB::FiffDigPointSet BidsElectrode::toFiffDigPoints ( const QList< BidsElectrode > & electrodes, const FIFFLIB::FiffCoordTrans & trans = FIFFLIB::FiffCoordTrans() )

static

Convert a list of BIDS electrodes to a FIFF digitizer point set.

Each electrode with valid numeric x/y/z coordinates is converted to a FiffDigPoint with kind FIFFV_POINT_EEG. Electrodes with "n/a" coordinates are skipped.

If a coordinate transform is supplied, the positions are transformed from the BIDS coordinate frame into the FIFF head frame before insertion.

Parameters

[in]	electrodes	List of BIDS electrode records.
[in]	trans	Optional coordinate transform (BIDS frame → head). Pass a default-constructed FiffCoordTrans to skip.

Returns

FiffDigPointSet with one point per valid electrode.

Definition at line 129 of file bids_electrode.cpp.

writeTsv()

bool BidsElectrode::writeTsv ( const QString & sFilePath, const QList< BidsElectrode > & electrodes )

static

Write a BIDS *_electrodes.tsv file.

Parameters

[in]	sFilePath	Output path.
[in]	electrodes	List of electrode records.

Returns

true on success.

Definition at line 94 of file bids_electrode.cpp.

Member Data Documentation

impedance

QString BIDSLIB::BidsElectrode::impedance

Impedance value or "n/a" (OPTIONAL).

Definition at line 79 of file bids_electrode.h.

material

QString BIDSLIB::BidsElectrode::material

Electrode material (OPTIONAL).

Definition at line 78 of file bids_electrode.h.

name

QString BIDSLIB::BidsElectrode::name

Electrode name (REQUIRED).

Definition at line 72 of file bids_electrode.h.

size

QString BIDSLIB::BidsElectrode::size

Electrode size in mm or "n/a" (RECOMMENDED for iEEG).

Definition at line 76 of file bids_electrode.h.

type

QString BIDSLIB::BidsElectrode::type

Electrode type: "depth", "strip", "grid" (OPTIONAL).

Definition at line 77 of file bids_electrode.h.

x

QString BIDSLIB::BidsElectrode::x

X coordinate or "n/a" (REQUIRED).

Definition at line 73 of file bids_electrode.h.

y

QString BIDSLIB::BidsElectrode::y

Y coordinate or "n/a" (REQUIRED).

Definition at line 74 of file bids_electrode.h.

z

QString BIDSLIB::BidsElectrode::z

Z coordinate or "n/a" (REQUIRED).

Definition at line 75 of file bids_electrode.h.

---

The documentation for this struct was generated from the following files:

• src/libraries/bids/bids_electrode.h
• src/libraries/bids/bids_electrode.cpp