neuromodes.eigen.standardize_modes

neuromodes.eigen.standardize_modes(emodes: ArrayLike) → NDArray

Flips the modes’ signs such that the first element of each eigenmode has positive amplitude. Note that the sign of each mode is arbitrary–standardisation is only helpful to compare sets of eigenmodes.

Parameters

emodesarray-like

The eigenmodes array of shape (n_verts, n_modes), where n_modes is the number of eigenmodes.

Returns

numpy.ndarray

The standardized eigenmodes array of shape (n_verts, n_modes), with the first element of each mode set to be positive.