MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Types | Public Member Functions | Protected Attributes | List of all members
CONNECTIVITYLIB::NetworkNode Class Reference

This class holds an object to describe the node of a network. More...

#include <networknode.h>

Public Types

typedef QSharedPointer< NetworkNode > SPtr
 
typedef QSharedPointer< const NetworkNode > ConstSPtr
 

Public Member Functions

 NetworkNode (qint16 iId, const Eigen::RowVectorXf &vecVert)
 
const QList< QSharedPointer< NetworkEdge > > & getFullEdges () const
 
QList< QSharedPointer< NetworkEdge > > getThresholdedEdges () const
 
QList< QSharedPointer< NetworkEdge > > getFullEdgesIn () const
 
QList< QSharedPointer< NetworkEdge > > getThresholdedEdgesIn () const
 
QList< QSharedPointer< NetworkEdge > > getFullEdgesOut () const
 
QList< QSharedPointer< NetworkEdge > > getThresholdedEdgesOut () const
 
const Eigen::RowVectorXf & getVert () const
 
qint16 getId () const
 
qint16 getFullDegree () const
 
qint16 getThresholdedDegree () const
 
qint16 getFullIndegree () const
 
qint16 getThresholdedIndegree () const
 
qint16 getFullOutdegree () const
 
qint16 getThresholdedOutdegree () const
 
double getFullStrength () const
 
double getThresholdedStrength () const
 
double getFullInstrength () const
 
double getThresholdedInstrength () const
 
double getFullOutstrength () const
 
double getThresholdedOutstrength () const
 
void setHubStatus (bool bIsHub)
 
bool getHubStatus () const
 
void append (QSharedPointer< NetworkEdge > newEdge)
 

Protected Attributes

bool m_bIsHub
 
qint16 m_iId
 
Eigen::RowVectorXf m_vecVert
 
QList< QSharedPointer< NetworkEdge > > m_lEdges
 

Detailed Description

This class holds an object to describe the node of a network.

This class holds an object to describe the node of a network.

Definition at line 81 of file networknode.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const NetworkNode> CONNECTIVITYLIB::NetworkNode::ConstSPtr

Const shared pointer type for NetworkNode.

Definition at line 86 of file networknode.h.

◆ SPtr

typedef QSharedPointer<NetworkNode> CONNECTIVITYLIB::NetworkNode::SPtr

Shared pointer type for NetworkNode.

Definition at line 85 of file networknode.h.

Constructor & Destructor Documentation

◆ NetworkNode()

NetworkNode::NetworkNode ( qint16  iId,
const Eigen::RowVectorXf &  vecVert 
)
explicit

Constructs a NetworkNode object.

Parameters
[in]iIdThe node's ID.
[in]vecVertThe node's 3D position.

Definition at line 66 of file networknode.cpp.

Member Function Documentation

◆ append()

void NetworkNode::append ( QSharedPointer< NetworkEdge >  newEdge)

Appends a network edge to this network node. Automatically decides whether to add to the in or out edges.

Parameters
[in]newEdgeThe new edge item.

Definition at line 355 of file networknode.cpp.

◆ getFullDegree()

qint16 NetworkNode::getFullDegree ( ) const

Returns node degree corresponding to the full network.

Returns
The node degree calculated as the number of edges connected to a node (undirected gaph).

Definition at line 171 of file networknode.cpp.

◆ getFullEdges()

const QList< QSharedPointer< NetworkEdge > > & NetworkNode::getFullEdges ( ) const

Returns the ingoing edges corresponding to the full network.

Returns
Returns the list with all ingoing edges.

Definition at line 75 of file networknode.cpp.

◆ getFullEdgesIn()

QList< QSharedPointer< NetworkEdge > > NetworkNode::getFullEdgesIn ( ) const

Returns the ingoing edges corresponding to the full network.

Returns
Returns the list with all ingoing edges.

Definition at line 97 of file networknode.cpp.

◆ getFullEdgesOut()

QList< QSharedPointer< NetworkEdge > > NetworkNode::getFullEdgesOut ( ) const

Returns the outgoing edges corresponding to the full network.

Returns
Returns the list with all outgoing edges.

Definition at line 127 of file networknode.cpp.

◆ getFullIndegree()

qint16 NetworkNode::getFullIndegree ( ) const

Returns node indegree corresponding to the full network.

Returns
The node degree calculated as the number of incoming edges (only in directed graphs).

Definition at line 193 of file networknode.cpp.

◆ getFullInstrength()

double NetworkNode::getFullInstrength ( ) const

Returns node strength of all ingoing edges corresponding to the full network.

Returns
The node strength calculated as the sum of all weights of all ingoing edges of a node.

Definition at line 281 of file networknode.cpp.

◆ getFullOutdegree()

qint16 NetworkNode::getFullOutdegree ( ) const

Returns node outdegree corresponding to the full network.

