v2.0.0
Loading...
Searching...
No Matches
fiff_evoked_set.h File Reference

Set of averaged evoked responses sharing a FiffInfo, plus the ave-style category / rejection descriptors for batch averaging. More...

#include "fiff_info.h"
#include "fiff_evoked.h"
#include "fiff_global.h"
#include <Eigen/Core>
#include <QVector>
#include <QIODevice>
#include <QList>
#include <QSharedPointer>
#include <QStringList>
#include <memory>
Include dependency graph for fiff_evoked_set.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  AverageCategory
 One averaging category in an MNE-C ave-description file: trigger logic, timing window, baseline interval and display color. More...
struct  AverageDescription
 Top-level MNE-C ave-description record: comment, category list, shared rejection limits and output file paths. More...
class  FiffEvokedSet
 Set of FiffEvoked instances sharing one FiffInfo, plus channel-picking and compensation helpers. More...

Macros

#define metatype_fiffevokedset
#define metatype_fiffevokedsetsptr

Functions

 Q_DECLARE_METATYPE (FIFFLIB::FiffEvokedSet)
 Q_DECLARE_METATYPE (FIFFLIB::FiffEvokedSet::SPtr)

Variables

float megGradReject = 2000e-13f
float megMagReject = 3e-12f
float eegReject = 100e-6f
float eogReject = 150e-6f
float ecgReject = 0.0f
float megGradFlat = 0.0f
float megMagFlat = 0.0f
float eegFlat = 0.0f
float eogFlat = 0.0f
float ecgFlat = 0.0f

Detailed Description

Set of averaged evoked responses sharing a FiffInfo, plus the ave-style category / rejection descriptors for batch averaging.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2013-2026 MNE-CPP Authors

Author
Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org; Florian Schlembach fschl.nosp@m.emba.nosp@m.ch@we.nosp@m.b.de; Lorenz Esch loren.nosp@m.z.es.nosp@m.ch@tu.nosp@m.-ilm.nosp@m.enau..nosp@m.de; Gabriel Motta gabri.nosp@m.elbe.nosp@m.nmott.nosp@m.a@gm.nosp@m.ail.c.nosp@m.om; Juan GPC jgarc.nosp@m.iapr.nosp@m.ieto@.nosp@m.mgh..nosp@m.harva.nosp@m.rd.e.nosp@m.du
Since
0.1.0
Date
March 2013

A single *-ave.fif typically contains several FIFFB_EVOKED blocks (one per stimulus condition / averaging category). FiffEvokedSet groups them: a shared FiffInfo and a list of FiffEvoked instances, plus channel-picking and compensation helpers that apply uniformly to the whole set.

The header additionally ports the three batch-averaging descriptor structs from MNE-C's browser_types.h (RejectionParams, AverageCategory, AverageDescription) so the mne_browse_raw ``ave description'' files can be parsed and consumed verbatim. Together they describe artifact-rejection thresholds, per-category timing and trigger logic, and the file-level output settings used by the mne_process_raw averaging pipeline. */


INCLUDES


QT INCLUDES


EIGEN INCLUDES


DEFINE NAMESPACE MNELIB

namespace FIFFLIB {

class FiffRawData;


/**

Artifact-rejection thresholds for the MNE-C batch averaging pipeline (gradiometer / magnetometer / EEG / EOG / ECG, peak-to-peak and flatness).

Field-for-field port of rejDataRec from MNE-C browser_types.h. Used by AverageDescription to drive mne_process_raw's peak-to-peak and flatness rejection when computing batch evokeds; the default values match the MNE-C defaults so existing ``ave description'' files keep producing identical results. */ struct RejectionParams { float stimIgnore = 0.0f; /**< Ignore this many seconds around the stimulus.

Definition in file fiff_evoked_set.h.

Macro Definition Documentation

◆ metatype_fiffevokedset

#define metatype_fiffevokedset

Definition at line 333 of file fiff_evoked_set.h.

◆ metatype_fiffevokedsetsptr

#define metatype_fiffevokedsetsptr

Definition at line 338 of file fiff_evoked_set.h.

Function Documentation

◆ Q_DECLARE_METATYPE() [1/2]

Q_DECLARE_METATYPE ( FIFFLIB::FiffEvokedSet )

Provides QT META type declaration of the FIFFLIB::FiffEvokedSet type. For signal/slot and QVariant usage.

◆ Q_DECLARE_METATYPE() [2/2]

Q_DECLARE_METATYPE ( FIFFLIB::FiffEvokedSet::SPtr )

Provides QT META type declaration of the FIFFLIB::FiffEvokedSet type. For signal/slot and QVariant usage.

Variable Documentation

◆ ecgFlat

float ecgFlat = 0.0f

ECG flatness (V).

Definition at line 91 of file fiff_evoked_set.h.

◆ ecgReject

float ecgReject = 0.0f

ECG rejection (V).

Definition at line 86 of file fiff_evoked_set.h.

◆ eegFlat

float eegFlat = 0.0f

EEG flatness (V).

Definition at line 89 of file fiff_evoked_set.h.

◆ eegReject

float eegReject = 100e-6f

EEG rejection (V).

Definition at line 84 of file fiff_evoked_set.h.

◆ eogFlat

float eogFlat = 0.0f

EOG flatness (V).

Definition at line 90 of file fiff_evoked_set.h.

◆ eogReject

float eogReject = 150e-6f

EOG rejection (V).

Definition at line 85 of file fiff_evoked_set.h.

◆ megGradFlat

float megGradFlat = 0.0f

Gradiometer flatness (T/m).

Definition at line 87 of file fiff_evoked_set.h.

◆ megGradReject

float megGradReject = 2000e-13f

Gradiometer rejection (T/m).

Definition at line 82 of file fiff_evoked_set.h.

◆ megMagFlat

float megMagFlat = 0.0f

Magnetometer flatness (T).

Definition at line 88 of file fiff_evoked_set.h.

◆ megMagReject

float megMagReject = 3e-12f

Magnetometer rejection (T).

Definition at line 83 of file fiff_evoked_set.h.