CONNECTIVITYLIB::WeightedPhaseLagIndex Class Reference

Weighted Phase Lag Index estimator (Vinck et al. 2011); volume-conduction-robust with lower bias than PLI. More...

#include <weightedphaselagindex.h>

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

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

Weighted Phase Lag Index estimator (Vinck et al. 2011); volume-conduction-robust with lower bias than PLI.

Computes the Weighted Phase Lag Index of Vinck et al. (NeuroImage 2011).

Each channel pair is reduced to |sum Im(S_{xy})| / sum |Im(S_{xy})|, weighting every cross-spectrum sample by the magnitude of its imaginary part. This down-weights near-zero-lag samples that dominate the bias of the plain PhaseLagIndex and yields higher detection power for true delayed interactions while preserving the volume-conduction rejection property. Per-trial sums are accumulated in ConnectivitySettings::IntermediateSumData and shared with DebiasedSquaredWeightedPhaseLagIndex when both metrics are requested in one batch.

Definition at line 94 of file weightedphaselagindex.h.

Inheritance diagram for CONNECTIVITYLIB::WeightedPhaseLagIndex:

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for WeightedPhaseLagIndex.

Definition at line 99 of file weightedphaselagindex.h.

SPtr

typedef QSharedPointer<WeightedPhaseLagIndex> CONNECTIVITYLIB::WeightedPhaseLagIndex::SPtr

Shared pointer type for WeightedPhaseLagIndex.

Definition at line 98 of file weightedphaselagindex.h.

Constructor & Destructor Documentation

WeightedPhaseLagIndex()

WeightedPhaseLagIndex::WeightedPhaseLagIndex ( )

explicit

Constructs a WeightedPhaseLagIndex object.

Definition at line 56 of file weightedphaselagindex.cpp.

Member Function Documentation

calculate()

Network WeightedPhaseLagIndex::calculate ( ConnectivitySettings & connectivitySettings )

static

Calculates the WPLI 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 63 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 )

staticprotected

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

Parameters

[in]	inputData	The input data.
[out]

The sum of all CSD matrices for each trial.

Parameters

[out]

The sum of all imag abs CSD matrices for each trial.

Parameters

[in]	mutex	The mutex used to safely access vecPairCsdSum.
[in]	iNRows	The number of rows.
[in]	iNFreqs	The number of frequenciy bins.
[in]	iNfft	The FFT length.
[in]	tapers	The taper information.

Definition at line 167 of file weightedphaselagindex.cpp.

computeWPLI()

void WeightedPhaseLagIndex::computeWPLI ( ConnectivitySettings & connectivitySettings, Network & finalNetwork )

staticprotected

Reduces the WPLI computation to a final result.

Parameters

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

Definition at line 309 of file weightedphaselagindex.cpp.

---

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

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