v2.0.0
Loading...
Searching...
No Matches
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< BidsElectrodereadTsv (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.

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 62 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]sFilePathPath to the electrodes.tsv file.
Returns
List of electrode records.

Definition at line 66 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]sFilePathOutput path.
[in]electrodesList of electrode records.
Returns
true on success.

Definition at line 92 of file bids_electrode.cpp.

Member Data Documentation

◆ impedance

QString BIDSLIB::BidsElectrode::impedance

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

Definition at line 71 of file bids_electrode.h.

◆ material

QString BIDSLIB::BidsElectrode::material

Electrode material (OPTIONAL).

Definition at line 70 of file bids_electrode.h.

◆ name

QString BIDSLIB::BidsElectrode::name

Electrode name (REQUIRED).

Definition at line 64 of file bids_electrode.h.

◆ size

QString BIDSLIB::BidsElectrode::size

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

Definition at line 68 of file bids_electrode.h.

◆ type

QString BIDSLIB::BidsElectrode::type

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

Definition at line 69 of file bids_electrode.h.

◆ x

QString BIDSLIB::BidsElectrode::x

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

Definition at line 65 of file bids_electrode.h.

◆ y

QString BIDSLIB::BidsElectrode::y

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

Definition at line 66 of file bids_electrode.h.

◆ z

QString BIDSLIB::BidsElectrode::z

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

Definition at line 67 of file bids_electrode.h.


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