vmr#

named_arrays.vmr(a, axis=None, dtype=None, out=None, keepdims=False, *, where=True)#

Compute the variance-to-mean ratio (also known as the Fano factor) of the given array.

Parameters:
  • a (ArrayT) – Input array

  • axis (None | str | Sequence[str]) – The axis or axes along which to compute the VMR. If None (the default), the VMR is computed along all the axes of the array.

  • dtype (None | str | Type | dtype) – The data type of the output

  • out (None | AbstractExplicitArray) – An optional output array in which to store the results.

  • keepdims (bool) – If True, the resulting array will have the same dimensionality.

  • where (bool | WhereT) – A boolean mask indicating which elements to consider when computing the VMR.

Return type:

ArrayT | WhereT