Returns
The node degree calculated as the number of outgoing edges (only in directed graphs).

Definition at line 223 of file networknode.cpp.

◆ getFullOutstrength()

double NetworkNode::getFullOutstrength ( ) const

Returns node strength of all outgoing edges corresponding to the full network.

Returns
The node strength calculated as the sum of all weights of all outgoing edges of a node.

Definition at line 311 of file networknode.cpp.

◆ getFullStrength()

double NetworkNode::getFullStrength ( ) const

Returns node strength corresponding to the full network.

Returns
The node strength calculated as the sum of all weights of all edges of a node.

Definition at line 253 of file networknode.cpp.

◆ getHubStatus()

bool NetworkNode::getHubStatus ( ) const

Returns flag describing whether this node is a hub or not.

Returns
Whether this node is a hub or not.

Definition at line 348 of file networknode.cpp.

◆ getId()

qint16 NetworkNode::getId ( ) const

Returns the node id.

Returns
Returns the node id.

Definition at line 164 of file networknode.cpp.

◆ getThresholdedDegree()

qint16 NetworkNode::getThresholdedDegree ( ) const

Returns node degree corresponding to the thresholded network.

Returns
The node degree calculated as the number of edges connected to a node (undirected gaph).

Definition at line 178 of file networknode.cpp.

◆ getThresholdedEdges()

QList< QSharedPointer< NetworkEdge > > NetworkNode::getThresholdedEdges ( ) const

Returns all edges corresponding to the thresholded network.

Returns
Returns the list with all ingoing edges.

Definition at line 82 of file networknode.cpp.

◆ getThresholdedEdgesIn()

QList< QSharedPointer< NetworkEdge > > NetworkNode::getThresholdedEdgesIn ( ) const

Returns the ingoing edges corresponding to the thresholded network.

Returns
Returns the list with all ingoing edges.

Definition at line 112 of file networknode.cpp.

◆ getThresholdedEdgesOut()

QList< QSharedPointer< NetworkEdge > > NetworkNode::getThresholdedEdgesOut ( ) const

Returns the outgoing edges corresponding to the thresholded network.

Returns
Returns the list with all outgoing edges.

Definition at line 142 of file networknode.cpp.

◆ getThresholdedIndegree()

qint16 NetworkNode::getThresholdedIndegree ( ) const

Returns node indegree corresponding to the thresholded network.

Returns
The node degree calculated as the number of incoming edges (only in directed graphs).

Definition at line 208 of file networknode.cpp.

◆ getThresholdedInstrength()

double NetworkNode::getThresholdedInstrength ( ) const

Returns node strength of all ingoing edges corresponding to the thresholded network.

Returns
The node strength calculated as the sum of all weights of all ingoing edges of a node.

Definition at line 296 of file networknode.cpp.

◆ getThresholdedOutdegree()

qint16 NetworkNode::getThresholdedOutdegree ( ) const

Returns node outdegree corresponding to the thresholded network.

Returns
The node degree calculated as the number of outgoing edges (only in directed graphs).

Definition at line 238 of file networknode.cpp.

◆ getThresholdedOutstrength()

double NetworkNode::getThresholdedOutstrength ( ) const

Returns node strength of all outgoing edges corresponding to the thresholded network.

Returns
The node strength calculated as the sum of all weights of all outgoing edges of a node.

Definition at line 326 of file networknode.cpp.

◆ getThresholdedStrength()

double NetworkNode::getThresholdedStrength ( ) const

Returns node strength corresponding to the thresholded network.

Returns
The node strength calculated as the sum of all weights of all edges of a node.

Definition at line 266 of file networknode.cpp.

◆ getVert()

const RowVectorXf & NetworkNode::getVert ( ) const

Returns the vertex (position) of the node.

Returns
Returns the 3D position of the node.

Definition at line 157 of file networknode.cpp.

◆ setHubStatus()

void NetworkNode::setHubStatus ( bool  bIsHub)

Sets the hub status of this node.

Parameters
[in]bIsHubNew hub status for this node.

Definition at line 341 of file networknode.cpp.

Member Data Documentation

◆ m_bIsHub

bool CONNECTIVITYLIB::NetworkNode::m_bIsHub
protected

Whether this node is a hub.

Definition at line 282 of file networknode.h.

◆ m_iId

qint16 CONNECTIVITYLIB::NetworkNode::m_iId
protected

The node's ID.

Definition at line 284 of file networknode.h.

◆ m_lEdges

QList<QSharedPointer<NetworkEdge> > CONNECTIVITYLIB::NetworkNode::m_lEdges
protected

List with all incoming edges of the node.

Definition at line 288 of file networknode.h.

◆ m_vecVert

Eigen::RowVectorXf CONNECTIVITYLIB::NetworkNode::m_vecVert
protected

The 3D position of the node.

Definition at line 286 of file networknode.h.

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