gastropy.resultant_length

gastropy.resultant_length#

gastropy.resultant_length(phases)[source]#

Compute the mean resultant length of phase values.

The resultant length R measures the concentration of phases around their mean direction. R = 1 indicates all phases are identical, R = 0 indicates uniform distribution.

Parameters:

phases (array_like) – Phase values in radians.

Returns:

R – Mean resultant length in [0, 1].

Return type:

float

Examples

>>> import numpy as np
>>> phases = np.zeros(100)  # all identical
>>> resultant_length(phases)
1.0