spectral_connectivity.wrapper.MeasureInfo

class MeasureInfo(name: str, category: str, description: str, is_default: bool, is_directed: bool, requires_two_sided: bool, long_name: str, units: str, value_range: tuple[float, float], is_complex: bool, dims: tuple[str, ...], interpretation: str)

Bases: object

A single connectivity measure the high-level wrapper can compute.

name

Value to pass as method to multitaper_connectivity() or fourier_connectivity(), and the name of the corresponding Connectivity method.

Type:

str

category

The output-shape contract, one of "pairwise", "power", "group_pairwise", "multivariate_components", "delay", "global", "group_delay", or "phase_slope".

Type:

str

description

One-line summary taken from the Connectivity method’s docstring.

Type:

str

is_default

Whether the measure is in the default set computed when method is omitted (see DEFAULT_METHODS).

Type:

bool

is_directed

Whether the measure is directional (source -> target asymmetric).

Type:

bool

requires_two_sided

Whether the measure requires a full two-sided spectrum, including negative-frequency bins.

Type:

bool

long_name

Human-readable name, also the long_name attribute of the result.

Type:

str

units

Units of the values: "1" for a dimensionless score, "rad", "s", or "(input units)^2/Hz" for a spectral density.

Type:

str

value_range

(lower, upper) bounds of the values, or of their magnitude when is_complex; inf marks an unbounded side.

Type:

tuple of float

is_complex

Whether the values are complex.

Type:

bool

dims

Dimensions of the measure’s variable in the wrapper’s result, before band reduction or squeezing. Rich results (canonical_coherency, global_coherence, …) are Datasets whose variable named name has these dimensions.

Type:

tuple of str

interpretation

How to read the values, including the sign convention where one exists.

Type:

str

Methods

Attributes

name
category
description
is_default
is_directed
requires_two_sided
long_name
units
value_range
is_complex
dims
interpretation