MNELIB::MNEBem Class Reference

BEM descritpion. More...

#include <mne_bem.h>

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

Public Member Functions
	MNEBem ()
	MNEBem (const MNEBem &p_MNEBem)
	MNEBem (QIODevice &p_IODevice)
	~MNEBem ()
void	clear ()
bool	isEmpty () const
qint32	size () const
void	write (QIODevice &p_IODevice)
void	writeToStream (FIFFLIB::FiffStream *p_pStream)
const MNEBemSurface &	operator[] (qint32 idx) const
MNEBemSurface &	operator[] (qint32 idx)
MNEBem &	operator<< (const MNEBemSurface &surf)
MNEBem &	operator<< (const MNEBemSurface *surf)
void	warp (const Eigen::MatrixXf &sLm, const Eigen::MatrixXf &dLm)
void	transform (const FIFFLIB::FiffCoordTrans &trans)
void	invtransform (const FIFFLIB::FiffCoordTrans &trans)

Static Public Member Functions
static bool	readFromStream (FIFFLIB::FiffStream::SPtr &p_pStream, bool add_geom, MNEBem &p_Bem)

Static Protected Member Functions
static bool	readBemSurface (FIFFLIB::FiffStream::SPtr &p_pStream, const FIFFLIB::FiffDirNode::SPtr &p_Tree, MNEBemSurface &p_BemSurface)

Detailed Description

BEM descritpion.

BEM descritpion

Definition at line 89 of file mne_bem.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for MNEBem.

Definition at line 94 of file mne_bem.h.

SPtr

typedef QSharedPointer<MNEBem> MNELIB::MNEBem::SPtr

Shared pointer type for MNEBem.

Definition at line 93 of file mne_bem.h.

Constructor & Destructor Documentation

MNEBem() [1/3]

MNEBem::MNEBem

(

)

Default constructor

Definition at line 70 of file mne_bem.cpp.

MNEBem() [2/3]

MNEBem::MNEBem

(

const MNEBem &

p_MNEBem

)

Copy constructor.

Parameters

[in]

p_MNEBem

MNE BEM.

Definition at line 76 of file mne_bem.cpp.

MNEBem() [3/3]

MNEBem::MNEBem

(

QIODevice &

p_IODevice

)

Default constructor

Definition at line 83 of file mne_bem.cpp.

~MNEBem()

MNEBem::~MNEBem

(

)

Destroys the MNE Bem

Definition at line 101 of file mne_bem.cpp.

Member Function Documentation

clear()

void MNEBem::clear

(

)

Initializes MNE Bem

Definition at line 107 of file mne_bem.cpp.

invtransform()

void MNEBem::invtransform

(

const FIFFLIB::FiffCoordTrans &

trans

)

Transform the Bem using the inverse

Parameters

[in]

trans

The Transformation Matrix.

Definition at line 467 of file mne_bem.cpp.

isEmpty()

bool MNELIB::MNEBem::isEmpty ( ) const

inline

True if MNE Bem is empty.

Returns

true if MNE Bem is empty.

Definition at line 264 of file mne_bem.h.

operator<<() [1/2]

MNEBem & MNEBem::operator<<

(

const MNEBemSurface &

surf

)

Subscript operator << to add a new bem_surface

Parameters

[in]

surf

BemSurface to be added.

Returns

MNEBem.

Definition at line 417 of file mne_bem.cpp.

operator<<() [2/2]

MNEBem & MNEBem::operator<<

(

const MNEBemSurface *

surf

)

Subscript operator << to add a new bem_surface

Parameters

[in]

surf

BemSurface to be added.

Returns

MNEBem.

Definition at line 425 of file mne_bem.cpp.

operator[]() [1/2]

MNEBemSurface & MNEBem::operator[]

(

qint32

idx

)

Subscript operator [] to access bem_surface by index

Parameters

[in]

idx

the surface index (0,1 or 2).

Returns

MNEBemSurface related to the parameter index.

Definition at line 405 of file mne_bem.cpp.

operator[]() [2/2]

const MNEBemSurface & MNEBem::operator[]

(

qint32

idx

)

const

Subscript operator [] to access bem_surface by index

Parameters

[in]

idx

the surface index (0,1 or 2).

Returns

MNEBemSurface related to the parameter index.

Definition at line 393 of file mne_bem.cpp.

readBemSurface()

bool MNEBem::readBemSurface ( FIFFLIB::FiffStream::SPtr &  p_pStream, const FIFFLIB::FiffDirNode::SPtr &  p_Tree, MNEBemSurface &  p_BemSurface  )

staticprotected

Definition of the read_bem_surface function in e.g. mne_read_bem_surface.m Reads a single bem surface

Parameters

[in]	p_pStream	The opened fif file.
[in]	p_Tree	Search for the bem surface here.
[in,out]	p_BemSurface	The read BemSurface.

Returns

true if succeeded, false otherwise.

Definition at line 190 of file mne_bem.cpp.

readFromStream()

bool MNEBem::readFromStream ( FIFFLIB::FiffStream::SPtr &  p_pStream, bool  add_geom, MNEBem &  p_Bem  )

static

MNE toolbox root function ###: Definition of the mne_read_bem_surface function

Reads Bem surface from a fif file

Parameters

[in,out]	p_pStream	The opened fif file.
[in]	add_geom	Add geometry information to the Bem Surface.

Returns

true if succeeded, false otherwise.

Definition at line 114 of file mne_bem.cpp.

size()

qint32 MNELIB::MNEBem::size ( ) const

inline

Returns the number of stored bem surfaces

Returns

number of stored bem surfaces.

Definition at line 271 of file mne_bem.h.

transform()

void MNEBem::transform

(

const FIFFLIB::FiffCoordTrans &

trans

)

Transform the Bem

Parameters

[in]

trans

The Transformation Matrix.

Definition at line 453 of file mne_bem.cpp.

warp()

void MNEBem::warp	(	const Eigen::MatrixXf &	sLm,
		const Eigen::MatrixXf &	dLm
	)

Warp the Bem

Parameters

[in]	sLm	3D Landmarks of the source geometry.
[in]	dLm	3D Landmarks of the destination geometry.

Definition at line 433 of file mne_bem.cpp.

write()

void MNEBem::write

(

QIODevice &

p_IODevice

)

MNE Toolbox function mne_write_bem_surfaces_block

Write the Bem to a FIF file

Parameters

[in]

p_IODevice

IO device to write the bem to.

Definition at line 361 of file mne_bem.cpp.

writeToStream()

void MNEBem::writeToStream

(

FIFFLIB::FiffStream *

p_pStream

)

MNE Toolbox function mne_write_bem_surfaces_block

Write the Bem to a FIF stream

Parameters

[in]

p_pStream

The stream to write to.

Definition at line 376 of file mne_bem.cpp.

---

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

• src/libraries/mne/mne_bem.h
• src/libraries/mne/mne_bem.cpp