CONNECTIVITYLIB::UnbiasedSquaredPhaseLagIndex Class Reference

Unbiased squared Phase Lag Index estimator; removes the small-sample bias of PhaseLagIndex. More...

#include <unbiasedsquaredphaselagindex.h>

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

Public Member Functions
	UnbiasedSquaredPhaseLagIndex ()
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	computeUSPLI (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

Unbiased squared Phase Lag Index estimator; removes the small-sample bias of PhaseLagIndex.

Computes the unbiased estimator of squared PLI for every channel pair.

The estimator subtracts the analytically known diagonal contribution from the squared sum of cross-spectral sign samples, yielding an estimate whose expectation equals PLI^2 for any trial count N >= 2 and is therefore free of the upward small-sample bias that affects the plain PhaseLagIndex. The construction preserves the zero-lag rejection property of the PLI family.

Definition at line 90 of file unbiasedsquaredphaselagindex.h.

Inheritance diagram for CONNECTIVITYLIB::UnbiasedSquaredPhaseLagIndex:

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for UnbiasedSquaredPhaseLagIndex.

Definition at line 95 of file unbiasedsquaredphaselagindex.h.

SPtr

typedef QSharedPointer<UnbiasedSquaredPhaseLagIndex> CONNECTIVITYLIB::UnbiasedSquaredPhaseLagIndex::SPtr

Shared pointer type for UnbiasedSquaredPhaseLagIndex.

Definition at line 94 of file unbiasedsquaredphaselagindex.h.

Constructor & Destructor Documentation

UnbiasedSquaredPhaseLagIndex()

UnbiasedSquaredPhaseLagIndex::UnbiasedSquaredPhaseLagIndex ( )

explicit

Constructs a UnbiasedSquaredPhaseLagIndex object.

Definition at line 56 of file unbiasedsquaredphaselagindex.cpp.

Member Function Documentation

calculate()

Network UnbiasedSquaredPhaseLagIndex::calculate ( ConnectivitySettings & connectivitySettings )

static

Calculates the USPLI 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 unbiasedsquaredphaselagindex.cpp.

compute()

void UnbiasedSquaredPhaseLagIndex::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 )

staticprotected

Computes the PLI 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 sign 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 166 of file unbiasedsquaredphaselagindex.cpp.

computeUSPLI()

void UnbiasedSquaredPhaseLagIndex::computeUSPLI ( ConnectivitySettings & connectivitySettings, Network & finalNetwork )

staticprotected

Reduces the USPLI computation to a final result.

Parameters

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

Definition at line 290 of file unbiasedsquaredphaselagindex.cpp.

---

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

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