Single averaged evoked response: time axis, data, baseline, channel info and averaging metadata. More...

#include <fiff_evoked.h>

Public Types
enum class	CombineWeights { Nave , Equal }
using	SPtr = QSharedPointer<FiffEvoked>
using	ConstSPtr = QSharedPointer<const FiffEvoked>
using	UPtr = std::unique_ptr<FiffEvoked>
using	ConstUPtr = std::unique_ptr<const FiffEvoked>

Public Member Functions
	FiffEvoked ()
	FiffEvoked (QIODevice &p_IODevice, QVariant setno=0, QPair< float, float > t_baseline=defaultFloatPair, bool proj=true, fiff_int_t p_aspect_kind=FIFFV_ASPECT_AVERAGE)
	FiffEvoked (const FiffEvoked &p_FiffEvoked)
FiffEvoked &	operator= (const FiffEvoked &other)=default
	~FiffEvoked ()
QStringList	ch_names ()
void	clear ()
QString	aspectKindToString () const
bool	isEmpty () const
FiffEvoked	pick_channels (const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList) const
void	setInfo (const FiffInfo &p_info, bool applyProj=true)
FiffEvoked &	operator+= (const Eigen::MatrixXd &newData)
void	applyBaselineCorrection (QPair< float, float > &p_baseline)

Static Public Member Functions
static bool	read (QIODevice &p_IODevice, FiffEvoked &p_FiffEvoked, QVariant setno=0, QPair< float, float > t_baseline=defaultFloatPair, bool proj=true, fiff_int_t p_aspect_kind=FIFFV_ASPECT_AVERAGE)
static FiffEvoked	combine (const QList< FiffEvoked > &evokeds, const Eigen::VectorXd &weights)
static FiffEvoked	combine (const QList< FiffEvoked > &evokeds, CombineWeights weights)

Public Attributes
FiffInfo	info
fiff_int_t	nave
fiff_int_t	aspect_kind
fiff_int_t	first
fiff_int_t	last
QString	comment
Eigen::RowVectorXf	times
Eigen::MatrixXd	data
Eigen::MatrixXd	proj
QPair< float, float >	baseline

Detailed Description

Single averaged evoked response: time axis, data, baseline, channel info and averaging metadata.

Holds one FIFFB_EVOKED block: times, data, first / last sample indices, baseline, kind, nave, comment and the FiffInfo describing the channels. Use FiffEvokedSet for recordings that contain multiple averaging conditions.

Definition at line 76 of file fiff_evoked.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for FiffEvoked.

Definition at line 80 of file fiff_evoked.h.

◆ ConstUPtr

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

Const unique pointer type for FiffEvoked.

Definition at line 82 of file fiff_evoked.h.

◆ SPtr

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

Shared pointer type for FiffEvoked.

Definition at line 79 of file fiff_evoked.h.

◆ UPtr

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

Unique pointer type for FiffEvoked.

Definition at line 81 of file fiff_evoked.h.

Member Enumeration Documentation

◆ CombineWeights

enum class FIFFLIB::FiffEvoked::CombineWeights

strong

Predefined weighting strategies of combine().

Enumerator
Nave	Sum-to-one weights proportional to each nave.
Equal	Every data set is weighted by 1 / number of data sets.

Definition at line 230 of file fiff_evoked.h.

Constructor & Destructor Documentation

◆ FiffEvoked() [1/3]

FiffEvoked::FiffEvoked ( )

Constructs a fiff evoked data.

Definition at line 45 of file fiff_evoked.cpp.

◆ FiffEvoked() [2/3]

FiffEvoked::FiffEvoked	(	QIODevice &	p_IODevice,
		QVariant	setno = 0,
		QPair< float, float >	t_baseline = defaultFloatPair,
		bool	proj = true,
		fiff_int_t	p_aspect_kind = FIFFV_ASPECT_AVERAGE )

Constructs fiff evoked data, by reading from a IO device.

Parameters

[in]	p_IODevice	IO device to read from the evoked data set.
[in]	setno	The set to pick. Dataset ID number (int) or comment/name (str). Optional if there isonly one data set in file.
[in]	t_baseline	The time interval to apply rescaling / baseline correction. If None do not apply it. If baseline is (a, b). the interval is between "a (s)" and "b (s)". If a is None the beginning of the data is used and if b is None then b is set to the end of the interval. If baseline is equal ot (None, None) all the time interval is used. If None, no correction is applied.
[in]	proj	Apply SSP projection vectors (optional, default = true).
[in]	p_aspect_kind	Either "FIFFV_ASPECT_AVERAGE" or "FIFFV_ASPECT_STD_ERR". The type of data to read. Only used if "setno" is a str.

