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

cluster information More...

#include <mne_cluster_info.h>

Public Types

typedef QSharedPointer< MNEClusterInfoSPtr
 
typedef QSharedPointer< const MNEClusterInfoConstSPtr
 

Public Member Functions

 MNEClusterInfo ()
 
void clear ()
 
bool isEmpty () const
 
qint32 numClust () const
 
void write (QString p_sFileName) const
 

Public Attributes

QList< QString > clusterLabelNames
 
QList< qint32 > clusterLabelIds
 
QList< qint32 > centroidVertno
 
QList< Eigen::Vector3f > centroidSource_rr
 
QList< Eigen::VectorXi > clusterVertnos
 
QList< Eigen::MatrixX3f > clusterSource_rr
 
QList< Eigen::VectorXd > clusterDistances
 

Friends

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

Detailed Description

cluster information

Cluster information

Definition at line 72 of file mne_cluster_info.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for MNEClusterInfo.

Definition at line 76 of file mne_cluster_info.h.

◆ SPtr

Shared pointer type for MNEClusterInfo.

Definition at line 75 of file mne_cluster_info.h.

Constructor & Destructor Documentation

◆ MNEClusterInfo()

MNEClusterInfo::MNEClusterInfo ( )

Default constructor.

Definition at line 61 of file mne_cluster_info.cpp.

Member Function Documentation

◆ clear()

void MNEClusterInfo::clear ( )

Initializes the cluster information.

Definition at line 67 of file mne_cluster_info.cpp.

◆ isEmpty()

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

Returns true if MNE cluster information contains no data.

Returns
true if MNE cluster information is empty.

Definition at line 137 of file mne_cluster_info.h.

◆ numClust()

qint32 MNELIB::MNEClusterInfo::numClust ( ) const
inline

Returns the number of clusters

Returns
number of clusters.

Definition at line 144 of file mne_cluster_info.h.

◆ write()

void MNEClusterInfo::write ( QString  p_sFileName) const

Writes the cluster info to a file

Parameters
[in]p_sFileNameFileName to write to.

Definition at line 80 of file mne_cluster_info.cpp.

Friends And Related Function Documentation

◆ operator==

bool operator== ( const MNEClusterInfo a,
const MNEClusterInfo 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 151 of file mne_cluster_info.h.

Member Data Documentation

◆ centroidSource_rr

QList<Eigen::Vector3f> MNELIB::MNEClusterInfo::centroidSource_rr

Centroid location.

Definition at line 127 of file mne_cluster_info.h.

◆ centroidVertno

QList<qint32> MNELIB::MNEClusterInfo::centroidVertno

Id (Label/ROI id) of the centroid.

Definition at line 126 of file mne_cluster_info.h.

◆ clusterDistances

QList<Eigen::VectorXd> MNELIB::MNEClusterInfo::clusterDistances

Distances to clusters centroid.

Definition at line 130 of file mne_cluster_info.h.

◆ clusterLabelIds

QList<qint32> MNELIB::MNEClusterInfo::clusterLabelIds

Id (Label/ROI id) of the cluster. Entries can be non unique, since some Label/ROI consist of more than one cluster.

Definition at line 125 of file mne_cluster_info.h.

◆ clusterLabelNames

QList<QString> MNELIB::MNEClusterInfo::clusterLabelNames

Label name of the cluster. Entries can be non unique, since some Label consist of more than one cluster.

Definition at line 124 of file mne_cluster_info.h.

◆ clusterSource_rr

QList<Eigen::MatrixX3f> MNELIB::MNEClusterInfo::clusterSource_rr

Cluster source locations.

Definition at line 129 of file mne_cluster_info.h.

◆ clusterVertnos

QList<Eigen::VectorXi> MNELIB::MNEClusterInfo::clusterVertnos

Vertnos which belong to corresponding cluster.

Definition at line 128 of file mne_cluster_info.h.


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