Epoch data list. More...

#include <mne_epoch_data_list.h>

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

Public Member Functions
	MNEEpochDataList ()
	~MNEEpochDataList ()
FIFFLIB::FiffEvoked	average (const FIFFLIB::FiffInfo &p_info, FIFFLIB::fiff_int_t first, FIFFLIB::fiff_int_t last, Eigen::VectorXi sel=FIFFLIB::defaultVectorXi, bool proj=false)
void	applyBaselineCorrection (const QPair< float, float > &baseline)
void	dropRejected ()
void	pick_channels (const Eigen::RowVectorXi &sel)

Static Public Member Functions
static MNEEpochDataList	readEpochs (const FIFFLIB::FiffRawData &raw, const Eigen::MatrixXi &events, float tmin, float tmax, qint32 event, const QMap< QString, double > &mapReject, const QStringList &lExcludeChs=QStringList(), const Eigen::RowVectorXi &picks=Eigen::RowVectorXi())
static bool	checkForArtifact (const Eigen::MatrixXd &data, const FIFFLIB::FiffInfo &pFiffInfo, const QMap< QString, double > &mapReject, const QStringList &lExcludeChs=QStringList())
static void	checkChThreshold (ArtifactRejectionData &inputData)
static FIFFLIB::FiffEvokedSet	averageCategories (const FIFFLIB::FiffRawData &raw, const Eigen::MatrixXi &events, const QList< int > &eventCodes, const QStringList &comments, float tmin, float tmax, const QMap< QString, double > &mapReject=QMap< QString, double >(), const QPair< float, float > &baseline=QPair< float, float >(0.0f, 0.0f), bool proj=false)

Detailed Description

Epoch data list.

Epoch data list, which corresponds to a set of events

Definition at line 81 of file mne_epoch_data_list.h.

Inheritance diagram for MNELIB::MNEEpochDataList:

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for MNEEpochDataList.

Definition at line 86 of file mne_epoch_data_list.h.

◆ SPtr

typedef QSharedPointer<MNEEpochDataList> MNELIB::MNEEpochDataList::SPtr

Shared pointer type for MNEEpochDataList.

Definition at line 85 of file mne_epoch_data_list.h.

Constructor & Destructor Documentation

◆ MNEEpochDataList()

MNEEpochDataList::MNEEpochDataList ( )

Default constructor.

Definition at line 69 of file mne_epoch_data_list.cpp.

◆ ~MNEEpochDataList()

MNEEpochDataList::~MNEEpochDataList ( )

Destroys the MNEEpochDataList.

Definition at line 75 of file mne_epoch_data_list.cpp.

Member Function Documentation

◆ applyBaselineCorrection()

void MNEEpochDataList::applyBaselineCorrection ( const QPair< float, float > & baseline )

Applies baseline correction to the evoked data.

Parameters

[in] baseline time definition of the baseline in seconds [from, to].

Definition at line 242 of file mne_epoch_data_list.cpp.

◆ average()

FiffEvoked MNEEpochDataList::average	(	const FIFFLIB::FiffInfo &	p_info,
		FIFFLIB::fiff_int_t	first,
		FIFFLIB::fiff_int_t	last,
		Eigen::VectorXi	sel = FIFFLIB::defaultVectorXi,
		bool	proj = false )

Averages epoch list. Note that no baseline correction performed.

Parameters

[in]	info	measurement info.
[in]	first	First time sample.
[in]	last	Last time sample.
[in]	sel	Which epochs should be averaged (optional).
[in]	proj	Apply SSP projection vectors (optional, default = false).

Definition at line 181 of file mne_epoch_data_list.cpp.

◆ averageCategories()

