spectral_connectivity.wrapper.list_measures#

list_measures(*, category: str | None = None, default_only: bool = False, directed: bool | None = None) → list[MeasureInfo][source]#

List the connectivity measures the high-level wrapper can compute.

This is the discovery entry point: it enumerates every valid method name for multitaper_connectivity() and fourier_connectivity(), together with each measure’s output category, a one-line description, and whether it is in the default set and/or directional, and what its values mean: units, range, result dimensions, and how to read the direction.

Parameters:

  • category (str, optional) – Return only measures with this output category (e.g. "pairwise", "power", "group_pairwise"). Raises ValueError for an unknown category.

  • default_only (bool, default False) – Return only the measures computed when method is omitted.

  • directed (bool, optional) – If True, return only directional measures; if False, only non-directional ones; if None (default), return both. Non-directional does not necessarily mean symmetric: for example, phase-valued measures may be antisymmetric and complex coherency is Hermitian.

Returns:

measures – One record per measure, in the wrapper’s canonical order.

Return type:

list of MeasureInfo

Examples

>>> from spectral_connectivity import list_measures
>>> [m.name for m in list_measures(default_only=True)][:3]
['coherence_magnitude', 'coherence_phase', 'debiased_squared_phase_lag_index']
>>> next(m for m in list_measures() if m.name == "power").description
'Return the one-sided power spectral density of the signal.'