lyman.signals.cv¶

lyman.signals.cv(data, axis=0, detrend=True, mask=None, keepdims=False, ddof=0)[source]¶

Compute the temporal coefficient of variation.

Parameters

datanumpy array: Time series data.
axisint: Axis to compute the mean and standard deviation over.
detrendbool: If True, linearly detrend the data before computing standard deviation.
maskboolean array with same shape as data on all but final axis: If present, cv is computed only for entries that are True in the mask. Only valid when the computation axis is the final axis in the data. Values in the returned array outside of the mask will be 0.
keepdimsbool: If True, output will have the same dimensions as input.
ddofint: Means delta degrees of freedom for the standard deviation.

Returns