CONNECTIVITYLIB::NetworkEdge Class Reference

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

#include <networkedge.h>

Public Types
typedef QSharedPointer< NetworkEdge >	SPtr
typedef QSharedPointer< const NetworkEdge >	ConstSPtr

Public Member Functions
	NetworkEdge (int iStartNodeID, int iEndNodeID, const Eigen::MatrixXd &matWeight, bool bIsActive=true, int iStartWeightBin=-1, int iEndWeightBin=-1)
int	getStartNodeID ()
int	getEndNodeID ()
void	setActive (bool bActiveFlag)
bool	isActive ()
double	getWeight () const
Eigen::MatrixXd	getMatrixWeight () const
void	setWeight (double dAveragedWeight)
void	calculateAveragedWeight ()
void	setFrequencyBins (const QPair< int, int > &minMaxFreqBins)
const QPair< int, int > &	getFrequencyBins ()

Protected Attributes
int	m_iStartNodeID
int	m_iEndNodeID
bool	m_bIsActive
QPair< int, int >	m_iMinMaxFreqBins
Eigen::MatrixXd	m_matWeight
double	m_dAveragedWeight

Detailed Description

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

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

Definition at line 79 of file networkedge.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for NetworkEdge.

Definition at line 84 of file networkedge.h.

SPtr

typedef QSharedPointer<NetworkEdge> CONNECTIVITYLIB::NetworkEdge::SPtr

Shared pointer type for NetworkEdge.

Definition at line 83 of file networkedge.h.

Constructor & Destructor Documentation

NetworkEdge()

NetworkEdge::NetworkEdge ( int  iStartNodeID, int  iEndNodeID, const Eigen::MatrixXd &  matWeight, bool  bIsActive = true, int  iStartWeightBin = -1, int  iEndWeightBin = -1  )

explicit

Constructs a NetworkEdge object.

Parameters

[in]	iStartNodeID	The start node id of the edge.
[in]	iEndNodeID	The end node id of the edge.
[in]	matWeight	The edge weight.
[in]	bIsActive	The active flag of this edge. Default is true.
[in]	iStartWeightBin	The bin index to start avergaing from. Default is -1 which means an average over all weights.
[in]	iEndWeightBin	The bin index to end avergaing to. Default is -1 which means an average over all weights.

Definition at line 68 of file networkedge.cpp.

Member Function Documentation

calculateAveragedWeight()

void NetworkEdge::calculateAveragedWeight

(

)

Calculates the edge weight based on the currently set min/max frequency bins.

Definition at line 141 of file networkedge.cpp.

getEndNodeID()

int NetworkEdge::getEndNodeID

(

)

Returns the end node of this edge.

Returns

The end node of the edge.

Definition at line 99 of file networkedge.cpp.

getFrequencyBins()

const QPair< int, int > & NetworkEdge::getFrequencyBins

(

)

Returns the current frequency bins to average from/to.

Returns

The current upper/lower bin to average from/to.

Definition at line 178 of file networkedge.cpp.

getMatrixWeight()

MatrixXd NetworkEdge::getMatrixWeight

(

)

const

Returns the edge weight non-averaged in form of a matrix.

Returns

The current edge weight matrix.

Definition at line 127 of file networkedge.cpp.

getStartNodeID()

int NetworkEdge::getStartNodeID

(

)

Returns the start node of this edge.

Returns

The start node of the edge.

Definition at line 92 of file networkedge.cpp.

getWeight()

double NetworkEdge::getWeight

(

)

const

Returns the edge weight. The weights are averaged between the specified bin indeces and their corresponding tapers.

Returns

The current edge weight.

Definition at line 120 of file networkedge.cpp.

isActive()

bool NetworkEdge::isActive

(

)

Returns the activity flag of this edge.

Returns

The current activity flag of this edge.

Definition at line 113 of file networkedge.cpp.

setActive()

void NetworkEdge::setActive

(

bool

bActiveFlag

)

Sets the activity flag of this edge.

Parameters

[in]

bActiveFlag

The new activity flag of this edge.

Definition at line 106 of file networkedge.cpp.

setFrequencyBins()

void NetworkEdge::setFrequencyBins

(

const QPair< int, int > &

minMaxFreqBins

)

Sets the frequency bins to average from/to.

Parameters

[in]

minMaxFreqBins

The new lower/upper bin to average from/to.

Definition at line 165 of file networkedge.cpp.

setWeight()

void NetworkEdge::setWeight

(

double

dAveragedWeight

)

Set the averaged edge weight.

Parameters

[in]

dAveragedWeight

The new weight.

Definition at line 134 of file networkedge.cpp.

Member Data Documentation

m_bIsActive

bool CONNECTIVITYLIB::NetworkEdge::m_bIsActive

protected

The activity flag indicating whether this edge is part of a thresholded network.

Definition at line 186 of file networkedge.h.

m_dAveragedWeight

double CONNECTIVITYLIB::NetworkEdge::m_dAveragedWeight

protected

The current averaged edge weight.

Definition at line 192 of file networkedge.h.

m_iEndNodeID

int CONNECTIVITYLIB::NetworkEdge::m_iEndNodeID

protected

The end node of the edge.

Definition at line 184 of file networkedge.h.

m_iMinMaxFreqBins

QPair<int,int> CONNECTIVITYLIB::NetworkEdge::m_iMinMaxFreqBins

protected

The lower/upper bin indeces to start avergaing from/to. Default is -1 which means an average over all weights.

Definition at line 188 of file networkedge.h.

m_iStartNodeID

int CONNECTIVITYLIB::NetworkEdge::m_iStartNodeID

protected

The start node of the edge.

Definition at line 183 of file networkedge.h.

m_matWeight

Eigen::MatrixXd CONNECTIVITYLIB::NetworkEdge::m_matWeight

protected

The weight matrix of the edge. E.g. rows could be different frequency bins/bands and columns could be different instances in time.

Definition at line 190 of file networkedge.h.

---

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

• src/libraries/connectivity/network/networkedge.h
• src/libraries/connectivity/network/networkedge.cpp