Measurement data container for MNE inverse and dipole-fit computations. More...

#include <mne_meas_data.h>

Public Types
typedef QSharedPointer< MNEMeasData >	SPtr
typedef QSharedPointer< const MNEMeasData >	ConstSPtr

Public Member Functions
	MNEMeasData ()
	Constructs an empty measurement data container.
	~MNEMeasData ()
	Destroys the measurement data and all owned data sets.
void	adjust_baselines (float bmin, float bmax)
	Adjust baseline offset of the current data set.

Static Public Member Functions
static MNEMeasData *	mne_read_meas_data_add (const QString &name, int set, MNEInverseOperator op, MNENamedMatrix fwd, const QStringList &namesp, int nnamesp, MNEMeasData *add_to)
	Read an evoked-response data set and append it to an existing container.
static MNEMeasData *	mne_read_meas_data (const QString &name, int set, MNEInverseOperator op, MNENamedMatrix fwd, const QStringList &namesp, int nnamesp)
	Read an evoked-response data set into a new container.

Public Attributes
QString	filename
FIFFLIB::FiffId	meas_id
FIFFLIB::FiffTime	meas_date
QList< FIFFLIB::FiffChInfo >	chs
std::unique_ptr< FIFFLIB::FiffCoordTrans >	meg_head_t
std::unique_ptr< FIFFLIB::FiffCoordTrans >	mri_head_t
float	sfreq
int	nchan
float	highpass
float	lowpass
std::unique_ptr< MNEProjOp >	proj
std::unique_ptr< MNECTFCompDataSet >	comp
MNEInverseOperator *	op
MNENamedMatrix *	fwd
std::unique_ptr< MNERawData >	raw
mneChSelection	chsel
QStringList	badlist
int	nbad
std::vector< int >	bad
int	ch_major
QList< MNEMeasDataSet * >	sets
int	nset
MNEMeasDataSet *	current

Detailed Description

Measurement data container for MNE inverse and dipole-fit computations.

Replaces *mneMeasData / mneMeasDataRec from MNE-C mne_types.h. Holds channel information, coordinate transforms, projection operators, and one or more MNEMeasDataSet epochs loaded from a FIFF evoked-response file.

Definition at line 98 of file mne_meas_data.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const MNEMeasData> MNELIB::MNEMeasData::ConstSPtr

Const shared pointer type for MNEMeasData.

Definition at line 102 of file mne_meas_data.h.

◆ SPtr

typedef QSharedPointer<MNEMeasData> MNELIB::MNEMeasData::SPtr

Shared pointer type for MNEMeasData.

Definition at line 101 of file mne_meas_data.h.

Constructor & Destructor Documentation

◆ MNEMeasData()

MNEMeasData::MNEMeasData ( )

Constructs an empty measurement data container.

Refactored from mne_new_meas_data (mne_read_data.c).

Definition at line 78 of file mne_meas_data.cpp.

◆ ~MNEMeasData()

MNEMeasData::~MNEMeasData ( )

Destroys the measurement data and all owned data sets.

Refactored from mne_free_meas_data (mne_read_data.c).

Definition at line 97 of file mne_meas_data.cpp.

Member Function Documentation

◆ adjust_baselines()

void MNEMeasData::adjust_baselines	(	float	bmin,
		float	bmax )

Adjust baseline offset of the current data set.

Subtracts the mean over [bmin, bmax] from every channel and accumulates the offset in MNEMeasDataSet::baselines.

Refactored from mne_adjust_baselines (mne_apply_baselines.c).

Parameters

[in]	bmin	Baseline window start (seconds).
[in]	bmax	Baseline window end (seconds).

Definition at line 107 of file mne_meas_data.cpp.

◆ mne_read_meas_data()

MNEMeasData * MNEMeasData::mne_read_meas_data	(	const QString &	name,
		int	set,
		MNEInverseOperator *	op,
		MNENamedMatrix *	fwd,
		const QStringList &	namesp,
		int	nnamesp )

static

Read an evoked-response data set into a new container.

Convenience wrapper around mne_read_meas_data_add() with add_to = nullptr.

Parameters

[in]	name	Path to the FIFF measurement file.
[in]	set	1-based data-set index to load.
[in]	op	Inverse operator for consistency checks (may be `nullptr`).
[in]	fwd	Forward operator for consistency checks (may be `nullptr`).
[in]	namesp	Explicit channel name list.
[in]	nnamesp	Number of entries in `namesp`.

Returns: Pointer to the new container, or nullptr on failure.

Definition at line 429 of file mne_meas_data.cpp.

◆ mne_read_meas_data_add()

MNEMeasData * MNEMeasData::mne_read_meas_data_add	(	const QString &	name,
		int	set,
		MNEInverseOperator *	op,
		MNENamedMatrix *	fwd,
		const QStringList &	namesp,
		int	nnamesp,
		MNEMeasData *	add_to )

static

Read an evoked-response data set and append it to an existing container.

If add_to is nullptr a new MNEMeasData is created; otherwise the loaded epoch is appended to add_to's set list.

Refactored from mne_read_meas_data_add (mne_read_data.c).

Parameters

