locan.utils.statistics.weighted_mean_variance#

locan.utils.statistics.weighted_mean_variance(values, weights)[source]#

Compute weighted mean (average) and the corresponding weighted mean variance [1].

Parameters:
  • values (Union[_SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[Union[bool, int, float, complex, str, bytes]]]) – Values from which to compute the weighted average.

  • weights (Union[_SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[Union[bool, int, float, complex, str, bytes]], None]) – Weights to use for weighted average.

Returns:

weighted_mean, weighted_mean_variance

Return type:

WeightedMeanVariance

References