Channel metadata record corresponding to one row in *_channels.tsv. More...

#include <bids_channel.h>

Static Public Member Functions
static QList< BidsChannel >	readTsv (const QString &sFilePath)
	Read a BIDS *_channels.tsv file.
static bool	writeTsv (const QString &sFilePath, const QList< BidsChannel > &channels)
	Write a BIDS *_channels.tsv file.

Public Attributes
QString	name
QString	type
QString	units
QString	samplingFreq
QString	lowCutoff
QString	highCutoff
QString	notch
QString	status
QString	description

Detailed Description

Channel metadata record corresponding to one row in *_channels.tsv.

Definition at line 54 of file bids_channel.h.

Member Function Documentation

◆ readTsv()

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

static

Read a BIDS *_channels.tsv file.

Parameters

[in] sFilePath Path to the channels.tsv file.

Returns: List of channel records.

Definition at line 44 of file bids_channel.cpp.

◆ writeTsv()

bool BidsChannel::writeTsv	(	const QString &	sFilePath,
		const QList< BidsChannel > &	channels )

static

Write a BIDS *_channels.tsv file.

Parameters

[in]	sFilePath	Output path.
[in]	channels	List of channel records.

Returns: true on success.

Definition at line 71 of file bids_channel.cpp.

Member Data Documentation

◆ description

QString BIDSLIB::BidsChannel::description

Free-text description (OPTIONAL).

Definition at line 64 of file bids_channel.h.

◆ highCutoff

QString BIDSLIB::BidsChannel::highCutoff

Low-pass cutoff frequency in Hz (OPTIONAL).

Definition at line 61 of file bids_channel.h.

◆ lowCutoff

QString BIDSLIB::BidsChannel::lowCutoff

High-pass cutoff frequency in Hz (OPTIONAL).

Definition at line 60 of file bids_channel.h.

◆ name

QString BIDSLIB::BidsChannel::name

Channel name (REQUIRED).

Definition at line 56 of file bids_channel.h.

◆ notch

QString BIDSLIB::BidsChannel::notch

Notch filter frequency in Hz (OPTIONAL).

Definition at line 62 of file bids_channel.h.

◆ samplingFreq

QString BIDSLIB::BidsChannel::samplingFreq

Sampling frequency in Hz (OPTIONAL).

Definition at line 59 of file bids_channel.h.

◆ status

QString BIDSLIB::BidsChannel::status

"good" or "bad" (OPTIONAL).

Definition at line 63 of file bids_channel.h.

◆ type

QString BIDSLIB::BidsChannel::type

BIDS channel type: EEG, ECOG, SEEG, DBS, TRIG, etc. (REQUIRED).

Definition at line 57 of file bids_channel.h.

◆ units

QString BIDSLIB::BidsChannel::units

Unit of measurement: V, uV, mV (REQUIRED).

Definition at line 58 of file bids_channel.h.

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

src/libraries/bids/bids_channel.h
src/libraries/bids/bids_channel.cpp

Static Public Member Functions

Public Attributes