FIFFLIB::FiffChInfo Class Reference

Channel info descriptor. More...

#include <fiff_ch_info.h>

Public Types
using	SPtr = QSharedPointer<FiffChInfo>
using	ConstSPtr = QSharedPointer<const FiffChInfo>
using	UPtr = std::unique_ptr<FiffChInfo>
using	ConstUPtr = std::unique_ptr<const FiffChInfo>

Public Member Functions
	FiffChInfo ()
	FiffChInfo (const FiffChInfo &p_FiffChInfo)
	~FiffChInfo ()
bool	isValidEeg () const

Static Public Member Functions
static qint32	storageSize ()
static bool	checkEegLocations (const QList< FiffChInfo > &chs, int nch)

Public Attributes
fiff_int_t	scanNo
fiff_int_t	logNo
fiff_int_t	kind
fiff_float_t	range
fiff_float_t	cal
FiffChPos	chpos
fiff_int_t	unit
fiff_int_t	unit_mul
QString	ch_name
Eigen::Matrix< float, 4, 4, Eigen::DontAlign >	coil_trans
Eigen::Matrix< float, 3, 2, Eigen::DontAlign >	eeg_loc
fiff_int_t	coord_frame

Friends
bool	operator== (const FiffChInfo &a, const FiffChInfo &b)

Detailed Description

Channel info descriptor.

Channel info descriptor.

Definition at line 75 of file fiff_ch_info.h.

Member Typedef Documentation

ConstSPtr

using FIFFLIB::FiffChInfo::ConstSPtr = QSharedPointer<const FiffChInfo>

Const shared pointer type for FiffChInfo.

Definition at line 79 of file fiff_ch_info.h.

ConstUPtr

using FIFFLIB::FiffChInfo::ConstUPtr = std::unique_ptr<const FiffChInfo>

Const unique pointer type for FiffChInfo.

Definition at line 81 of file fiff_ch_info.h.

SPtr

using FIFFLIB::FiffChInfo::SPtr = QSharedPointer<FiffChInfo>

Shared pointer type for FiffChInfo.

Definition at line 78 of file fiff_ch_info.h.

UPtr

using FIFFLIB::FiffChInfo::UPtr = std::unique_ptr<FiffChInfo>

Unique pointer type for FiffChInfo.

Definition at line 80 of file fiff_ch_info.h.

Constructor & Destructor Documentation

FiffChInfo() [1/2]

FiffChInfo::FiffChInfo

(

)

Constructs the channel info descriptor.

Definition at line 54 of file fiff_ch_info.cpp.

FiffChInfo() [2/2]

FiffChInfo::FiffChInfo

(

const FiffChInfo &

p_FiffChInfo

)

Copy constructor.

Parameters

[in]

p_FiffChInfo

Channel Info descriptor which should be copied.

Definition at line 73 of file fiff_ch_info.cpp.

~FiffChInfo()

FiffChInfo::~FiffChInfo

(

)

Destroys the channel info descriptor.

Definition at line 91 of file fiff_ch_info.cpp.

Member Function Documentation

checkEegLocations()

bool FiffChInfo::checkEegLocations ( const QList< FiffChInfo > & chs, int nch )

static

Check that all EEG channels in the list have reasonable (non-origin) locations. Formerly mne_check_chinfo (MNE C).

Parameters

[in]	chs	The list of channel info structures to check.
[in]	nch	The number of channels to check.

Returns

true if all EEG channels have valid locations, false otherwise.

Definition at line 97 of file fiff_ch_info.cpp.

isValidEeg()

bool FiffChInfo::isValidEeg

(

)

const

Check whether this channel has a valid EEG electrode position.

A channel is a valid EEG channel if its kind is FIFFV_EEG_CH, its electrode position is not at the origin, and its coil type is not FIFFV_COIL_NONE.

Returns

true if this is a valid EEG channel with proper electrode location.

Definition at line 113 of file fiff_ch_info.cpp.

storageSize()

qint32 FIFFLIB::FiffChInfo::storageSize ( )

inlinestatic

Size of the old struct (fiffChInfoRec) 20*int + 16 = 20*4 + 16 = 96

Returns

the size of the old struct fiffChInfoRec.

Definition at line 165 of file fiff_ch_info.h.

Friends And Related Symbol Documentation

operator==

bool operator== ( const FiffChInfo & a, const FiffChInfo & b )

friend

Overloaded == operator to compare an object to this instance.

Parameters

[in]

object

The object which should be compared to.

Returns

true if equal, false otherwise.

Definition at line 175 of file fiff_ch_info.h.

Member Data Documentation

cal

fiff_float_t FIFFLIB::FiffChInfo::cal

Calibration from volts to units used.

Definition at line 148 of file fiff_ch_info.h.

ch_name

QString FIFFLIB::FiffChInfo::ch_name

Descriptive name for the channel.

Definition at line 152 of file fiff_ch_info.h.

chpos

FiffChPos FIFFLIB::FiffChInfo::chpos

Channel location.

Definition at line 149 of file fiff_ch_info.h.

coil_trans

Eigen::Matrix<float,4,4, Eigen::DontAlign> FIFFLIB::FiffChInfo::coil_trans

Coil coordinate system transformation.

Definition at line 155 of file fiff_ch_info.h.

coord_frame

fiff_int_t FIFFLIB::FiffChInfo::coord_frame

Coordinate Frame.

Definition at line 157 of file fiff_ch_info.h.

eeg_loc

Eigen::Matrix<float,3,2, Eigen::DontAlign> FIFFLIB::FiffChInfo::eeg_loc

Channel location.

Definition at line 156 of file fiff_ch_info.h.

kind

fiff_int_t FIFFLIB::FiffChInfo::kind

Kind of channel.

Definition at line 146 of file fiff_ch_info.h.

logNo

fiff_int_t FIFFLIB::FiffChInfo::logNo

Logical channel #.

Definition at line 145 of file fiff_ch_info.h.

range

fiff_float_t FIFFLIB::FiffChInfo::range

Voltmeter range (-1 = auto ranging).

Definition at line 147 of file fiff_ch_info.h.

scanNo

fiff_int_t FIFFLIB::FiffChInfo::scanNo

Scanning order number.

Definition at line 144 of file fiff_ch_info.h.

unit

fiff_int_t FIFFLIB::FiffChInfo::unit

Unit of measurement.

Definition at line 150 of file fiff_ch_info.h.

unit_mul

fiff_int_t FIFFLIB::FiffChInfo::unit_mul

Unit multiplier exponent.

Definition at line 151 of file fiff_ch_info.h.

---

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

• src/libraries/fiff/fiff_ch_info.h
• src/libraries/fiff/fiff_ch_info.cpp