scipy.stats.

tmax#

scipy.stats.tmax(a, upperlimit=None, axis=0, inclusive=True, nan_policy='propagate', *, keepdims=False)[源代码]#

计算修剪后的最大值。

此函数计算沿给定轴的数组最大值,同时忽略大于指定上限的值。

参数:
aarray_like

值数组。

upperlimitNone 或 float,可选

输入数组中大于给定限制的值将被忽略。当 upperlimit 为 None 时,将使用所有值。默认值为 None。

axisint 或 None,默认值:0

如果为 int,则为计算统计信息的输入轴。输入的每个轴切片(例如,行)的统计信息将显示在输出的相应元素中。如果为 None,则会在计算统计信息之前将输入展平。

inclusive{True, False}, 可选

此标志确定是否包括恰好等于上限的值。默认值为 True。

nan_policy{‘propagate’, ‘omit’, ‘raise’}

定义如何处理输入 NaN。

  • propagate:如果沿其计算统计信息的轴切片(例如,行)中存在 NaN,则输出的相应条目将为 NaN。

  • omit:执行计算时将省略 NaN。如果沿其计算统计信息的轴切片中剩余的数据不足,则输出的相应条目将为 NaN。

  • raise:如果存在 NaN,则会引发 ValueError

keepdimsbool,默认值:False

如果将其设置为 True,则缩减的轴将保留在结果中,作为大小为 1 的维度。使用此选项,结果将与输入数组正确广播。

返回:
tmaxfloat、int 或 ndarray

修剪后的最大值。

注释

从 SciPy 1.9 开始,在执行计算之前,np.matrix 输入(不建议用于新代码)会转换为 np.ndarray。在这种情况下,输出将是标量或具有适当形状的 np.ndarray,而不是 2D np.matrix。同样,虽然会忽略掩码数组的掩码元素,但输出将是标量或 np.ndarray,而不是 mask=False 的掩码数组。

示例

>>> import numpy as np
>>> from scipy import stats
>>> x = np.arange(20)
>>> stats.tmax(x)
19
>>> stats.tmax(x, 13)
13
>>> stats.tmax(x, 13, inclusive=False)
12