Full FIFF measurement info: per-channel descriptors, sampling and filter setup, projectors, compensators, transforms and dig points. More...

#include <fiff_info.h>

Public Types
using	SPtr = QSharedPointer<FiffInfo>
using	ConstSPtr = QSharedPointer<const FiffInfo>
using	UPtr = std::unique_ptr<FiffInfo>
using	ConstUPtr = std::unique_ptr<const FiffInfo>
Public Types inherited from FIFFLIB::FiffInfoBase
using	SPtr = QSharedPointer<FiffInfoBase>
using	ConstSPtr = QSharedPointer<const FiffInfoBase>
using	UPtr = std::unique_ptr<FiffInfoBase>
using	ConstUPtr = std::unique_ptr<const FiffInfoBase>

Public Member Functions
	FiffInfo ()
	FiffInfo (const FiffInfo &p_FiffInfo)
FiffInfo &	operator= (const FiffInfo &other)=default
	~FiffInfo ()
void	clear ()
bool	make_compensator (fiff_int_t from, fiff_int_t to, FiffCtfComp &ctf_comp, bool exclude_comp_chs=false) const
qint32	get_current_comp ()
qint32	make_projector (Eigen::MatrixXd &proj) const
qint32	make_projector (Eigen::MatrixXd &proj, const QStringList &p_chNames) const
FiffInfo	pick_info (const Eigen::RowVectorXi &sel=defaultVectorXi) const
void	set_current_comp (fiff_int_t value)
void	writeToStream (FiffStream *p_pStream) const
void	print () const
Public Member Functions inherited from FIFFLIB::FiffInfoBase
	FiffInfoBase ()
	FiffInfoBase (const FiffInfoBase &p_FiffInfoBase)
FiffInfoBase &	operator= (const FiffInfoBase &other)=default
virtual	~FiffInfoBase ()
void	clear ()
QString	channel_type (qint32 idx) const
QMap< QString, QList< int > >	channel_indices_by_type (const QList< int > &picks={}) const
bool	isEmpty () const
FiffInfoBase	pick_info (const Eigen::RowVectorXi *sel=nullptr) const
Eigen::RowVectorXi	pick_types (const QString meg, bool eeg=false, bool stim=false, const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList) const
Eigen::RowVectorXi	pick_types (bool meg, bool eeg=false, bool stim=false, const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList) const
void	mne_read_meg_comp_eeg_ch_info (QList< FiffChInfo > &megp, int &nmegp, QList< FiffChInfo > &meg_compp, int &nmeg_compp, QList< FiffChInfo > &eegp, int &neegp, FiffCoordTrans &meg_head_t, FiffId &idp) const
QStringList	get_channel_types ()

Static Public Member Functions
static QList< FiffChInfo >	set_current_comp (QList< FiffChInfo > &listFiffChInfo, fiff_int_t value)
static bool	readMegEegChannels (const QString &name, bool do_meg, bool do_eeg, const QStringList &bads, QList< FiffChInfo > &chsp, int &nmegp, int &neegp)
Static Public Member Functions inherited from FIFFLIB::FiffInfoBase
static Eigen::RowVectorXi	pick_channels_regexp (const QStringList &ch_names, const QString &regexp)
static Eigen::RowVectorXi	pick_channels (const QStringList &ch_names, const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList)
static bool	readBadChannelsFromFile (const QString &name, QStringList &listOut)

Public Attributes
FiffId	file_id
fiff_int_t	meas_date [2]
float	sfreq
float	linefreq
float	highpass
float	lowpass
int	proj_id
QString	proj_name
QString	xplotter_layout
QString	experimenter
QString	description
QString	utc_offset
fiff_int_t	gantry_angle
FiffCoordTrans	dev_ctf_t
QList< FiffDigPoint >	dig
FiffCoordTrans	dig_trans
QList< FiffProj >	projs
QList< FiffCtfComp >	comps
QString	acq_pars
QString	acq_stim
QList< float >	hpi_coil_freqs
Public Attributes inherited from FIFFLIB::FiffInfoBase
QString	filename
QStringList	bads
FiffId	meas_id
fiff_int_t	nchan
QList< FiffChInfo >	chs
QStringList	ch_names
FiffCoordTrans	dev_head_t
FiffCoordTrans	ctf_head_t
QList< FiffCoordTrans >	all_coord_trans

