CONNECTIVITYLIB::DebiasedSquaredWeightedPhaseLagIndex Class Reference

Debiased squared Weighted Phase Lag Index (Vinck et al. 2011); low-bias volume-conduction-robust estimator. More...

#include <debiasedsquaredweightedphaselagindex.h>

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

Public Member Functions
	DebiasedSquaredWeightedPhaseLagIndex ()
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, QVector< QPair< int, Eigen::MatrixXd > > &vecPairCsdImagSqrdSum, QMutex &mutex, int iNRows, int iNFreqs, int iNfft, const QPair< Eigen::MatrixXd, Eigen::VectorXd > &tapers)
static void	computeDSWPLI (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

Debiased squared Weighted Phase Lag Index (Vinck et al. 2011); low-bias volume-conduction-robust estimator.

Computes the debiased squared Weighted Phase Lag Index of Vinck et al. (NeuroImage 2011) for every channel pair.

The estimator subtracts the analytically known diagonal variance from both numerator and denominator of WeightedPhaseLagIndex, producing an estimator whose expectation equals wPLI^2 even for very small trial counts. It is the preferred PLI-family metric when the number of trials is low and is the volume-conduction-robust counterpart of magnitude-squared coherence.

Definition at line 93 of file debiasedsquaredweightedphaselagindex.h.

Inheritance diagram for CONNECTIVITYLIB::DebiasedSquaredWeightedPhaseLagIndex:

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for DebiasedSquaredWeightedPhaseLagIndex.

Definition at line 98 of file debiasedsquaredweightedphaselagindex.h.

SPtr

typedef QSharedPointer<DebiasedSquaredWeightedPhaseLagIndex> CONNECTIVITYLIB::DebiasedSquaredWeightedPhaseLagIndex::SPtr

Shared pointer type for DebiasedSquaredWeightedPhaseLagIndex.

Definition at line 97 of file debiasedsquaredweightedphaselagindex.h.

Constructor & Destructor Documentation

DebiasedSquaredWeightedPhaseLagIndex()

DebiasedSquaredWeightedPhaseLagIndex::DebiasedSquaredWeightedPhaseLagIndex ( )

explicit

Constructs a DebiasedSquaredWeightedPhaseLagIndex object.

Definition at line 56 of file debiasedsquaredweightedphaselagindex.cpp.

Member Function Documentation

calculate()

Network DebiasedSquaredWeightedPhaseLagIndex::calculate ( ConnectivitySettings & connectivitySettings )

static

Calculates the debiased squared weighted phase lag index 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 62 of file debiasedsquaredweightedphaselagindex.cpp.

compute()

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

staticprotected

Computes the DSWPLI 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

[out]

The sum of all imag aqrd 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 debiasedsquaredweightedphaselagindex.cpp.

computeDSWPLI()

void DebiasedSquaredWeightedPhaseLagIndex::computeDSWPLI ( ConnectivitySettings & connectivitySettings, Network & finalNetwork )

staticprotected

Reduces the DSWPLI computation to a final result.

Parameters

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

Definition at line 314 of file debiasedsquaredweightedphaselagindex.cpp.

---

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

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