neuromodes.waves.calc_wave_speed

neuromodes.waves.calc_wave_speed(r: float, gamma: float, scaled_hetero: ArrayLike | None = None) → float | NDArray

Calculate wave speed based on the two parameters of the wave model. If a scaled heterogeneity map is provided, wave speeds are calculated for each cortical vertex.

Parameters

rfloat

Axonal length scale for wave propagation in millimeters.

gammafloat

Damping parameter for wave propagation in seconds^-1.

scaled_heteroarray-like, optional

Scaled heterogeneity map of shape (n_verts,). If None, wave speed is assumed to be spatially uniform. To scale a heterogeneity map, use the eigen.scale_hetero function. Default is None.

Returns

float or np.ndarray

Wave speed across the whole surface, or at each cortical vertex if scaled_hetero is provided.