Detailed Description

Full FIFF measurement info: per-channel descriptors, sampling and filter setup, projectors, compensators, transforms and dig points.

Materializes the union of the tags found in FIFFB_MEAS / FIFFB_MEAS_INFO: sfreq, lowpass / highpass / line_freq, meas_date, experimenter, projs (FiffProj), comps (FiffCtfComp), dig (FiffDigPoint), hpi_results / hpi_meas, dev_head_t / ctf_head_t, plus the FiffInfoBase channel / bads / sfreq subset. Drop-in counterpart of mne.Info in MNE-Python.

Definition at line 89 of file fiff_info.h.

Inheritance diagram for FIFFLIB::FiffInfo:

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for FiffInfo.

Definition at line 93 of file fiff_info.h.

◆ ConstUPtr

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

Const unique pointer type for FiffInfo.

Definition at line 95 of file fiff_info.h.

◆ SPtr

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

Shared pointer type for FiffInfo.

Definition at line 92 of file fiff_info.h.

◆ UPtr

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

Unique pointer type for FiffInfo.

Definition at line 94 of file fiff_info.h.

Constructor & Destructor Documentation

◆ FiffInfo() [1/2]

FiffInfo::FiffInfo ( )

Constructors the fiff measurement file information.

Definition at line 48 of file fiff_info.cpp.

◆ FiffInfo() [2/2]

FiffInfo::FiffInfo ( const FiffInfo & p_FiffInfo )

Copy constructor.

Parameters

[in] p_FiffInfo FIFF measurement information which should be copied.

Definition at line 63 of file fiff_info.cpp.

◆ ~FiffInfo()

FiffInfo::~FiffInfo ( )

Destroys the fiff measurement file information.

Definition at line 92 of file fiff_info.cpp.

Member Function Documentation

◆ clear()

void FiffInfo::clear ( )

Initializes FIFF measurement information.

< UTC offset of related meas_date (sHH:MM).

Definition at line 98 of file fiff_info.cpp.

◆ get_current_comp()

qint32 FiffInfo::get_current_comp ( )

mne_get_current_comp

Get the current compensation in effect in the data

Returns: the current compensation.

Definition at line 126 of file fiff_info.cpp.

◆ make_compensator()

bool FiffInfo::make_compensator	(	fiff_int_t	from,
		fiff_int_t	to,
		FiffCtfComp &	ctf_comp,
		bool	exclude_comp_chs = false ) const

mne_make_compensator

Create a compensation matrix to bring the data from one compensation state to another

Parameters

[in]	from	compensation in the input data.
[in]	to	desired compensation in the output.
[out]	ctf_comp	Compensation Matrix.
[in]	exclude_comp_chs	exclude compensation channels from the output (optional).

Returns: true if succeeded, false otherwise.

Definition at line 146 of file fiff_info.cpp.

◆ make_projector() [1/2]

qint32 FIFFLIB::FiffInfo::make_projector ( Eigen::MatrixXd & proj ) const

inline

mne_make_projector_info

Make a SSP operator using the meas info

Parameters

[out] proj The projection operator to apply to the data.

Returns: nproj - How many items in the projector.

Definition at line 303 of file fiff_info.h.

◆ make_projector() [2/2]

qint32 FIFFLIB::FiffInfo::make_projector	(	Eigen::MatrixXd &	proj,
		const QStringList &	p_chNames ) const

inline

mne_make_projector_info

