One item in a derivation data set. More...

#include <mne_deriv.h>

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

Public Member Functions
	MNEDeriv ()
	MNEDeriv (const MNEDeriv &other)
	~MNEDeriv ()
int	validate (const QList< FIFFLIB::FiffChInfo > &chInfo)

Public Attributes
QString	filename
QString	shortname
std::unique_ptr< MNESparseNamedMatrix >	deriv_data
Eigen::VectorXi	in_use
Eigen::VectorXi	valid
QList< FIFFLIB::FiffChInfo >	chs

Detailed Description

One item in a derivation data set.

Holds a sparse named matrix of derivation coefficients together with validity and usage metadata and matched channel information.

Definition at line 62 of file mne_deriv.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for MNEDeriv.

Definition at line 66 of file mne_deriv.h.

◆ SPtr

typedef QSharedPointer<MNEDeriv> MNELIB::MNEDeriv::SPtr

Shared pointer type for MNEDeriv.

Definition at line 65 of file mne_deriv.h.

Constructor & Destructor Documentation

◆ MNEDeriv() [1/2]

MNEDeriv::MNEDeriv ( )

default

Constructs an empty MNE Derivation.

◆ MNEDeriv() [2/2]

MNEDeriv::MNEDeriv ( const MNEDeriv & other )

Copies the derivation including its matrix.

Parameters

[in] other The derivation to copy.

Definition at line 34 of file mne_deriv.cpp.

◆ ~MNEDeriv()

MNEDeriv::~MNEDeriv ( )

default

Destructor.

Member Function Documentation

◆ validate()

int MNEDeriv::validate ( const QList< FIFFLIB::FiffChInfo > & chInfo )

Checks every derived channel against channel info (MNE-C mne_validate_deriv).

A derived channel is valid if all its inputs are present and of the same kind and unit; valid and chs are filled, chs with the info of the first input.

Parameters

[in] chInfo Channel info of the recording.

Returns: The number of valid derived channels.

Definition at line 59 of file mne_deriv.cpp.

Member Data Documentation

◆ chs

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

First matching channel info for each derivation.

Definition at line 107 of file mne_deriv.h.

◆ deriv_data

std::unique_ptr<MNESparseNamedMatrix> MNELIB::MNEDeriv::deriv_data

The derivation data itself (sparse named matrix).

Definition at line 104 of file mne_deriv.h.

◆ filename

QString MNELIB::MNEDeriv::filename

Source file name the derivation was loaded from.

Definition at line 102 of file mne_deriv.h.

◆ in_use

Eigen::VectorXi MNELIB::MNEDeriv::in_use

Per-column count of non-zero elements in the derivation data.

Definition at line 105 of file mne_deriv.h.

◆ shortname

QString MNELIB::MNEDeriv::shortname

Short nickname for this derivation.

Definition at line 103 of file mne_deriv.h.

◆ valid

Eigen::VectorXi MNELIB::MNEDeriv::valid

Per-derivation validity flags considering input channel units.

Definition at line 106 of file mne_deriv.h.

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

src/libraries/mne/mne_deriv.h
src/libraries/mne/mne_deriv.cpp

Public Types

Public Member Functions

Public Attributes