MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
FWDLIB::FwdEegSphereModelSet Class Reference

Holds a set of Electric Current Dipoles. More...

#include <fwd_eeg_sphere_model_set.h>

Public Types

typedef QSharedPointer< FwdEegSphereModelSetSPtr
 
typedef QSharedPointer< const FwdEegSphereModelSetConstSPtr
 

Public Member Functions

 FwdEegSphereModelSet ()
 
 ~FwdEegSphereModelSet ()
 
FwdEegSphereModelfwd_select_eeg_sphere_model (const QString &p_sName)
 
void fwd_list_eeg_sphere_models (FILE *f)
 
int nmodel () const
 

Static Public Member Functions

static FwdEegSphereModelSetfwd_add_to_eeg_sphere_model_set (FwdEegSphereModelSet *s, FwdEegSphereModel *m)
 
static FwdEegSphereModelSetfwd_add_default_eeg_sphere_model (FwdEegSphereModelSet *s)
 
static FwdEegSphereModelSetfwd_load_eeg_sphere_models (const QString &p_sFileName, FwdEegSphereModelSet *now)
 

Public Attributes

QList< FwdEegSphereModel * > models
 

Detailed Description

Holds a set of Electric Current Dipoles.

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

Definition at line 80 of file fwd_eeg_sphere_model_set.h.

Member Typedef Documentation

◆ ConstSPtr

Const shared pointer type for FwdEegSphereModelSet.

Definition at line 85 of file fwd_eeg_sphere_model_set.h.

◆ SPtr

Shared pointer type for FwdEegSphereModelSet.

Definition at line 84 of file fwd_eeg_sphere_model_set.h.

Constructor & Destructor Documentation

◆ FwdEegSphereModelSet()

FwdEegSphereModelSet::FwdEegSphereModelSet ( )

Constructs a Forward EEG Sphere Model Set object.

Definition at line 91 of file fwd_eeg_sphere_model_set.cpp.

◆ ~FwdEegSphereModelSet()

FwdEegSphereModelSet::~FwdEegSphereModelSet ( )

Copy constructor.

Parameters
[in]p_FwdEegSphereModelSetForward EEG Sphere Model Set which should be copied Destroys the Forward EEG Sphere Model Set description Refactored: fwd_free_eeg_sphere_model_set

Definition at line 105 of file fwd_eeg_sphere_model_set.cpp.

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]sThe model set to which loaded models are added.
Returns
The model set with the default model (s + default models).

Definition at line 144 of file fwd_eeg_sphere_model_set.cpp.

◆ fwd_list_eeg_sphere_models()

void FwdEegSphereModelSet::fwd_list_eeg_sphere_models ( FILE *  f)

List the properties of available models Refactored from: dipole_fit_setup.c

Parameters
[in]fstd output stream.

Definition at line 260 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_sFileNamefile name to load models from.
[in]nowThe model set to which loaded models are added.
Returns
The loaded model set (now + loaded models).

Definition at line 158 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_sNameName of the model to find.
Returns
A duplicat of the found model.

Definition at line 234 of file fwd_eeg_sphere_model_set.cpp.

◆ nmodel()

int FWDLIB::FwdEegSphereModelSet::nmodel ( ) const
inline

Appends an orward EEG Sphere Model to the set Returns the number of stored FwdEegSphereModels

Returns
number of stored FwdEegSphereModels Subscript operator [] to access FwdEegSphereModel by index
Parameters
[in]idxthe FwdEegSphereModel index.
Returns
FwdEegSphereModel related to the parameter index. Subscript operator [] to access FwdEegSphereModel by index
Parameters
[in]idxthe FwdEegSphereModel index.
Returns
FwdEegSphereModel related to the parameter index. Subscript operator << to add a new FwdEegSphereModel
Parameters
[in]p_FwdEegSphereModelFwdEegSphereModel to be added
Returns
FwdEegSphereModelSet

Definition at line 208 of file fwd_eeg_sphere_model_set.h.

Member Data Documentation

◆ models

QList<FwdEegSphereModel*> FWDLIB::FwdEegSphereModelSet::models

Set of EEG sphere model definitions.

Definition at line 216 of file fwd_eeg_sphere_model_set.h.


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