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

Source Space descritpion. More...

#include <mne_sourcespace.h>

Public Types

typedef QSharedPointer< MNESourceSpaceSPtr
 
typedef QSharedPointer< const MNESourceSpaceConstSPtr
 

Public Member Functions

 MNESourceSpace ()
 
 MNESourceSpace (const MNESourceSpace &p_MNESourceSpace)
 
 ~MNESourceSpace ()
 
void clear ()
 
bool isEmpty () const
 
QList< VectorXi > get_vertno () const
 
QList< VectorXi > label_src_vertno_sel (const Label &p_label, VectorXi &src_sel) const
 
MNESourceSpace pick_regions (const QList< Label > &p_qListLabels) const
 
qint32 size () const
 
bool transform_source_space_to (fiff_int_t dest, FiffCoordTrans &trans)
 
void writeToStream (FiffStream *p_pStream)
 
MNEHemisphereoperator[] (qint32 idx)
 
const MNEHemisphereoperator[] (qint32 idx) const
 
MNEHemisphereoperator[] (QString idt)
 
const MNEHemisphereoperator[] (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 (FiffStream::SPtr &p_pStream, bool add_geom, FiffDirTree &p_Tree, MNESourceSpace &p_SourceSpace)
 

Detailed Description

Source Space descritpion.

Source Space descritpion

Definition at line 115 of file mne_sourcespace.h.

Member Typedef Documentation

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

Const shared pointer type for MNESourceSpace.

Definition at line 119 of file mne_sourcespace.h.

Shared pointer type for MNESourceSpace.

Definition at line 118 of file mne_sourcespace.h.

Constructor & Destructor Documentation

MNESourceSpace::MNESourceSpace ( )

Default constructor

Definition at line 62 of file mne_sourcespace.cpp.

MNESourceSpace::MNESourceSpace ( const MNESourceSpace p_MNESourceSpace)

Copy constructor.

Parameters
[in]p_MNESourceSpaceMNE forward solution

Definition at line 69 of file mne_sourcespace.cpp.

MNESourceSpace::~MNESourceSpace ( )

Destroys the MNE forward solution

Definition at line 78 of file mne_sourcespace.cpp.

Member Function Documentation

void MNESourceSpace::clear ( )

Initializes MNE source space.

Definition at line 86 of file mne_sourcespace.cpp.

qint32 MNESourceSpace::find_source_space_hemi ( MNEHemisphere p_Hemisphere)
static

MNE toolbox root function ###: Implementation 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_Hemispherethe hemisphere to investigate
Returns
the deduced hemisphere id

Definition at line 317 of file mne_sourcespace.cpp.

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.

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

True if MNE Source Space is empty.

Returns
true if MNE Source Space is empty

Definition at line 347 of file mne_sourcespace.h.

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

Find vertex numbers and indices from label

Parameters
[in]labelSource space label
[out]src_selarray 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 105 of file mne_sourcespace.cpp.

MNEHemisphere & MNESourceSpace::operator[] ( qint32  idx)

Subscript operator [] to access parameter values by index

Parameters
[in]idxthe hemisphere index (0 or 1).
Returns
Hemisphere related to the parameter index.

Definition at line 845 of file mne_sourcespace.cpp.

const MNEHemisphere & MNESourceSpace::operator[] ( qint32  idx) const

Subscript operator [] to access parameter values by index

Parameters
[in]idxthe hemisphere index (0 or 1).
Returns
Hemisphere related to the parameter index.

Definition at line 859 of file mne_sourcespace.cpp.

MNEHemisphere & MNESourceSpace::operator[] ( QString  idt)

Subscript operator [] to access parameter values by index

Parameters
[in]idtthe hemisphere identifier ("lh" or "rh").
Returns
Hemisphere related to the parameter identifier.

Definition at line 873 of file mne_sourcespace.cpp.

const MNEHemisphere & MNESourceSpace::operator[] ( QString  idt) const

Subscript operator [] to access parameter values by index

Parameters
[in]idtthe hemisphere identifier ("lh" or "rh").
Returns
Hemisphere related to the parameter identifier.

Definition at line 889 of file mne_sourcespace.cpp.

bool MNESourceSpace::patch_info ( MNEHemisphere p_Hemisphere)
static

MNE toolbox root function ###: Implementation 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_HemisphereThe source space.
Returns
true if succeeded, false otherwise

Definition at line 587 of file mne_sourcespace.cpp.

MNESourceSpace MNESourceSpace::pick_regions ( const QList< Label > &  p_qListLabels) const

Reduces a source space to selected regions

Parameters
[in]p_qListLabelsROIs
Returns
the reduced source space

Definition at line 164 of file mne_sourcespace.cpp.

bool MNESourceSpace::readFromStream ( FiffStream::SPtr p_pStream,
bool  add_geom,
FiffDirTree p_Tree,
MNESourceSpace p_SourceSpace 
)
static

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

Reads source spaces from a fif file

Parameters
[in,out]p_pStreamThe opened fif file
[in]add_geomAdd geometry information to the source spaces
[in,out]p_TreeSearch for the source spaces here
[out]p_SourceSpaceThe read source spaces
Returns
true if succeeded, false otherwise

Definition at line 256 of file mne_sourcespace.cpp.

qint32 MNELIB::MNESourceSpace::size ( ) const
inline

Returns the number of stored hemispheres 0, 1 or 2

Returns
number of stored hemispheres

Definition at line 355 of file mne_sourcespace.h.

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

MNE toolbox root function ###: Implementation 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]destdestination check code
[in]transtransformation information
Returns
true if succeeded, false otherwise

Definition at line 333 of file mne_sourcespace.cpp.

void MNESourceSpace::writeToStream ( FiffStream p_pStream)

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

Write the source spaces to a FIF stream

Parameters
[in]p_pStreamThe stream to write to.

Definition at line 829 of file mne_sourcespace.cpp.


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