MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Types | Public Member Functions | Public Attributes | Friends | List of all members
MNELIB::MNEHemisphere Class Reference

Hemisphere provides geometry information. More...

#include <mne_hemisphere.h>

Public Types

typedef QSharedPointer< MNEHemisphere > SPtr
 
typedef QSharedPointer< const MNEHemisphere > ConstSPtr
 

Public Member Functions

 MNEHemisphere ()
 
 MNEHemisphere (const MNEHemisphere &p_MNEHemisphere)
 
 ~MNEHemisphere ()
 
bool add_geometry_info ()
 
void clear ()
 
Eigen::MatrixXf & getTriCoords (float p_fScaling=1.0f)
 
bool isClustered () const
 
bool transform_hemisphere_to (FIFFLIB::fiff_int_t dest, const FIFFLIB::FiffCoordTrans &p_Trans)
 
void writeToStream (FIFFLIB::FiffStream *p_pStream)
 

Public Attributes

FIFFLIB::fiff_int_t type
 
FIFFLIB::fiff_int_t id
 
FIFFLIB::fiff_int_t np
 
FIFFLIB::fiff_int_t ntri
 
FIFFLIB::fiff_int_t coord_frame
 
Eigen::MatrixX3f rr
 
Eigen::MatrixX3f nn
 
Eigen::MatrixX3i tris
 
FIFFLIB::fiff_int_t nuse
 
Eigen::VectorXi inuse
 
Eigen::VectorXi vertno
 
qint32 nuse_tri
 
Eigen::MatrixX3i use_tris
 
Eigen::VectorXi nearest
 
Eigen::VectorXd nearest_dist
 
QList< Eigen::VectorXi > pinfo
 
Eigen::VectorXi patch_inds
 
float dist_limit
 
Eigen::SparseMatrix< double > dist
 
Eigen::MatrixX3d tri_cent
 
Eigen::MatrixX3d tri_nn
 
Eigen::VectorXd tri_area
 
Eigen::MatrixX3d use_tri_cent
 
Eigen::MatrixX3d use_tri_nn
 
Eigen::VectorXd use_tri_area
 
QVector< QVector< int > > neighbor_tri
 
QVector< QVector< int > > neighbor_vert
 
MNEClusterInfo cluster_info
 

Friends

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

Detailed Description

Hemisphere provides geometry information.

Hemisphere source space geometry information

Definition at line 80 of file mne_hemisphere.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for MNEHemisphere.

Definition at line 84 of file mne_hemisphere.h.

◆ SPtr

typedef QSharedPointer<MNEHemisphere> MNELIB::MNEHemisphere::SPtr

Shared pointer type for MNEHemisphere.

Definition at line 83 of file mne_hemisphere.h.

Constructor & Destructor Documentation

◆ MNEHemisphere() [1/2]

MNEHemisphere::MNEHemisphere ( )

Constructors the hemisphere source space.

Definition at line 55 of file mne_hemisphere.cpp.

◆ MNEHemisphere() [2/2]

MNEHemisphere::MNEHemisphere ( const MNEHemisphere &  p_MNEHemisphere)

Copy constructor.

Parameters
[in]p_MNEHemisphereHemisphere source space which should be copied.

Definition at line 87 of file mne_hemisphere.cpp.

◆ ~MNEHemisphere()

MNEHemisphere::~MNEHemisphere ( )

Destroys the hemisphere source space.

Definition at line 123 of file mne_hemisphere.cpp.

Member Function Documentation

◆ add_geometry_info()

bool MNEHemisphere::add_geometry_info ( )

Add vertex normals and neighbourhood information

Parameters
[in,out]p_pHemisphereHemisphere to be completed.
Returns
true if succeeded, false otherwise.

Definition at line 129 of file mne_hemisphere.cpp.

◆ clear()

void MNEHemisphere::clear ( )

Initializes the hemisphere source space.

Definition at line 176 of file mne_hemisphere.cpp.

◆ getTriCoords()

MatrixXf & MNEHemisphere::getTriCoords ( float  p_fScaling = 1.0f)

Qt 3d geometry information. Data are generated within first call.

Parameters
[in]p_fScalingScale factor of the returned geometry tri model.
Returns
the geometry model.

Definition at line 214 of file mne_hemisphere.cpp.

◆ isClustered()

bool MNELIB::MNEHemisphere::isClustered ( ) const
inline

is hemisphere clustered?

Returns
true if hemisphere is clustered, false otherwise.

Definition at line 219 of file mne_hemisphere.h.

◆ transform_hemisphere_to()

bool MNEHemisphere::transform_hemisphere_to ( FIFFLIB::fiff_int_t  dest,
const FIFFLIB::FiffCoordTrans &  p_Trans 
)

mne_transform_source_space_to

MNE toolbox root function

Definition of the mne_transform_source_space_to for a single hemisphere function Transform source space data to the desired coordinate system.

Parameters
[in]destThe id of the destination coordinate system (FIFFV_COORD_...).
[in]p_TransThe coordinate transformation structure to use.
Returns
true if succeeded, false otherwise.

Definition at line 234 of file mne_hemisphere.cpp.

◆ writeToStream()

void MNEHemisphere::writeToStream ( FIFFLIB::FiffStream *  p_pStream)

mne_python _write_one_source_space

MNE toolbox root function

Write the hemisphere to a FIF stream

Parameters
[in]p_pStreamThe stream to write to.

Definition at line 268 of file mne_hemisphere.cpp.

Friends And Related Function Documentation

◆ operator==

bool operator== ( const MNEHemisphere &  a,
const MNEHemisphere &  b 
)
friend

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

Parameters
[in]objectThe object which should be compared to.
Returns
true if equal, false otherwise.

Definition at line 226 of file mne_hemisphere.h.

