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::PhaseLagIndex Class Reference

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

#include <phaselagindex.h>

Public Types

typedef QSharedPointer< PhaseLagIndexSPtr
typedef QSharedPointer< const PhaseLagIndexConstSPtr
- Public Types inherited from CONNECTIVITYLIB::AbstractMetric
typedef QSharedPointer< AbstractMetricSPtr
typedef QSharedPointer< const AbstractMetricConstSPtr

Public Member Functions

 PhaseLagIndex ()
- 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 > > &vecPairCsdImagSignSum, QMutex &mutex, int iNRows, int iNFreqs, int iNfft, const QPair< Eigen::MatrixXd, Eigen::VectorXd > &tapers)
static void computePLI (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 phaselagindex.h.

Inheritance diagram for CONNECTIVITYLIB::PhaseLagIndex:
Inheritance graph

Member Typedef Documentation

◆ ConstSPtr

Const shared pointer type for PhaseLagIndex.

Definition at line 91 of file phaselagindex.h.

◆ SPtr

Shared pointer type for PhaseLagIndex.

Definition at line 90 of file phaselagindex.h.

Constructor & Destructor Documentation

◆ PhaseLagIndex()

PhaseLagIndex::PhaseLagIndex ( )

Constructs a PhaseLagIndex object.

Definition at line 79 of file phaselagindex.cpp.

Member Function Documentation

◆ calculate()

Network PhaseLagIndex::calculate ( ConnectivitySettings connectivitySettings)

Calculates the PLI 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 85 of file phaselagindex.cpp.

◆ compute()

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

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

[in]inputDataThe input data.

Definition at line 187 of file phaselagindex.cpp.

◆ computePLI()

void PhaseLagIndex::computePLI ( ConnectivitySettings connectivitySettings,
Network finalNetwork 

Reduces the PLI computation to a final result.

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

Definition at line 309 of file phaselagindex.cpp.

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