superstats.utils.transformations#

Parameter transformation functions.

Functions

scaled_sigmoid(x, lower_bound, upper_bound)

Apply a sigmoid transformation and rescale to a bounded interval.
superstats.utils.transformations.scaled_sigmoid(x, lower_bound, upper_bound)[source]#

Apply a sigmoid transformation and rescale to a bounded interval.

This function maps input values to a specified range using a scaled sigmoid. The transformation is: lower_bound + (upper_bound - lower_bound) / (1 + exp(-x))

Parameters:
xfloat or np.ndarray

Input value(s) to transform.

lower_boundfloat or np.ndarray

Lower bound of the output range.

upper_boundfloat or np.ndarray

Upper bound of the output range.

Returns:
yfloat or np.ndarray - transformed value(s) in

[lower_bound, upper_bound]

Parameters:
Return type:

float | ndarray