FiffEvokedSet MNEEpochDataList::averageCategories	(	const FIFFLIB::FiffRawData &	raw,
		const Eigen::MatrixXi &	events,
		const QList< int > &	eventCodes,
		const QStringList &	comments,
		float	tmin,
		float	tmax,
		const QMap< QString, double > &	mapReject = QMap<QString,double>(),
		const QPair< float, float > &	baseline = QPair<float,float>(0.0f, 0.0f),
		bool	proj = false )

static

averageCategories

Multi-category offline averaging. Reads epochs from raw data for multiple event types and returns an FiffEvokedSet with one FiffEvoked per category. Ported from average.c (MNE-C).

Parameters

[in]	raw	The raw data.
[in]	events	Event matrix (nEvents x 3): [sample, before, after].
[in]	eventCodes	List of event codes, one per category.
[in]	comments	List of category names/comments, one per category.
[in]	tmin	Start of epoch relative to event (seconds).
[in]	tmax	End of epoch relative to event (seconds).
[in]	mapReject	Rejection thresholds (key = channel type string, value = threshold).
[in]	baseline	Baseline interval [from, to] in seconds. If from==to, no baseline correction.
[in]	proj	Apply SSP projection vectors (optional, default = false).

Returns: FiffEvokedSet containing one FiffEvoked per category.

Definition at line 396 of file mne_epoch_data_list.cpp.

◆ checkChThreshold()

void MNEEpochDataList::checkChThreshold ( ArtifactRejectionData & inputData )

static

Definition at line 362 of file mne_epoch_data_list.cpp.

◆ checkForArtifact()

bool MNEEpochDataList::checkForArtifact	(	const Eigen::MatrixXd &	data,
		const FIFFLIB::FiffInfo &	pFiffInfo,
		const QMap< QString, double > &	mapReject,
		const QStringList &	lExcludeChs = QStringList() )

static

Checks the givven matrix for artifacts beyond a threshold value.

Parameters

[in]	data	The data matrix.
[in]	pFiffInfo	The fiff info.
[in]	mapReject	The channel data types to scan for. EEG, MEG or EOG.
[in]	lExcludeChs	List of channel names to exclude.

Returns: Whether a threshold artifact was detected.

Definition at line 275 of file mne_epoch_data_list.cpp.

◆ dropRejected()

void MNEEpochDataList::dropRejected ( )

Drop/Remove all epochs tagged as rejected

Definition at line 253 of file mne_epoch_data_list.cpp.

◆ pick_channels()

void MNEEpochDataList::pick_channels ( const Eigen::RowVectorXi & sel )

Reduces alld epochs to the selected rows.

Parameters

[in] sel The selected rows to keep.

Definition at line 265 of file mne_epoch_data_list.cpp.

◆ readEpochs()

MNEEpochDataList MNEEpochDataList::readEpochs	(	const FIFFLIB::FiffRawData &	raw,
		const Eigen::MatrixXi &	events,
		float	tmin,
		float	tmax,
		qint32	event,
		const QMap< QString, double > &	mapReject,
		const QStringList &	lExcludeChs = QStringList(),
		const Eigen::RowVectorXi &	picks = Eigen::RowVectorXi() )

static

Read the epochs from a raw file based on provided events.

Parameters

[in]	raw	The raw data.
[in]	events	The events provided in samples and event kind.
[in]	tmin	The start time relative to the event in seconds.
[in]	tmax	The end time relative to the event in seconds.
[in]	event	The event kind.
[in]	lExcludeChs	List of channel names to exclude.
[in]	picks	Which channels to pick.

Definition at line 86 of file mne_epoch_data_list.cpp.

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

src/libraries/mne/mne_epoch_data_list.h
src/libraries/mne/mne_epoch_data_list.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ SPtr

Constructor & Destructor Documentation

◆ MNEEpochDataList()

◆ ~MNEEpochDataList()

Member Function Documentation

◆ applyBaselineCorrection()

◆ average()

◆ averageCategories()

◆ checkChThreshold()

◆ checkForArtifact()

◆ dropRejected()

◆ pick_channels()

◆ readEpochs()