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

This class computes the phase lag index connectivity metric. More...

#include <weightedphaselagindex.h>

Public Types

typedef QSharedPointer< WeightedPhaseLagIndexSPtr
typedef QSharedPointer< const WeightedPhaseLagIndexConstSPtr
- Public Types inherited from CONNECTIVITYLIB::AbstractMetric
typedef QSharedPointer< AbstractMetricSPtr
typedef QSharedPointer< const AbstractMetricConstSPtr

Public Member Functions

 WeightedPhaseLagIndex ()
- 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::MatrixXd > > &vecPairCsdImagAbsSum, QMutex &mutex, int iNRows, int iNFreqs, int iNfft, const QPair< Eigen::MatrixXd, Eigen::VectorXd > &tapers)
static void computeWPLI (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 lag index connectivity metric.

This class computes the phase lag index connectivity metric.

Definition at line 86 of file weightedphaselagindex.h.

Inheritance diagram for CONNECTIVITYLIB::WeightedPhaseLagIndex:
Inheritance graph

Member Typedef Documentation

◆ ConstSPtr

Const shared pointer type for WeightedPhaseLagIndex.

Definition at line 91 of file weightedphaselagindex.h.

◆ SPtr

Shared pointer type for WeightedPhaseLagIndex.

Definition at line 90 of file weightedphaselagindex.h.

Constructor & Destructor Documentation

◆ WeightedPhaseLagIndex()

WeightedPhaseLagIndex::WeightedPhaseLagIndex ( )

Constructs a WeightedPhaseLagIndex object.

Definition at line 79 of file weightedphaselagindex.cpp.

Member Function Documentation

◆ calculate()

Network WeightedPhaseLagIndex::calculate ( ConnectivitySettings connectivitySettings)

Calculates the WPLI between the rows of the data matrix.

[in]connectivitySettingsThe input data and parameters.
The connectivity information in form of a network structure.

Definition at line 86 of file weightedphaselagindex.cpp.

◆ compute()

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

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

[in]inputDataThe input data.

Definition at line 190 of file weightedphaselagindex.cpp.

◆ computeWPLI()

void WeightedPhaseLagIndex::computeWPLI ( ConnectivitySettings connectivitySettings,
Network finalNetwork 

Reduces the WPLI computation to a final result.

[out]connectivitySettingsThe input data.
[in]finalNetworkThe final network.

Definition at line 332 of file weightedphaselagindex.cpp.

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