MNELIB::MNEEpochData Class Reference

Single epoch (trial slice) of sensor data with timing and rejection metadata. More...

#include <mne_epoch_data.h>

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

Public Member Functions
	MNEEpochData ()
	MNEEpochData (const MNEEpochData &p_MNEEpochData)
MNEEpochData &	operator= (const MNEEpochData &other)=default
	~MNEEpochData ()
void	applyBaselineCorrection (const QPair< float, float > &baseline)
void	pick_channels (const Eigen::RowVectorXi &sel)
bool	isRejected (bool respectAutoReject=true) const

Public Attributes
Eigen::MatrixXd	epoch
FIFFLIB::fiff_int_t	event
FIFFLIB::fiff_int_t	eventSample
float	tmin
float	tmax
bool	bReject
bool	bUserReject

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

Detailed Description

Single epoch (trial slice) of sensor data with timing and rejection metadata.

Epoch data, which corresponds to an event

Definition at line 62 of file mne_epoch_data.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for MNEEpochData.

Definition at line 66 of file mne_epoch_data.h.

SPtr

typedef QSharedPointer<MNEEpochData> MNELIB::MNEEpochData::SPtr

Shared pointer type for MNEEpochData.

Definition at line 65 of file mne_epoch_data.h.

Constructor & Destructor Documentation

MNEEpochData() [1/2]

MNEEpochData::MNEEpochData

(

)

Default constructor.

Definition at line 38 of file mne_epoch_data.cpp.

MNEEpochData() [2/2]

MNEEpochData::MNEEpochData

(

const MNEEpochData &

p_MNEEpochData

)

Copy constructor.

Parameters

[in]

p_MNEEpochData

MNE epoch data.

Definition at line 50 of file mne_epoch_data.cpp.

~MNEEpochData()

MNEEpochData::~MNEEpochData

(

)

Destroys the MNE epoch data.

Definition at line 63 of file mne_epoch_data.cpp.

Member Function Documentation

applyBaselineCorrection()

void MNEEpochData::applyBaselineCorrection

(

const QPair< float, float > &

baseline

)

Applies baseline (mode=mean) correction to the evoked data.

Parameters

[in]

baseline

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

Definition at line 69 of file mne_epoch_data.cpp.

isRejected()

bool MNELIB::MNEEpochData::isRejected ( bool respectAutoReject = true ) const

inline

Returns whether this epoch should be excluded from averaging.

Parameters

[in]

respectAutoReject

Whether automatic artifact rejection should be honored.

Returns

true when the epoch should be excluded.

Definition at line 144 of file mne_epoch_data.h.

operator=()

MNEEpochData & MNELIB::MNEEpochData::operator= ( const MNEEpochData & 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_channels()

void MNEEpochData::pick_channels

(

const Eigen::RowVectorXi &

sel

)

Reduces the data to the selected rows.

Parameters

[in]

sel

The selected rows to keep.

Definition at line 78 of file mne_epoch_data.cpp.

Friends And Related Symbol Documentation

operator==

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

friend

Comparison of two Epoch data

Parameters

[in]

b

Epoch data to compare with.

Returns

true if equal; false otherwise.

Definition at line 125 of file mne_epoch_data.h.

Member Data Documentation

bReject

bool MNELIB::MNEEpochData::bReject

Whether this epoch is to be rejected.

Definition at line 155 of file mne_epoch_data.h.

bUserReject

bool MNELIB::MNEEpochData::bUserReject

Whether this epoch was manually excluded by the user.

Definition at line 156 of file mne_epoch_data.h.

epoch

Eigen::MatrixXd MNELIB::MNEEpochData::epoch

The data.

Definition at line 150 of file mne_epoch_data.h.

event

FIFFLIB::fiff_int_t MNELIB::MNEEpochData::event

The event code.

Definition at line 151 of file mne_epoch_data.h.

eventSample

FIFFLIB::fiff_int_t MNELIB::MNEEpochData::eventSample

The sample index of the triggering event.

Definition at line 152 of file mne_epoch_data.h.

tmax

float MNELIB::MNEEpochData::tmax

New end time of the data (cannot exceed data duration).

Definition at line 154 of file mne_epoch_data.h.

tmin

float MNELIB::MNEEpochData::tmin

New start time (must be >= 0).

Definition at line 153 of file mne_epoch_data.h.

---

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

• src/libraries/mne/mne_epoch_data.h
• src/libraries/mne/mne_epoch_data.cpp