MNELIB::MNESourceSpace Class Reference

Source Space descritpion. More...

#include <mne_sourcespace.h>

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

Public Member Functions
	MNESourceSpace ()
	MNESourceSpace (const MNESourceSpace &p_MNESourceSpace)
	~MNESourceSpace ()
void	clear ()
bool	isEmpty () const
QList< Eigen::VectorXi >	get_vertno () const
QList< Eigen::VectorXi >	label_src_vertno_sel (const FSLIB::Label &p_label, Eigen::VectorXi &src_sel) const
MNESourceSpace	pick_regions (const QList< FSLIB::Label > &p_qListLabels) const
qint32	size () const
bool	transform_source_space_to (FIFFLIB::fiff_int_t dest, FIFFLIB::FiffCoordTrans &trans)
void	writeToStream (FIFFLIB::FiffStream *p_pStream)
MNEHemisphere &	operator[] (qint32 idx)
const MNEHemisphere &	operator[] (qint32 idx) const
MNEHemisphere &	operator[] (QString idt)
const MNEHemisphere &	operator[] (QString idt) const

Static Public Member Functions
static qint32	find_source_space_hemi (MNEHemisphere &p_Hemisphere)
static bool	patch_info (MNEHemisphere &p_Hemisphere)
static bool	readFromStream (FIFFLIB::FiffStream::SPtr &p_pStream, bool add_geom, MNESourceSpace &p_SourceSpace)

Friends
bool	operator== (const MNESourceSpace &a, const MNESourceSpace &b)

Detailed Description

Source Space descritpion.

Source Space descritpion

Definition at line 92 of file mne_sourcespace.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for MNESourceSpace.

Definition at line 96 of file mne_sourcespace.h.

SPtr

typedef QSharedPointer<MNESourceSpace> MNELIB::MNESourceSpace::SPtr

Shared pointer type for MNESourceSpace.

Definition at line 95 of file mne_sourcespace.h.

Constructor & Destructor Documentation

MNESourceSpace() [1/2]

MNESourceSpace::MNESourceSpace

(

)

Default constructor

Definition at line 68 of file mne_sourcespace.cpp.

MNESourceSpace() [2/2]

MNESourceSpace::MNESourceSpace

(

const MNESourceSpace &

p_MNESourceSpace

)

Copy constructor.

Parameters

[in]

p_MNESourceSpace

MNE forward solution.

Definition at line 74 of file mne_sourcespace.cpp.

~MNESourceSpace()

MNESourceSpace::~MNESourceSpace

(

)

Destroys the MNE forward solution

Definition at line 81 of file mne_sourcespace.cpp.

Member Function Documentation

clear()

void MNESourceSpace::clear

(

)

Initializes MNE source space.

Definition at line 87 of file mne_sourcespace.cpp.

find_source_space_hemi()

qint32 MNESourceSpace::find_source_space_hemi ( MNEHemisphere &  p_Hemisphere )

static

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

Returns the hemisphere id ( FIFFV_MNE_SURF_LEFT_HEMI or FIFFV_MNE_SURF_RIGHT_HEMI) for a source space.

Parameters

[in]

p_Hemisphere

the hemisphere to investigate.

Returns

the deduced hemisphere id.

Definition at line 315 of file mne_sourcespace.cpp.

get_vertno()

QList< VectorXi > MNESourceSpace::get_vertno

(

)

const

Returns the Zero based (different to MATLAB) indices of the used vertices of both hemispheres

Returns

the hemisphere vertices.

Definition at line 94 of file mne_sourcespace.cpp.

isEmpty()

bool MNELIB::MNESourceSpace::isEmpty ( ) const

inline

True if MNE Source Space is empty.

Returns

true if MNE Source Space is empty.

Definition at line 326 of file mne_sourcespace.h.

label_src_vertno_sel()

QList< VectorXi > MNESourceSpace::label_src_vertno_sel	(	const FSLIB::Label &	p_label,
		Eigen::VectorXi &	src_sel
	)		const

Find vertex numbers and indices from label

Parameters

[in]	label	Source space label.
[out]	src_sel	array of int (idx.size() = vertno[0].size() + vertno[1].size()). Indices of the selected vertices in sourse space

Returns

vertno list of length 2 Vertex numbers for lh and rh.