Member Data Documentation

◆ cluster_info

MNEClusterInfo MNELIB::MNEHemisphere::cluster_info

Holds the cluster information.

Definition at line 209 of file mne_hemisphere.h.

◆ coord_frame

FIFFLIB::fiff_int_t MNELIB::MNEHemisphere::coord_frame

Coil coordinate system definition.

Definition at line 184 of file mne_hemisphere.h.

◆ dist

Eigen::SparseMatrix<double> MNELIB::MNEHemisphere::dist

ToDo... (using option -cps during mne_setup_source_space).

Definition at line 198 of file mne_hemisphere.h.

◆ dist_limit

float MNELIB::MNEHemisphere::dist_limit

ToDo... (using option -cps during mne_setup_source_space).

Definition at line 197 of file mne_hemisphere.h.

◆ id

FIFFLIB::fiff_int_t MNELIB::MNEHemisphere::id

Id information.

Definition at line 181 of file mne_hemisphere.h.

◆ inuse

Eigen::VectorXi MNELIB::MNEHemisphere::inuse

Used source points indicated by 1, 0 otherwise.

Definition at line 189 of file mne_hemisphere.h.

◆ nearest

Eigen::VectorXi MNELIB::MNEHemisphere::nearest

All indeces mapped to the indeces of the used vertices (using option -cps during mne_setup_source_space).

Definition at line 193 of file mne_hemisphere.h.

◆ nearest_dist

Eigen::VectorXd MNELIB::MNEHemisphere::nearest_dist

Distance to the nearest vertices (using option -cps during mne_setup_source_space).

Definition at line 194 of file mne_hemisphere.h.

◆ neighbor_tri

QVector<QVector<int> > MNELIB::MNEHemisphere::neighbor_tri

Vector of neighboring triangles for each vertex.

Definition at line 206 of file mne_hemisphere.h.

◆ neighbor_vert

QVector<QVector<int> > MNELIB::MNEHemisphere::neighbor_vert

Vector of neighboring vertices for each vertex.

Definition at line 207 of file mne_hemisphere.h.

◆ nn

Eigen::MatrixX3f MNELIB::MNEHemisphere::nn

Normals of the source space mesh/surface.

Definition at line 186 of file mne_hemisphere.h.

◆ np

FIFFLIB::fiff_int_t MNELIB::MNEHemisphere::np

Number of vertices of the whole/original surface used to create the source locations.

Definition at line 182 of file mne_hemisphere.h.

◆ ntri

FIFFLIB::fiff_int_t MNELIB::MNEHemisphere::ntri

Number of available triangles.

Definition at line 183 of file mne_hemisphere.h.

◆ nuse

FIFFLIB::fiff_int_t MNELIB::MNEHemisphere::nuse

Number of used dipoles.

Definition at line 188 of file mne_hemisphere.h.

◆ nuse_tri

qint32 MNELIB::MNEHemisphere::nuse_tri

Number of used triangles.

Definition at line 191 of file mne_hemisphere.h.

◆ patch_inds

Eigen::VectorXi MNELIB::MNEHemisphere::patch_inds

List of neighboring vertices in the high resolution triangulation.

Definition at line 196 of file mne_hemisphere.h.

◆ pinfo

QList<Eigen::VectorXi> MNELIB::MNEHemisphere::pinfo

Patch information (using option -cps during mne_setup_source_space).

Definition at line 195 of file mne_hemisphere.h.

◆ rr

Eigen::MatrixX3f MNELIB::MNEHemisphere::rr

Vertices of the source space mesh/surface.

Definition at line 185 of file mne_hemisphere.h.

◆ tri_area

Eigen::VectorXd MNELIB::MNEHemisphere::tri_area

Triangle areas.

Definition at line 201 of file mne_hemisphere.h.

◆ tri_cent

Eigen::MatrixX3d MNELIB::MNEHemisphere::tri_cent

Triangle centers.

Definition at line 199 of file mne_hemisphere.h.

◆ tri_nn

Eigen::MatrixX3d MNELIB::MNEHemisphere::tri_nn

Triangle normals.

Definition at line 200 of file mne_hemisphere.h.

◆ tris

Eigen::MatrixX3i MNELIB::MNEHemisphere::tris

Triangles of the source space mesh/surface.

Definition at line 187 of file mne_hemisphere.h.

◆ type

FIFFLIB::fiff_int_t MNELIB::MNEHemisphere::type

Type of the source space: 1 = "surf" or 2 = "vol". ToDo not used yet.

Definition at line 180 of file mne_hemisphere.h.

◆ use_tri_area

Eigen::VectorXd MNELIB::MNEHemisphere::use_tri_area

Triangle areas of used triangles.

Definition at line 204 of file mne_hemisphere.h.

◆ use_tri_cent

Eigen::MatrixX3d MNELIB::MNEHemisphere::use_tri_cent

Triangle centers of used triangles.

Definition at line 202 of file mne_hemisphere.h.

◆ use_tri_nn

Eigen::MatrixX3d MNELIB::MNEHemisphere::use_tri_nn

Triangle normals of used triangles.

Definition at line 203 of file mne_hemisphere.h.

◆ use_tris

Eigen::MatrixX3i MNELIB::MNEHemisphere::use_tris

Triangle information of the used triangles.

Definition at line 192 of file mne_hemisphere.h.

◆ vertno

Eigen::VectorXi MNELIB::MNEHemisphere::vertno

Zero based (different to MATLAB) indices of the used vertices/If label based clustered gain matrix vertno contains label IDs

Definition at line 190 of file mne_hemisphere.h.

The documentation for this class was generated from the following files:
Generated on Wed Aug 9 2023 17:55:45 for MNE-CPP by   doxygen 1.8.17