CONNECTIVITYLIB::PhaseLockingValue Class Reference

This class computes the phase locking value connectivity metric. More...

#include <phaselockingvalue.h>

Public Types
typedef QSharedPointer< PhaseLockingValue >	SPtr
typedef QSharedPointer< const PhaseLockingValue >	ConstSPtr
Public Types inherited from CONNECTIVITYLIB::AbstractMetric
typedef QSharedPointer< AbstractMetric >	SPtr
typedef QSharedPointer< const AbstractMetric >	ConstSPtr

Public Member Functions
	PhaseLockingValue ()
Public Member Functions inherited from CONNECTIVITYLIB::AbstractMetric
	AbstractMetric ()

Static Public Member Functions
static Network	calculate (ConnectivitySettings &connectivitySettings)

Static Protected Member Functions
static void	compute (ConnectivitySettings::IntermediateTrialData &inputData, QVector< QPair< int, Eigen::MatrixXcd > > &vecPairCsdSum, QVector< QPair< int, Eigen::MatrixXcd > > &vecPairCsdNormalizedSum, QMutex &mutex, int iNRows, int iNFreqs, int iNfft, const QPair< Eigen::MatrixXd, Eigen::VectorXd > &tapers)
static void	computePLV (ConnectivitySettings &connectivitySettings, Network &finalNetwork)

Additional Inherited Members
Static Public Attributes inherited from CONNECTIVITYLIB::AbstractMetric
static bool	m_bStorageModeIsActive = false
static int	m_iNumberBinStart = -1
static int	m_iNumberBinAmount = -1

Detailed Description

This class computes the phase locking value connectivity metric.

This class computes the phase locking value connectivity metric.

Definition at line 86 of file phaselockingvalue.h.

Inheritance diagram for CONNECTIVITYLIB::PhaseLockingValue:

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for PhaseLockingValue.

Definition at line 91 of file phaselockingvalue.h.

SPtr

typedef QSharedPointer<PhaseLockingValue> CONNECTIVITYLIB::PhaseLockingValue::SPtr

Shared pointer type for PhaseLockingValue.

Definition at line 90 of file phaselockingvalue.h.

Constructor & Destructor Documentation

PhaseLockingValue()

PhaseLockingValue::PhaseLockingValue ( )

explicit

Constructs a PhaseLockingValue object.

Definition at line 79 of file phaselockingvalue.cpp.

Member Function Documentation

calculate()

Network PhaseLockingValue::calculate ( ConnectivitySettings &  connectivitySettings )

static

Calculates the phase locking value between the rows of the data matrix.

Parameters

[in]

connectivitySettings

The input data and parameters.

Returns

The connectivity information in form of a network structure.

Definition at line 85 of file phaselockingvalue.cpp.

compute()

void PhaseLockingValue::compute ( ConnectivitySettings::IntermediateTrialData &  inputData, QVector< QPair< int, Eigen::MatrixXcd > > &  vecPairCsdSum, QVector< QPair< int, Eigen::MatrixXcd > > &  vecPairCsdNormalizedSum, QMutex &  mutex, int  iNRows, int  iNFreqs, int  iNfft, const QPair< Eigen::MatrixXd, Eigen::VectorXd > &  tapers  )

staticprotected

Computes the PLV values. This function gets called in parallel.

Parameters

[in]	inputData	The input data.
[out]

Definition at line 188 of file phaselockingvalue.cpp.

computePLV()

void PhaseLockingValue::computePLV ( ConnectivitySettings &  connectivitySettings, Network &  finalNetwork  )

staticprotected

Reduces the PLV computation to a final result.

Parameters

[out]	connectivitySettings	The input data.
[in]	finalNetwork	The final network.

Definition at line 310 of file phaselockingvalue.cpp.

---

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

• src/libraries/connectivity/metrics/phaselockingvalue.h
• src/libraries/connectivity/metrics/phaselockingvalue.cpp