elephant.phase_analysis.mean_phase_vector

elephant.phase_analysis.mean_phase_vector(phases, axis=0)[source]

Calculates the mean vector of phases.

This function expects phases (in radians) and uses their representation as complex numbers to calculate the direction \theta and the length r of the mean vector.

Parameters:
phasesnp.ndarray

Phases in radians.

axisint, optional

Axis along which the mean vector will be calculated. If None, it will be computed across the flattened array. Default: 0
Returns:
z_mean_thetanp.ndarray

Angle of the mean vector. Range: (-\pi, \pi]

z_mean_rnp.ndarray

Length of the mean vector. Range: [0, 1]