median_abs_deviation#
- scipy.stats.median_abs_deviation(x, axis=0, center=None, scale=1.0, nan_policy='propagate', *, keepdims=False)[source]#
Compute the median absolute deviation of the data along the given axis.
The median absolute deviation (MAD, [1]) computes the median over the absolute deviations from the median. It is a measure of dispersion similar to the standard deviation but more robust to outliers [2].
The MAD of an empty array is
np.nan.Added in version 1.5.0.
- Parameters:
- xarray_like
Input array or object that can be converted to an array.
- axisint or None, default: 0
If an int, the axis of the input along which to compute the statistic. The statistic of each axis-slice (e.g. row) of the input will appear in a corresponding element of the output. If
None, the input will be raveled before computing the statistic.- centercallable, optional
A function that will return the central value. The default is to use np.median. Any user defined function used will need to have the function signature
func(arr, axis).- scalescalar or str, optional
The numerical value of scale will be divided out of the final result. The default is 1.0. The string “normal” is also accepted, and results in scale being the inverse of the standard normal quantile function at 0.75, which is approximately 0.67449. Array-like scale is also allowed, as long as it broadcasts correctly to the output such that
out / scaleis a valid operation. The output dimensions depend on the input array, x, and the axis argument.- nan_policy{‘propagate’, ‘omit’, ‘raise’}
Defines how to handle input NaNs.
propagate: if a NaN is present in the axis slice (e.g. row) along which the statistic is computed, the corresponding entry of the output will be NaN.omit: NaNs will be omitted when performing the calculation. If insufficient data remains in the axis slice along which the statistic is computed, the corresponding entry of the output will be NaN.raise: if a NaN is present, aValueErrorwill be raised.
- keepdimsbool, default: False
If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the input array.
- Returns:
- madscalar or ndarray
If
axis=None, a scalar is returned. If the input contains integers or floats of smaller precision thannp.float64, then the output data-type isnp.float64. Otherwise, the output data-type is the same as that of the input.
See also
Notes
The center argument only affects the calculation of the central value around which the MAD is calculated. That is, passing in
center=np.meanwill calculate the MAD around the mean - it will not calculate the mean absolute deviation.The input array may contain inf, but if center returns inf, the corresponding MAD for that data will be nan.
Beginning in SciPy 1.9,
np.matrixinputs (not recommended for new code) are converted tonp.ndarraybefore the calculation is performed. In this case, the output will be a scalar ornp.ndarrayof appropriate shape rather than a 2Dnp.matrix. Similarly, while masked elements of masked arrays are ignored, the output will be a scalar ornp.ndarrayrather than a masked array withmask=False.Array API Standard Support
median_abs_deviationhas experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variableSCIPY_ARRAY_API=1and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported.Library
CPU
GPU
NumPy
✅
n/a
CuPy
n/a
✅
PyTorch
✅
✅
JAX
⛔
⛔
Dask
⛔
n/a
See Support for the array API standard for more information.
References
[1]“Median absolute deviation”, https://en.wikipedia.org/wiki/Median_absolute_deviation
[2]“Robust measures of scale”, https://en.wikipedia.org/wiki/Robust_measures_of_scale
Examples
When comparing the behavior of
median_abs_deviationwithnp.std, the latter is affected when we change a single value of an array to have an outlier value while the MAD hardly changes:>>> import numpy as np >>> from scipy import stats >>> x = stats.norm.rvs(size=100, scale=1, random_state=123456) >>> x.std() 0.9973906394005013 >>> stats.median_abs_deviation(x) 0.82832610097857 >>> x[0] = 345.6 >>> x.std() 34.42304872314415 >>> stats.median_abs_deviation(x) 0.8323442311590675
Axis handling example:
>>> x = np.array([[10, 7, 4], [3, 2, 1]]) >>> x array([[10, 7, 4], [ 3, 2, 1]]) >>> stats.median_abs_deviation(x) array([3.5, 2.5, 1.5]) >>> stats.median_abs_deviation(x, axis=None) 2.0
Scale normal example:
>>> x = stats.norm.rvs(size=1000000, scale=2, random_state=123456) >>> stats.median_abs_deviation(x) 1.3487398527041636 >>> stats.median_abs_deviation(x, scale='normal') 1.9996446978061115