MNELIB::MNESourceEstimate Class Reference

Source estimation. More...

#include <mne_sourceestimate.h>

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

Public Member Functions
	MNESourceEstimate ()
	MNESourceEstimate (const Eigen::MatrixXd &p_sol, const Eigen::VectorXi &p_vertices, float p_tmin, float p_tstep)
	MNESourceEstimate (const MNESourceEstimate &p_SourceEstimate)
	MNESourceEstimate (QIODevice &p_IODevice)
void	clear ()
MNESourceEstimate	reduce (qint32 start, qint32 n)
bool	write (QIODevice &p_IODevice)
bool	isEmpty () const
MNESourceEstimate &	operator= (const MNESourceEstimate &rhs)
int	samples () const
Eigen::VectorXi	getIndicesByLabel (const QList< FSLIB::Label > &lPickedLabels, bool bIsClustered) const

Static Public Member Functions
static bool	read (QIODevice &p_IODevice, MNESourceEstimate &p_stc)

Public Attributes
Eigen::MatrixXd	data
Eigen::VectorXi	vertices
Eigen::RowVectorXf	times
float	tmin
float	tstep

Detailed Description

Source estimation.

Source estimation which holds results of MNE-CPP inverse routines. (Replaces *mneStcData,mneStcDataRec struct of MNE-C mne_types.h).

Definition at line 84 of file mne_sourceestimate.h.

Inheritance diagram for MNELIB::MNESourceEstimate:

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for MNESourceEstimate.

Definition at line 88 of file mne_sourceestimate.h.

SPtr

typedef QSharedPointer<MNESourceEstimate> MNELIB::MNESourceEstimate::SPtr

Shared pointer type for MNESourceEstimate.

Definition at line 87 of file mne_sourceestimate.h.

Constructor & Destructor Documentation

MNESourceEstimate() [1/4]

MNESourceEstimate::MNESourceEstimate

(

)

Default constructor

Definition at line 64 of file mne_sourceestimate.cpp.

MNESourceEstimate() [2/4]

MNELIB::MNESourceEstimate::MNESourceEstimate	(	const Eigen::MatrixXd &	p_sol,
		const Eigen::VectorXi &	p_vertices,
		float	p_tmin,
		float	p_tstep
	)

Constructs a source estimation from given data

Parameters

[in]	p_sol.
[in]	p_vertices.
[in]	p_tmin.
[in]	p_tstep.

MNESourceEstimate() [3/4]

MNESourceEstimate::MNESourceEstimate

(

const MNESourceEstimate &

p_SourceEstimate

)

Copy constructor.

Parameters

[in]

p_SourceEstimate

Source estimate data which should be copied.

Definition at line 83 of file mne_sourceestimate.cpp.

MNESourceEstimate() [4/4]

MNESourceEstimate::MNESourceEstimate

(

QIODevice &

p_IODevice

)

Constructs a source estimation, by reading from a IO device.

Parameters

[in]

p_IODevice

IO device to read from the source estimation.

Definition at line 94 of file mne_sourceestimate.cpp.

Member Function Documentation

clear()

void MNESourceEstimate::clear

(

)

Initializes source estimate.

Definition at line 107 of file mne_sourceestimate.cpp.

getIndicesByLabel()

VectorXi MNESourceEstimate::getIndicesByLabel	(	const QList< FSLIB::Label > &	lPickedLabels,
		bool	bIsClustered
	)		const

Returns the indices of sources in the data matrix based on their beloning label.

Parameters

[in]	lPickedLabels	The labels base the selection on.
[in]	bIsClustered	Whether the source space was clustered.

Returns

the indices.

Definition at line 279 of file mne_sourceestimate.cpp.

isEmpty()

bool MNELIB::MNESourceEstimate::isEmpty ( ) const

inline

Returns whether SourceEstimate is empty.

Returns

true if is empty, false otherwise.

Definition at line 218 of file mne_sourceestimate.h.

operator=()

MNESourceEstimate & MNESourceEstimate::operator=

(

const MNESourceEstimate &

rhs

)

Assignment Operator

Parameters

[in]

rhs

SourceEstimate which should be assigned.

Returns

the copied source estimate.

Definition at line 256 of file mne_sourceestimate.cpp.

read()

bool MNESourceEstimate::read ( QIODevice &  p_IODevice, MNESourceEstimate &  p_stc  )

static

mne_read_stc_file

Reads a source estimate from a given file

Parameters

[in]	p_IODevice	IO device to red the stc from.
[in,out]	p_stc	the read stc.

Returns

true if successful, false otherwise.

Definition at line 137 of file mne_sourceestimate.cpp.

reduce()

MNESourceEstimate MNESourceEstimate::reduce	(	qint32	start,
		qint32	n
	)

Reduces the source estimate to selected samples.

Parameters

[in]	start	The start index to cut the estimate from.
[in]	n	Number of samples to cut from start index.

Definition at line 118 of file mne_sourceestimate.cpp.

samples()

int MNESourceEstimate::samples

(

)

const

Returns the number of samples.

Returns

the number of samples.

Definition at line 272 of file mne_sourceestimate.cpp.

write()

bool MNESourceEstimate::write

(

QIODevice &

p_IODevice

)

mne_write_stc_file

Writes a stc file

Parameters

[in]

p_IODevice

IO device to write the stc to.

Definition at line 194 of file mne_sourceestimate.cpp.

Member Data Documentation

data

Eigen::MatrixXd MNELIB::MNESourceEstimate::data

Matrix of shape [n_dipoles x n_times] which contains the data in source space.

Definition at line 200 of file mne_sourceestimate.h.

times

Eigen::RowVectorXf MNELIB::MNESourceEstimate::times

The time vector with n_times steps.

Definition at line 202 of file mne_sourceestimate.h.

tmin

float MNELIB::MNESourceEstimate::tmin

Time starting point.

Definition at line 203 of file mne_sourceestimate.h.

tstep

float MNELIB::MNESourceEstimate::tstep

Time steps within the times vector.

Definition at line 204 of file mne_sourceestimate.h.

vertices

Eigen::VectorXi MNELIB::MNESourceEstimate::vertices

The indices of the dipoles in the different source spaces.

Definition at line 201 of file mne_sourceestimate.h.

---

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

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