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

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

#include <ecd_set.h>

Public Types

typedef QSharedPointer< ECDSetSPtr
 
typedef QSharedPointer< const ECDSetConstSPtr
 

Public Member Functions

 ECDSet ()
 
 ECDSet (const ECDSet &p_ECDSet)
 
 ~ECDSet ()
 
void addEcd (const ECD &p_ecd)
 
bool save_dipoles_bdip (const QString &fileName)
 
bool save_dipoles_dip (const QString &fileName) const
 
qint32 size () const
 
const ECDoperator[] (int idx) const
 
ECDoperator[] (int idx)
 
ECDSetoperator<< (const ECD &p_ecd)
 

Static Public Member Functions

static ECDSet read_dipoles_dip (const QString &fileName)
 

Public Attributes

QString dataname
 

Detailed Description

Holds a set of Electric Current Dipoles.

Implements Electric Current Dipole Set (Replaces *ecdSet,ecdSetRec struct of MNE-C fit_types.h).

Definition at line 80 of file ecd_set.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const ECDSet> INVERSELIB::ECDSet::ConstSPtr

Const shared pointer type for ECDSet.

Definition at line 85 of file ecd_set.h.

◆ SPtr

typedef QSharedPointer<ECDSet> INVERSELIB::ECDSet::SPtr

Shared pointer type for ECDSet.

Definition at line 84 of file ecd_set.h.

Constructor & Destructor Documentation

◆ ECDSet() [1/2]

ECDSet::ECDSet ( )

Constructs a Electric Current Dipole Set object.

Definition at line 138 of file ecd_set.cpp.

◆ ECDSet() [2/2]

ECDSet::ECDSet ( const ECDSet p_ECDSet)

Copy constructor.

Parameters
[in]p_ECDSetElectric Current Dipole Set which should be copied.

Definition at line 144 of file ecd_set.cpp.

◆ ~ECDSet()

ECDSet::~ECDSet ( )

Destroys the Electric Current Dipole description

Definition at line 152 of file ecd_set.cpp.

Member Function Documentation

◆ addEcd()

void ECDSet::addEcd ( const ECD p_ecd)

Appends an Electric Current Dipole to the set

Definition at line 158 of file ecd_set.cpp.

◆ operator<<()

ECDSet & ECDSet::operator<< ( const ECD p_ecd)

Subscript operator << to add a new ECD

Parameters
[in]p_ecdECD to be added.
Returns
ECDSet.

Definition at line 335 of file ecd_set.cpp.

◆ operator[]() [1/2]

const ECD & ECDSet::operator[] ( int  idx) const

Subscript operator [] to access ECD by index

Parameters
[in]idxthe ECD index.
Returns
ECD related to the parameter index.

Definition at line 311 of file ecd_set.cpp.

◆ operator[]() [2/2]

ECD & ECDSet::operator[] ( int  idx)

Subscript operator [] to access ECD by index

Parameters
[in]idxthe ECD index.
Returns
ECD related to the parameter index.

Definition at line 323 of file ecd_set.cpp.

◆ read_dipoles_dip()

ECDSet ECDSet::read_dipoles_dip ( const QString &  fileName)
static

Read dipoles from the dip format compatible with mrilab

Parameters
[in]nameFile name to read from.

Definition at line 165 of file ecd_set.cpp.

◆ save_dipoles_bdip()

bool ECDSet::save_dipoles_bdip ( const QString &  fileName)

Save dipoles in the bdip format employed by xfit

Parameters
[in]fileNameFile name to save to.

Definition at line 208 of file ecd_set.cpp.

◆ save_dipoles_dip()

bool ECDSet::save_dipoles_dip ( const QString &  fileName) const

Save dipoles in the dip format suitable for mrilab

Parameters
[in]fileNameFile name to save to.

Definition at line 266 of file ecd_set.cpp.

◆ size()

qint32 INVERSELIB::ECDSet::size ( ) const
inline

Returns the number of stored ECDs

Returns
number of stored ECDs.

Definition at line 193 of file ecd_set.h.

Member Data Documentation

◆ dataname

QString INVERSELIB::ECDSet::dataname

The associated data file.

Definition at line 176 of file ecd_set.h.


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