STSLIB::StatsSourceMetrics Class Reference

Peak localisation error and spatial dispersion metrics for evaluating distributed M/EEG inverse solutions. More...

#include <sts_source_metrics.h>

Static Public Member Functions
static double	peakLocalizationError (const Eigen::Vector3d &truePos, const Eigen::Vector3d &estimatedPos)
static double	spatialDispersion (const Eigen::VectorXd &sourceAmplitudes, const Eigen::MatrixXd &sourcePositions, int peakIndex)
static int	findPeakIndex (const Eigen::VectorXd &sourceAmplitudes)

Detailed Description

Peak localisation error and spatial dispersion metrics for evaluating distributed M/EEG inverse solutions.

Source-space evaluation metrics for inverse solutions.

Provides peak localization error (PE) and spatial dispersion (SD) as defined in Lin et al. (2006) and used for CMNE evaluation in Dinh et al. (2021).

Definition at line 65 of file sts_source_metrics.h.

Member Function Documentation

findPeakIndex()

int StatsSourceMetrics::findPeakIndex ( const Eigen::VectorXd & sourceAmplitudes )

static

Find the index of the source with maximum absolute amplitude.

Parameters

[in]

sourceAmplitudes

Source amplitudes (n_sources).

Returns

Index of the peak source.

Definition at line 80 of file sts_source_metrics.cpp.

peakLocalizationError()

double StatsSourceMetrics::peakLocalizationError ( const Eigen::Vector3d & truePos, const Eigen::Vector3d & estimatedPos )

static

Peak localization error (Euclidean distance between true and estimated peak).

Parameters

[in]	truePos	True source position (3D).
[in]	estimatedPos	Estimated source position (3D).

Returns

Distance (same unit as input, typically mm).

Definition at line 44 of file sts_source_metrics.cpp.

spatialDispersion()

double StatsSourceMetrics::spatialDispersion ( const Eigen::VectorXd & sourceAmplitudes, const Eigen::MatrixXd & sourcePositions, int peakIndex )

static

Spatial dispersion (amplitude-weighted mean distance from peak).

SD = sum_k |a_k| * d(k, peak) / sum_k |a_k|

Parameters

[in]	sourceAmplitudes	Source amplitudes (n_sources).
[in]	sourcePositions	Source positions (n_sources x 3).
[in]	peakIndex	Index of the peak source.

Returns

Spatial dispersion value (same unit as positions).

Definition at line 53 of file sts_source_metrics.cpp.

---

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

• src/libraries/sts/sts_source_metrics.h
• src/libraries/sts/sts_source_metrics.cpp