INVLIB::InvEcdSet Class Reference

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

#include <inv_ecd_set.h>

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

Public Member Functions
	InvEcdSet ()
	InvEcdSet (const InvEcdSet &p_ECDSet)
	~InvEcdSet ()
void	addEcd (const InvEcd &p_ecd)
bool	save_dipoles_bdip (const QString &fileName)
bool	save_dipoles_dip (const QString &fileName) const
qint32	size () const
const InvEcd &	operator[] (int idx) const
InvEcd &	operator[] (int idx)
InvEcdSet &	operator<< (const InvEcd &p_ecd)

Static Public Member Functions
static InvEcdSet	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 inv_ecd_set.h.

Member Typedef Documentation

ConstSPtr

typedef QSharedPointer<const InvEcdSet> INVLIB::InvEcdSet::ConstSPtr

Const shared pointer type for InvEcdSet.

Definition at line 85 of file inv_ecd_set.h.

SPtr

typedef QSharedPointer<InvEcdSet> INVLIB::InvEcdSet::SPtr

Shared pointer type for InvEcdSet.

Definition at line 84 of file inv_ecd_set.h.

Constructor & Destructor Documentation

InvEcdSet() [1/2]

InvEcdSet::InvEcdSet

(

)

Constructs a Electric Current Dipole Set object.

Definition at line 142 of file inv_ecd_set.cpp.

InvEcdSet() [2/2]

InvEcdSet::InvEcdSet

(

const InvEcdSet &

p_ECDSet

)

Copy constructor.

Parameters

[in]

p_ECDSet

Electric Current Dipole Set which should be copied.

Definition at line 148 of file inv_ecd_set.cpp.

~InvEcdSet()

InvEcdSet::~InvEcdSet

(

)

Destroys the Electric Current Dipole description

Definition at line 156 of file inv_ecd_set.cpp.

Member Function Documentation

addEcd()

void InvEcdSet::addEcd

(

const InvEcd &

p_ecd

)

Appends an Electric Current Dipole to the set

Definition at line 162 of file inv_ecd_set.cpp.

operator<<()

InvEcdSet & InvEcdSet::operator<<

(

const InvEcd &

p_ecd

)

Subscript operator << to add a new InvEcd

Parameters

[in]

p_ecd

InvEcd to be added.

Returns

InvEcdSet.

Definition at line 339 of file inv_ecd_set.cpp.

operator[]() [1/2]

InvEcd & InvEcdSet::operator[]

(

int

idx

)

Subscript operator [] to access InvEcd by index

Parameters

[in]

idx

the InvEcd index.

Returns

InvEcd related to the parameter index.

Definition at line 327 of file inv_ecd_set.cpp.

operator[]() [2/2]

const InvEcd & InvEcdSet::operator[]

(

int

idx

)

const

Subscript operator [] to access InvEcd by index

Parameters

[in]

idx

the InvEcd index.

Returns

InvEcd related to the parameter index.

Definition at line 315 of file inv_ecd_set.cpp.

read_dipoles_dip()

InvEcdSet InvEcdSet::read_dipoles_dip ( const QString & fileName )

static

Read dipoles from the dip format compatible with mrilab

Parameters

[in]

name

File name to read from.

Definition at line 169 of file inv_ecd_set.cpp.

save_dipoles_bdip()

bool InvEcdSet::save_dipoles_bdip

(

const QString &

fileName

)

Save dipoles in the bdip format employed by xfit

Parameters

[in]

fileName

File name to save to.

Definition at line 212 of file inv_ecd_set.cpp.

save_dipoles_dip()

bool InvEcdSet::save_dipoles_dip

(

const QString &

fileName

)

const

Save dipoles in the dip format suitable for mrilab

Parameters

[in]

fileName

File name to save to.

Definition at line 270 of file inv_ecd_set.cpp.

size()

qint32 INVLIB::InvEcdSet::size ( ) const

inline

Returns the number of stored ECDs

Returns

number of stored ECDs.

Definition at line 186 of file inv_ecd_set.h.

Member Data Documentation

dataname

QString INVLIB::InvEcdSet::dataname

The associated data file.

Definition at line 176 of file inv_ecd_set.h.

---

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

• src/libraries/inv/dipole_fit/inv_ecd_set.h
• src/libraries/inv/dipole_fit/inv_ecd_set.cpp