helixmc.util.circmean

helixmc.util.circmean(arr, axis=None)

Circular mean of angles. Results are in [-pi, pi]. Note that scipy.stats has a similar function, but we re-implement it because the scipy one depends on its version.

Parameters:

arr : ndarray

Input numpy array.

axis : int, optional

Axis on which the mean is computed.

Returns:

mean : ndarray

The circular mean.