Definition at line 104 of file mne_sourcespace.cpp.

operator[]() [1/4]

MNEHemisphere & MNESourceSpace::operator[]

(

qint32

idx

)

Subscript operator [] to access parameter values by index

Parameters

[in]

idx

the hemisphere index (0 or 1).

Returns

Hemisphere related to the parameter index.

Definition at line 776 of file mne_sourcespace.cpp.

operator[]() [2/4]

const MNEHemisphere & MNESourceSpace::operator[]

(

qint32

idx

)

const

Subscript operator [] to access parameter values by index

Parameters

[in]

idx

the hemisphere index (0 or 1).

Returns

Hemisphere related to the parameter index.

Definition at line 789 of file mne_sourcespace.cpp.

operator[]() [3/4]

MNEHemisphere & MNESourceSpace::operator[]

(

QString

idt

)

Subscript operator [] to access parameter values by index

Parameters

[in]

idt

the hemisphere identifier ("lh" or "rh").

Returns

Hemisphere related to the parameter identifier.

Definition at line 802 of file mne_sourcespace.cpp.

operator[]() [4/4]

const MNEHemisphere & MNESourceSpace::operator[]

(

QString

idt

)

const

Subscript operator [] to access parameter values by index

Parameters

[in]

idt

the hemisphere identifier ("lh" or "rh").

Returns

Hemisphere related to the parameter identifier.

Definition at line 817 of file mne_sourcespace.cpp.

patch_info()

bool MNESourceSpace::patch_info ( MNEHemisphere &  p_Hemisphere )

static

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

Generate the patch information from the 'nearest' vector in a source space. For vertex in the source space it provides the list of neighboring vertices in the high resolution triangulation.

Parameters

[in,out]

p_Hemisphere

The source space.

Returns

true if succeeded, false otherwise.

Definition at line 577 of file mne_sourcespace.cpp.

pick_regions()

MNESourceSpace MNESourceSpace::pick_regions

(

const QList< FSLIB::Label > &

p_qListLabels

)

const

Reduces a source space to selected regions

Parameters

[in]

p_qListLabels

ROIs.

Returns

the reduced source space.

Definition at line 162 of file mne_sourcespace.cpp.

readFromStream()

bool MNESourceSpace::readFromStream ( FIFFLIB::FiffStream::SPtr &  p_pStream, bool  add_geom, MNESourceSpace &  p_SourceSpace  )

static

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

Reads source spaces from a fif file

Parameters

[in,out]	p_pStream	The opened fif file.
[in]	add_geom	Add geometry information to the source spaces.
[in,out]	p_SourceSpace	The read source spaces.

Returns

true if succeeded, false otherwise.

Definition at line 253 of file mne_sourcespace.cpp.

size()

qint32 MNELIB::MNESourceSpace::size ( ) const

inline

Returns the number of stored hemispheres 0, 1 or 2

Returns

number of stored hemispheres.

Definition at line 333 of file mne_sourcespace.h.

transform_source_space_to()

bool MNESourceSpace::transform_source_space_to	(	FIFFLIB::fiff_int_t	dest,
		FIFFLIB::FiffCoordTrans &	trans
	)

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

Wrapper for the MNESourceSpace transform_source_space_to member function

Note: In difference to mne-matlab this is not a static function. This is a method of the MNESourceSpace class, that's why a tree object doesn't need to be handed to the function.

Transforms source space data to the desired coordinate system

Parameters

[in]	dest	destination check code.
[in]	trans	transformation information.

Returns

true if succeeded, false otherwise.

Definition at line 330 of file mne_sourcespace.cpp.

writeToStream()

void MNESourceSpace::writeToStream

(

FIFFLIB::FiffStream *

p_pStream

)

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

Write the source spaces to a FIF stream

Parameters

[in]

p_pStream

The stream to write to.

Definition at line 761 of file mne_sourcespace.cpp.

Friends And Related Function Documentation

operator==

bool operator== ( const MNESourceSpace &  a, const MNESourceSpace &  b  )

friend

Overloaded == operator to compare an object to this instance.

Parameters

[in]

object

The object which should be compared to.

Returns

true if equal, false otherwise.

Definition at line 340 of file mne_sourcespace.h.

---

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

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