UnbiasedSquaredPhaseLagIndex
Namespace: CONNECTIVITYLIB · Library: Connectivity Library
#include <connectivity/unbiasedsquaredphaselagindex.h>
class CONNECTIVITYLIB::UnbiasedSquaredPhaseLagIndex
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.
Unbiased squared Phase Lag Index estimator; removes the small-sample bias of PhaseLagIndex.
Network uspli = UnbiasedSquaredPhaseLagIndex::calculate(settings);
uspli.setFrequencyRange(8.0f, 12.0f);
Inheritance
Public Methods
UnbiasedSquaredPhaseLagIndex()
Constructs a UnbiasedSquaredPhaseLagIndex object.
Static Methods
calculate(connectivitySettings)
Calculates the USPLI between the rows of the data matrix.
Parameters:
- connectivitySettings : ConnectivitySettings & The input data and parameters.
Returns:
- Network — The connectivity information in form of a network structure.
Example
- Full source:
src/examples/ex_connectivity_metrics/main.cpp - Build target:
ex_connectivity_metrics(runs under CTest)
Used in examples
ex_connectivity_metrics
Connectivity metrics on synthetic data with a known coupling.
wpli.setFrequencyRange(8.0f, 12.0f);
Network uspli = UnbiasedSquaredPhaseLagIndex::calculate(settings);
uspli.setFrequencyRange(8.0f, 12.0f);
Network dswpli = DebiasedSquaredWeightedPhaseLagIndex::calculate(settings);
dswpli.setFrequencyRange(8.0f, 12.0f);
Network plv = PhaseLockingValue::calculate(settings);
plv.setFrequencyRange(8.0f, 12.0f);
Authors of this file
- Daniel Strohmeier <daniel.strohmeier@gmail.com>
- Lorenz Esch <lorenz.esch@tu-ilmenau.de>
- Juan GPC <jgarciaprieto@mgh.harvard.edu>
- Gabriel Motta <gabrielbenmotta@gmail.com>
- Christoph Dinh <christoph.dinh@mne-cpp.org>