Make a SSP operator using the meas info

Parameters

[out]	proj	The projection operator to apply to the data.
[in]	p_chNames	List of channels to include in the projection matrix.

Returns: nproj - How many items in the projector.

Definition at line 310 of file fiff_info.h.

◆ operator=()

FiffInfo & FIFFLIB::FiffInfo::operator= ( const FiffInfo & other )

default

Copy assignment. Every member has value semantics, so the compiler-generated member-wise assignment is correct. It is declared explicitly because declaring a copy constructor and/or a destructor deprecates the implicitly generated one.

Parameters

[in] other Object to assign from.

Returns: reference to this object.

◆ pick_info()

FiffInfo FiffInfo::pick_info ( const Eigen::RowVectorXi & sel = defaultVectorXi ) const

fiff_pick_info

Pick desired channels from measurement info

Parameters

[in] sel List of channels to select.

Returns: Info modified according to sel.

Definition at line 278 of file fiff_info.cpp.

◆ print()

void FiffInfo::print ( ) const

Prints class contents.

Definition at line 489 of file fiff_info.cpp.

◆ readMegEegChannels()

bool FiffInfo::readMegEegChannels	(	const QString &	name,
		bool	do_meg,
		bool	do_eeg,
		const QStringList &	bads,
		QList< FiffChInfo > &	chsp,
		int &	nmegp,
		int &	neegp )

static

Read MEG and EEG channel information from a FIFF file, excluding bad channels.

Opens the file, reads measurement info, and splits channels into MEG and EEG lists (in that order), skipping channels in the bads list. EEG channels must pass FiffChInfo::isValidEeg().

Parameters

[in]	name	Path to the FIFF measurement file.
[in]	do_meg	If true, include MEG channels.
[in]	do_eeg	If true, include EEG channels.
[in]	bads	List of bad channel names to exclude.
[out]	chsp	Combined list of accepted channels (MEG first, then EEG).
[out]	nmegp	Number of MEG channels in chsp.
[out]	neegp	Number of EEG channels in chsp.

Returns: true on success, false on error.

Definition at line 322 of file fiff_info.cpp.

◆ set_current_comp() [1/2]

void FIFFLIB::FiffInfo::set_current_comp ( fiff_int_t value )

inline

Set the current compensation value in the channel info structures

Parameters

[in] value compensation value.

Definition at line 317 of file fiff_info.h.

◆ set_current_comp() [2/2]

QList< FiffChInfo > FiffInfo::set_current_comp	(	QList< FiffChInfo > &	listFiffChInfo,
		fiff_int_t	value )

static

mne_set_current_comp

Consider taking the member function of set_current_comp(fiff_int_t value), when compensation should be applied to the channels of FiffInfo

Set the current compensation value in the channel info structures

Parameters

[in]	listFiffChInfo	fiff channel info list.
[in]	value	compensation value.

Returns: the current compensation.

Definition at line 301 of file fiff_info.cpp.

◆ writeToStream()

void FiffInfo::writeToStream ( FiffStream * p_pStream ) const

Writes the fiff information to a FIF stream.

Parameters

[in] p_pStream The stream to write to.

Definition at line 369 of file fiff_info.cpp.

Member Data Documentation

◆ acq_pars

QString FIFFLIB::FiffInfo::acq_pars

Acquisition parameters.

Definition at line 294 of file fiff_info.h.

◆ acq_stim

QString FIFFLIB::FiffInfo::acq_stim

Acquisition stimulus information.

Definition at line 295 of file fiff_info.h.

◆ comps

QList<FiffCtfComp> FIFFLIB::FiffInfo::comps

List of available CTF software compensators.

Definition at line 293 of file fiff_info.h.

◆ description

QString FIFFLIB::FiffInfo::description

(Textual) Description of an object.

Definition at line 286 of file fiff_info.h.

◆ dev_ctf_t