Definition at line 56 of file fiff_evoked.cpp.

◆ FiffEvoked() [3/3]

FiffEvoked::FiffEvoked ( const FiffEvoked & p_FiffEvoked )

Copy constructor.

Parameters

[in] p_FiffEvoked Fiff evoked data which should be copied.

Definition at line 71 of file fiff_evoked.cpp.

◆ ~FiffEvoked()

FiffEvoked::~FiffEvoked ( )

Destroys the FiffEvoked.

Definition at line 87 of file fiff_evoked.cpp.

Member Function Documentation

◆ applyBaselineCorrection()

void FiffEvoked::applyBaselineCorrection ( QPair< float, float > & p_baseline )

Applies baseline correction to the evoked data.

Parameters

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

Definition at line 574 of file fiff_evoked.cpp.

◆ aspectKindToString()

QString FIFFLIB::FiffEvoked::aspectKindToString ( ) const

inline

Provides the python Evoked string formatted aspect_kind, which is stored in kind: "average" <-> FIFFV_ASPECT_AVERAGE, "standard_error" <-> FIFFV_ASPECT_STD_ERR or "unknown"

Returns: string formatted aspect_kind.

Definition at line 295 of file fiff_evoked.h.

◆ ch_names()

QStringList FIFFLIB::FiffEvoked::ch_names ( )

inline

Returns list of channel names stored in fiff info -> this is to stay consistent with python.

Returns: List of channel names.

Definition at line 288 of file fiff_evoked.h.

◆ clear()

void FiffEvoked::clear ( )

Initializes fiff evoked data.

Definition at line 93 of file fiff_evoked.cpp.

◆ combine() [1/2]

FiffEvoked FiffEvoked::combine	(	const QList< FiffEvoked > &	evokeds,
		CombineWeights	weights )

static

Merges evoked data with a predefined weighting strategy (weights="nave" or "equal").

Parameters

[in]	evokeds	The evoked data sets.
[in]	weights	The weighting strategy.

Returns: The combined evoked data, or an empty FiffEvoked if the inputs are inconsistent.

Definition at line 509 of file fiff_evoked.cpp.

◆ combine() [2/2]

FiffEvoked FIFFLIB::FiffEvoked::combine	(	const QList< FiffEvoked > &	evokeds,
		const Eigen::VectorXd &	weights )

static

Merges evoked data by weighted addition or subtraction (mne.combine_evoked).

All data sets must have the same channels and time instants. The result carries the union of the bad channels, the weighted sum of the data, a comment such as "0.474 × A + 0.526 × B" and nave = 1 / sum(w_i^2 / nave_i), rounded to an integer as required by the FIFF format.

Parameters

[in]	evokeds	The evoked data sets.
[in]	weights	One weight per data set.

Returns: The combined evoked data, or an empty FiffEvoked if the inputs are inconsistent.

◆ isEmpty()

bool FIFFLIB::FiffEvoked::isEmpty ( ) const

inline

Returns whether FiffEvoked is empty.

Returns: true if is empty, false otherwise.

Definition at line 307 of file fiff_evoked.h.

◆ operator+=()

FiffEvoked & FiffEvoked::operator+= ( const Eigen::MatrixXd & newData )

Inputs a new data set and recalculates the average. This function also iterates the nave parameter by one.

Parameters

[in] newData the new data set which is to be added to the current average.

Returns: the updated FiffEvoked.

Definition at line 482 of file fiff_evoked.cpp.

◆ operator=()