[in]	name	Path to the FIFF measurement file.
[in]	set	1-based data-set index to load.
[in]	op	Inverse operator for consistency checks (may be `nullptr`).
[in]	fwd	Forward operator for consistency checks (may be `nullptr`).
[in]	namesp	Explicit channel name list (fallback if `op` and `fwd` are `nullptr`).
[in]	nnamesp	Number of entries in `namesp`.
[in]	add_to	Existing container to append to, or `nullptr` to create a new one.

Returns: Pointer to the (new or existing) container, or nullptr on failure.

Definition at line 156 of file mne_meas_data.cpp.

Member Data Documentation

◆ bad

std::vector<int> MNELIB::MNEMeasData::bad

Per-channel bad flag array (0 = good, 1 = bad).

Definition at line 200 of file mne_meas_data.h.

◆ badlist

QStringList MNELIB::MNEMeasData::badlist

List of bad channel names.

Definition at line 198 of file mne_meas_data.h.

◆ ch_major

int MNELIB::MNEMeasData::ch_major

If non-zero, data rows are channels (not times).

Definition at line 202 of file mne_meas_data.h.

◆ chs

QList<FIFFLIB::FiffChInfo> MNELIB::MNEMeasData::chs

Channel information list.

Definition at line 185 of file mne_meas_data.h.

◆ chsel

mneChSelection MNELIB::MNEMeasData::chsel

Channel selection for raw-data access.

Definition at line 197 of file mne_meas_data.h.

◆ comp

std::unique_ptr<MNECTFCompDataSet> MNELIB::MNEMeasData::comp

Software gradient compensation data.

Definition at line 193 of file mne_meas_data.h.

◆ current

MNEMeasDataSet* MNELIB::MNEMeasData::current

Pointer to the currently active data set.

Definition at line 205 of file mne_meas_data.h.

◆ filename

QString MNELIB::MNEMeasData::filename

Path to the source FIFF file.

Definition at line 182 of file mne_meas_data.h.

◆ fwd

MNENamedMatrix* MNELIB::MNEMeasData::fwd

Forward operator for dipole fitting (not owned).

Definition at line 195 of file mne_meas_data.h.

◆ highpass

float MNELIB::MNEMeasData::highpass

High-pass filter setting (Hz).

Definition at line 190 of file mne_meas_data.h.

◆ lowpass

float MNELIB::MNEMeasData::lowpass

Low-pass filter setting (Hz).

Definition at line 191 of file mne_meas_data.h.

◆ meas_date

FIFFLIB::FiffTime MNELIB::MNEMeasData::meas_date

Measurement date / time stamp.

Definition at line 184 of file mne_meas_data.h.

◆ meas_id

FIFFLIB::FiffId MNELIB::MNEMeasData::meas_id

Measurement block ID from the FIFF file.

Definition at line 183 of file mne_meas_data.h.

◆ meg_head_t

std::unique_ptr<FIFFLIB::FiffCoordTrans> MNELIB::MNEMeasData::meg_head_t

MEG device ↔ head coordinate transform.

Definition at line 186 of file mne_meas_data.h.

◆ mri_head_t

std::unique_ptr<FIFFLIB::FiffCoordTrans> MNELIB::MNEMeasData::mri_head_t

MRI ↔ head coordinate transform.

Definition at line 187 of file mne_meas_data.h.

◆ nbad

int MNELIB::MNEMeasData::nbad

Number of bad channels.

Definition at line 199 of file mne_meas_data.h.

◆ nchan

int MNELIB::MNEMeasData::nchan

Number of channels.

Definition at line 189 of file mne_meas_data.h.

◆ nset

int MNELIB::MNEMeasData::nset

Number of loaded data sets.

Definition at line 204 of file mne_meas_data.h.

◆ op

MNEInverseOperator* MNELIB::MNEMeasData::op

Associated inverse operator (not owned).

Definition at line 194 of file mne_meas_data.h.

◆ proj

std::unique_ptr<MNEProjOp> MNELIB::MNEMeasData::proj

SSP projection operator (may be nullptr).

Definition at line 192 of file mne_meas_data.h.

◆ raw

std::unique_ptr<MNERawData> MNELIB::MNEMeasData::raw

Raw-data handle when data originates from a raw file.

Definition at line 196 of file mne_meas_data.h.

◆ sets

QList<MNEMeasDataSet*> MNELIB::MNEMeasData::sets

All loaded data-set epochs.

Definition at line 203 of file mne_meas_data.h.

◆ sfreq

float MNELIB::MNEMeasData::sfreq

Sampling frequency (Hz).

Definition at line 188 of file mne_meas_data.h.

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

src/libraries/mne/mne_meas_data.h
src/libraries/mne/mne_meas_data.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ SPtr

Constructor & Destructor Documentation

◆ MNEMeasData()

◆ ~MNEMeasData()

Member Function Documentation

◆ adjust_baselines()

◆ mne_read_meas_data()

◆ mne_read_meas_data_add()

Member Data Documentation

◆ bad

◆ badlist

◆ ch_major

◆ chs

◆ chsel

◆ comp

◆ current

◆ filename

◆ fwd

◆ highpass

◆ lowpass

◆ meas_date

◆ meas_id

◆ meg_head_t

◆ mri_head_t

◆ nbad

◆ nchan

◆ nset

◆ op

◆ proj

◆ raw

◆ sets

◆ sfreq