FWDLIB::FwdEegSphereModelSet Class Reference

Collection of FwdEegSphereModel objects for multi-model EEG forward solutions. More...

#include <fwd_eeg_sphere_model_set.h>

Public Types
typedef std::unique_ptr< FwdEegSphereModelSet >	UPtr

Public Member Functions
	FwdEegSphereModelSet ()
	~FwdEegSphereModelSet ()
	FwdEegSphereModelSet (const FwdEegSphereModelSet &)=delete
FwdEegSphereModelSet &	operator= (const FwdEegSphereModelSet &)=delete
	FwdEegSphereModelSet (FwdEegSphereModelSet &&)=default
FwdEegSphereModelSet &	operator= (FwdEegSphereModelSet &&)=default
FwdEegSphereModel *	fwd_select_eeg_sphere_model (const QString &p_sName)
void	fwd_list_eeg_sphere_models ()
int	nmodel () const

Static Public Member Functions
static FwdEegSphereModelSet *	fwd_add_to_eeg_sphere_model_set (FwdEegSphereModelSet *s, FwdEegSphereModel::UPtr m)
static FwdEegSphereModelSet *	fwd_add_default_eeg_sphere_model (FwdEegSphereModelSet *s)
static FwdEegSphereModelSet *	fwd_load_eeg_sphere_models (const QString &p_sFileName, FwdEegSphereModelSet *now)

Public Attributes
std::vector< FwdEegSphereModel::UPtr >	models

Detailed Description

Collection of FwdEegSphereModel objects for multi-model EEG forward solutions.

Definitions for the EEG Sphere Model Set (Replaces *fwdEegSphereModelSet,fwdEegSphereModelSetRec struct of MNE-C fwd_types.h).

Definition at line 81 of file fwd_eeg_sphere_model_set.h.

Member Typedef Documentation

UPtr

typedef std::unique_ptr<FwdEegSphereModelSet> FWDLIB::FwdEegSphereModelSet::UPtr

Unique pointer type for FwdEegSphereModelSet.

Definition at line 85 of file fwd_eeg_sphere_model_set.h.

Constructor & Destructor Documentation

FwdEegSphereModelSet() [1/3]

FwdEegSphereModelSet::FwdEegSphereModelSet

(

)

Constructs a Forward EEG Sphere Model Set object.

Definition at line 66 of file fwd_eeg_sphere_model_set.cpp.

~FwdEegSphereModelSet()

FwdEegSphereModelSet::~FwdEegSphereModelSet

(

)

Destroys the Forward EEG Sphere Model Set description

Definition at line 72 of file fwd_eeg_sphere_model_set.cpp.

FwdEegSphereModelSet() [2/3]

FWDLIB::FwdEegSphereModelSet::FwdEegSphereModelSet ( const FwdEegSphereModelSet & )

delete

FwdEegSphereModelSet() [3/3]

FWDLIB::FwdEegSphereModelSet::FwdEegSphereModelSet ( FwdEegSphereModelSet && )

default

Member Function Documentation

fwd_add_default_eeg_sphere_model()

FwdEegSphereModelSet * FwdEegSphereModelSet::fwd_add_default_eeg_sphere_model ( FwdEegSphereModelSet * s )

static

Choose and setup the default EEG sphere model Refactored from: fwd_eeg_sphere_models.c

Parameters

[in]

s

The model set to which loaded models are added.

Returns

The model set with the default model (s + default models).

Definition at line 89 of file fwd_eeg_sphere_model_set.cpp.

fwd_add_to_eeg_sphere_model_set()

FwdEegSphereModelSet * FwdEegSphereModelSet::fwd_add_to_eeg_sphere_model_set ( FwdEegSphereModelSet * s, FwdEegSphereModel::UPtr m )

static

Add a model to a set. The model will be owned by the set.

Parameters

[in]	s	The model set (created if nullptr).
[in]	m	The model to add (ownership transferred).

Returns

The model set.

Definition at line 78 of file fwd_eeg_sphere_model_set.cpp.

fwd_list_eeg_sphere_models()

void FwdEegSphereModelSet::fwd_list_eeg_sphere_models

(

)

List the properties of available models via qInfo.

Definition at line 177 of file fwd_eeg_sphere_model_set.cpp.

fwd_load_eeg_sphere_models()

FwdEegSphereModelSet * FwdEegSphereModelSet::fwd_load_eeg_sphere_models ( const QString & p_sFileName, FwdEegSphereModelSet * now )

static

Load all models available in the specified file Refactored from: fwd_eeg_sphere_models.c

Parameters

[in]	p_sFileName	file name to load models from.
[in]	now	The model set to which loaded models are added.

Returns

The loaded model set (now + loaded models).

Definition at line 103 of file fwd_eeg_sphere_model_set.cpp.

fwd_select_eeg_sphere_model()

FwdEegSphereModel * FwdEegSphereModelSet::fwd_select_eeg_sphere_model

(

const QString &

p_sName

)

Find a model with a given name and return a duplicate Refactored from: fwd_eeg_sphere_models.c

Parameters

[in]

p_sName

Name of the model to find.

Returns

A duplicat of the found model.

Definition at line 153 of file fwd_eeg_sphere_model_set.cpp.

nmodel()

int FWDLIB::FwdEegSphereModelSet::nmodel ( ) const

inline

Number of models in this set.

Definition at line 156 of file fwd_eeg_sphere_model_set.h.

operator=() [1/2]

FwdEegSphereModelSet & FWDLIB::FwdEegSphereModelSet::operator= ( const FwdEegSphereModelSet & )

delete

operator=() [2/2]

FwdEegSphereModelSet & FWDLIB::FwdEegSphereModelSet::operator= ( FwdEegSphereModelSet && )

default

Member Data Documentation

models

std::vector<FwdEegSphereModel::UPtr> FWDLIB::FwdEegSphereModelSet::models

Set of EEG sphere model definitions.

Definition at line 162 of file fwd_eeg_sphere_model_set.h.

---

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

• src/libraries/fwd/fwd_eeg_sphere_model_set.h
• src/libraries/fwd/fwd_eeg_sphere_model_set.cpp