bundles / scipy latest / scipy / stats / _correlation / theilslopes

function

`scipy.stats._correlation:theilslopes`

source: build-install/usr/lib/python3.14/site-packages/scipy/stats/_correlation.py:391

Signature

def theilslopes(y, x = None, alpha = 0.95, method = separate, *, axis = None, nan_policy = propagate, keepdims = False)

Summary

Computes the Theil-Sen estimator for a set of points (x, y).

Extended Summary

theilslopes implements a method for robust linear regression. It computes the slope as the median of all slopes between paired values.

Parameters

y : array_like

Dependent variable.

x : array_like or None, optional

Independent variable. If None, use arange(len(y)) instead.

alpha : float, optional

Confidence degree between 0 and 1. Default is 95% confidence. Note that alpha is symmetric around 0.5, i.e. both 0.1 and 0.9 are interpreted as "find the 90% confidence interval".

method : {'joint', 'separate'}, optional

Method to be used for computing estimate for intercept. Following methods are supported,

'joint': Uses np.median(y - slope * x) as intercept.
'separate': Uses np.median(y) - slope * np.median(x)
as intercept.

The default is 'separate'.

axis : int or None, default: None

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.

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, a ValueError will be raised.

nan_policy='raise' and nan_policy='omit' are not supported by lazy backends, and nan_policy='omit' is not compatible with MArray input. For multidimensional input, nan_policy='omit' is supported only by the NumPy backend. Instead, mask NaN values using MArray; and use the default nan_policy. See Notes for support information.

keepdims : bool, 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

result : ``TheilslopesResult`` instance

The return value is an object with the following attributes:

slope: Theil slope.
intercept: Intercept of the Theil line.
low_slope: Lower bound of the confidence interval on slope.
high_slope: Upper bound of the confidence interval on slope.

Notes

The implementation of theilslopes follows ^[1]. The intercept is not defined in ^[1], and here it is defined as median(y) - slope*median(x), which is given in ^[3]. Other definitions of the intercept exist in the literature such as median(y - slope*x) in ^[4]. The approach to compute the intercept can be determined by the parameter method. A confidence interval for the intercept is not given as this question is not addressed in ^[1].

For compatibility with older versions of SciPy, the return value acts like a namedtuple of length 4, with fields slope, intercept, low_slope, and high_slope, so one can continue to write

slope, intercept, low_slope, high_slope = theilslopes(y, x)

Beginning in SciPy 1.9, np.matrix inputs (not recommended for new code) are converted to np.ndarray before the calculation is performed. In this case, the output will be a scalar or np.ndarray of appropriate shape rather than a 2D np.matrix. Similarly, while masked elements of masked arrays are ignored, the output will be a scalar or np.ndarray rather than a masked array with mask=False.

Examples

import numpy as np
from scipy import stats
import matplotlib.pyplot as plt

✓

x = np.linspace(-5, 5, num=150)
y = x + np.random.normal(size=x.size)
y[11:15] += 10  # add outliers
y[-5:] -= 7

✓

Compute the slope, intercept and 90% confidence interval. For comparison, also compute the least-squares fit with `linregress`:

res = stats.theilslopes(y, x, 0.90, method='separate')
lsq_res = stats.linregress(x, y)

✓

Plot the results. The Theil-Sen regression line is shown in red, with the dashed red lines illustrating the confidence interval of the slope (note that the dashed red lines are not the confidence interval of the regression as the confidence interval of the intercept is not included). The green line shows the least-squares fit for comparison.

fig = plt.figure()
ax = fig.add_subplot(111)

✓

ax.plot(x, y, 'b.')
ax.plot(x, res[1] + res[0] * x, 'r-')
ax.plot(x, res[1] + res[2] * x, 'r--')
ax.plot(x, res[1] + res[3] * x, 'r--')
ax.plot(x, lsq_res[1] + lsq_res[0] * x, 'g-')

✗

[<matplotlib.lines.Line2D object at 0x7f3f68aec590>]

plt.show()

✓

Aliases

scipy.stats.theilslopes