FiffCoordTrans FIFFLIB::FiffInfo::dev_ctf_t

Device to CTF coordinate transformation.

Definition at line 289 of file fiff_info.h.

◆ dig

QList<FiffDigPoint> FIFFLIB::FiffInfo::dig

List of all digitization point descriptors.

Definition at line 290 of file fiff_info.h.

◆ dig_trans

FiffCoordTrans FIFFLIB::FiffInfo::dig_trans

Digitizer coordinate transformation.

Definition at line 291 of file fiff_info.h.

◆ experimenter

QString FIFFLIB::FiffInfo::experimenter

Experimenter name.

Definition at line 285 of file fiff_info.h.

◆ file_id

FiffId FIFFLIB::FiffInfo::file_id

File ID.

Definition at line 276 of file fiff_info.h.

◆ gantry_angle

fiff_int_t FIFFLIB::FiffInfo::gantry_angle

Tilt angle of the dewar in degrees.

Definition at line 288 of file fiff_info.h.

◆ highpass

float FIFFLIB::FiffInfo::highpass

Highpass frequency.

Definition at line 280 of file fiff_info.h.

◆ hpi_coil_freqs

QList<float> FIFFLIB::FiffInfo::hpi_coil_freqs

Excitation frequencies of the HPI coils in Hz, in coil order. Empty when the file contains no HPI measurement block.

Definition at line 296 of file fiff_info.h.

◆ linefreq

float FIFFLIB::FiffInfo::linefreq

Power line frequency.

Definition at line 279 of file fiff_info.h.

◆ lowpass

float FIFFLIB::FiffInfo::lowpass

Lowpass frequency.

Definition at line 281 of file fiff_info.h.

◆ meas_date

fiff_int_t FIFFLIB::FiffInfo::meas_date[2]

Measurement date.

Definition at line 277 of file fiff_info.h.

◆ proj_id

int FIFFLIB::FiffInfo::proj_id

Project ID.

Definition at line 282 of file fiff_info.h.

◆ proj_name

QString FIFFLIB::FiffInfo::proj_name

Project name.

Definition at line 283 of file fiff_info.h.

◆ projs

QList<FiffProj> FIFFLIB::FiffInfo::projs

List of available SSP projectors.

Definition at line 292 of file fiff_info.h.

◆ sfreq

float FIFFLIB::FiffInfo::sfreq

Sample frequency.

Definition at line 278 of file fiff_info.h.

◆ utc_offset

QString FIFFLIB::FiffInfo::utc_offset

UTC offset of related meas_date (sHH:MM).

Definition at line 287 of file fiff_info.h.

◆ xplotter_layout

QString FIFFLIB::FiffInfo::xplotter_layout

xplotter layout tag.

Definition at line 284 of file fiff_info.h.

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

src/libraries/fiff/fiff_info.h
src/libraries/fiff/fiff_info.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ ConstUPtr

◆ SPtr

◆ UPtr

Constructor & Destructor Documentation

◆ FiffInfo() [1/2]

◆ FiffInfo() [2/2]

◆ ~FiffInfo()

Member Function Documentation

◆ clear()

◆ get_current_comp()

◆ make_compensator()

◆ make_projector() [1/2]

◆ make_projector() [2/2]

◆ operator=()

◆ pick_info()

◆ print()

◆ readMegEegChannels()

◆ set_current_comp() [1/2]

◆ set_current_comp() [2/2]

◆ writeToStream()

Member Data Documentation

◆ acq_pars

◆ acq_stim

◆ comps

◆ description

◆ dev_ctf_t

◆ dig

◆ dig_trans

◆ experimenter

◆ file_id

◆ gantry_angle

◆ highpass

◆ hpi_coil_freqs

◆ linefreq

◆ lowpass

◆ meas_date

◆ proj_id

◆ proj_name

◆ projs

◆ sfreq

◆ utc_offset

◆ xplotter_layout