neuromodes.eigen.scale_hetero

neuromodes.eigen.scale_hetero(hetero: ArrayLike, alpha: float = 1.0, scaling: str = 'sigmoid') → NDArray

Scales a heterogeneity map using specified normalization and scaling functions.

Parameters

heteroarray-like: The heterogeneity map to be scaled.
alphafloat, optional: Scaling parameter controlling the strength of the transformation. Default is 1.0.
scalingstr, optional: The scaling function to apply to the heterogeneity map, either ‘sigmoid’ or ‘exponential’. Default is ‘sigmoid’.

Returns

ndarray: The scaled heterogeneity map.

Raises

ValueError: If hetero is not a 1D array.
ValueError: If scaling is not ‘exponential’ or ‘sigmoid’.
ValueError: If hetero is constant.