FiffEvoked & FIFFLIB::FiffEvoked::operator= ( const FiffEvoked & 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()

FiffEvoked FiffEvoked::pick_channels	(	const QStringList &	include = defaultQStringList,
		const QStringList &	exclude = defaultQStringList ) const

fiff_pick_channels_evoked

Pick desired channels from evoked-response data

Parameters

[in]	include	- Channels to include (if empty, include all available).
[in]	exclude	- Channels to exclude (if empty, do not exclude any).

Returns: the desired fiff evoked data.

Definition at line 108 of file fiff_evoked.cpp.

◆ read()

bool FiffEvoked::read	(	QIODevice &	p_IODevice,
		FiffEvoked &	p_FiffEvoked,
		QVariant	setno = 0,
		QPair< float, float >	t_baseline = defaultFloatPair,
		bool	proj = true,
		fiff_int_t	p_aspect_kind = FIFFV_ASPECT_AVERAGE )

static

fiff_read_evoked

Wrapper for the FiffEvokedDataSet::read_evoked static function

Read one evoked data set

Parameters

[in]	p_IODevice	An fiff IO device like a fiff QFile or QTCPSocket.
[out]	p_FiffEvoked	The read evoked data.
[in]	setno	the set to pick. Dataset ID number (int) or comment/name (str). Optional if there isonly one data set in file.
[in]	t_baseline	The time interval to apply rescaling / baseline correction. If None do not apply it. If baseline is (a, b). the interval is between "a (s)" and "b (s)". If a is None the beginning of the data is used and if b is None then b is set to the end of the interval. If baseline is equal ot (None, None) all the time interval is used. If None, no correction is applied.
[in]	proj	Apply SSP projection vectors (optional, default = true).
[in]	p_aspect_kind	Either "FIFFV_ASPECT_AVERAGE" or "FIFFV_ASPECT_STD_ERR". The type of data to read. Only used if "setno" is a str.

Returns: true if successful, false otherwise.

Definition at line 144 of file fiff_evoked.cpp.

◆ setInfo()

void FiffEvoked::setInfo	(	const FiffInfo &	p_info,
		bool	applyProj = true )

Set a new fiff measurement info

Parameters

[in]	p_info	Info to set.
[in]	applyProj	Apply SSP projection vectors (optional, default = true).

Definition at line 453 of file fiff_evoked.cpp.

Member Data Documentation

◆ aspect_kind

fiff_int_t FIFFLIB::FiffEvoked::aspect_kind

Aspect identifier, either FIFFV_ASPECT_AVERAGE or FIFFV_ASPECT_STD_ERR.

Definition at line 274 of file fiff_evoked.h.

◆ baseline

QPair<float, float> FIFFLIB::FiffEvoked::baseline

Baseline information in seconds form where the seconds are seen relative to the trigger, meaning they can also be negative [from to]

Definition at line 281 of file fiff_evoked.h.

◆ comment

QString FIFFLIB::FiffEvoked::comment

Comment on dataset. Can be the condition.

Definition at line 277 of file fiff_evoked.h.

◆ data

Eigen::MatrixXd FIFFLIB::FiffEvoked::data

2D array of shape [n_channels x n_times]; Evoked response.

Definition at line 279 of file fiff_evoked.h.

◆ first

fiff_int_t FIFFLIB::FiffEvoked::first

First time sample.

Definition at line 275 of file fiff_evoked.h.

◆ info

FiffInfo FIFFLIB::FiffEvoked::info

Measurement info.

Definition at line 272 of file fiff_evoked.h.

◆ last

fiff_int_t FIFFLIB::FiffEvoked::last

Last time sample.

Definition at line 276 of file fiff_evoked.h.

◆ nave

fiff_int_t FIFFLIB::FiffEvoked::nave

Number of averaged epochs.

Definition at line 273 of file fiff_evoked.h.

◆ proj

Eigen::MatrixXd FIFFLIB::FiffEvoked::proj

SSP projection.

Definition at line 280 of file fiff_evoked.h.

◆ times

Eigen::RowVectorXf FIFFLIB::FiffEvoked::times

Vector of time instants in seconds.

Definition at line 278 of file fiff_evoked.h.

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

src/libraries/fiff/fiff_evoked.h
src/libraries/fiff/fiff_evoked.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ ConstUPtr

◆ SPtr

◆ UPtr

Member Enumeration Documentation

◆ CombineWeights

Constructor & Destructor Documentation

◆ FiffEvoked() [1/3]

◆ FiffEvoked() [2/3]

◆ FiffEvoked() [3/3]

◆ ~FiffEvoked()

Member Function Documentation

◆ applyBaselineCorrection()

◆ aspectKindToString()

◆ ch_names()

◆ clear()

◆ combine() [1/2]

◆ combine() [2/2]

◆ isEmpty()

◆ operator+=()

◆ operator=()

◆ pick_channels()

◆ read()

◆ setInfo()

Member Data Documentation

◆ aspect_kind

◆ baseline

◆ comment

◆ data

◆ first

◆ info

◆ last

◆ nave

◆ proj

◆ times