MNE-CPP  beta 1.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
MNELIB::MNESourceEstimate Class Reference

Source estimation. More...

#include <mne_sourceestimate.h>

Inheritance diagram for MNELIB::MNESourceEstimate:
MNELIB::MNECorSourceEstimate

Public Types

typedef QSharedPointer< MNESourceEstimateSPtr
 
typedef QSharedPointer< const MNESourceEstimateConstSPtr
 

Public Member Functions

 MNESourceEstimate ()
 
 MNESourceEstimate (const MatrixXd &p_sol, const 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
 
MNESourceEstimateoperator= (const MNESourceEstimate &rhs)
 

Static Public Member Functions

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

Public Attributes

MatrixXd data
 
VectorXi vertices
 
RowVectorXf times
 
float tmin
 
float tstep
 

Detailed Description

Source estimation.

Source estimation which holds results of MNE-CPP inverse routines

Definition at line 95 of file mne_sourceestimate.h.

Member Typedef Documentation

Const shared pointer type for MNESourceEstimate.

Definition at line 99 of file mne_sourceestimate.h.

Shared pointer type for MNESourceEstimate.

Definition at line 98 of file mne_sourceestimate.h.

Constructor & Destructor Documentation

MNESourceEstimate::MNESourceEstimate ( )

Default constructor

Definition at line 61 of file mne_sourceestimate.cpp.

MNESourceEstimate::MNESourceEstimate ( const MatrixXd &  p_sol,
const 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

Definition at line 70 of file mne_sourceestimate.cpp.

MNESourceEstimate::MNESourceEstimate ( const MNESourceEstimate p_SourceEstimate)

Copy constructor.

Parameters
[in]p_SourceEstimateSource estimate data which should be copied

Definition at line 82 of file mne_sourceestimate.cpp.

MNESourceEstimate::MNESourceEstimate ( QIODevice &  p_IODevice)

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

Parameters
[in]p_IODeviceIO device to read from the source estimation.

Definition at line 95 of file mne_sourceestimate.cpp.

Member Function Documentation

void MNESourceEstimate::clear ( )

Initializes source estimate.

Definition at line 109 of file mne_sourceestimate.cpp.

bool MNELIB::MNESourceEstimate::isEmpty ( ) const
inline

Returns whether SourceEstimate is empty.

Returns
true if is empty, false otherwise

Definition at line 213 of file mne_sourceestimate.h.

MNESourceEstimate & MNESourceEstimate::operator= ( const MNESourceEstimate rhs)

Assignment Operator

Parameters
[in]rhsSourceEstimate which should be assigned.
Returns
the copied source estimate

Definition at line 263 of file mne_sourceestimate.cpp.

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_IODeviceIO device to red the stc from.
[out]p_stcthe read stc
Returns
true if successful, false otherwise

Definition at line 141 of file mne_sourceestimate.cpp.

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

Reduces the source estimate to selected samples.

Parameters
[in]startThe start index to cut the estimate from.
[in]nNumber of samples to cut from start index.

Definition at line 121 of file mne_sourceestimate.cpp.

bool MNESourceEstimate::write ( QIODevice &  p_IODevice)

mne_write_stc_file

Writes a stc file

Parameters
[in]p_IODeviceIO device to write the stc to.

Definition at line 199 of file mne_sourceestimate.cpp.

Member Data Documentation

MatrixXd MNELIB::MNESourceEstimate::data

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

Definition at line 192 of file mne_sourceestimate.h.

RowVectorXf MNELIB::MNESourceEstimate::times

The time vector with n_times steps.

Definition at line 194 of file mne_sourceestimate.h.

float MNELIB::MNESourceEstimate::tmin

Time starting point.

Definition at line 195 of file mne_sourceestimate.h.

float MNELIB::MNESourceEstimate::tstep

Time steps within the times vector.

Definition at line 196 of file mne_sourceestimate.h.

VectorXi MNELIB::MNESourceEstimate::vertices

The indices of the dipoles in the different source spaces.

Definition at line 193 of file mne_sourceestimate.h.


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