scipy.stats.

tmax#

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

計算修剪後的最大值。

此函數計算沿給定軸的陣列最大值,同時忽略大於指定上限的值。

參數:
aarray_like

數值陣列。

upperlimitNone 或 float, 選項性

輸入陣列中大於給定限制的值將被忽略。當 upperlimit 為 None 時,將使用所有值。預設值為 None。

axisint 或 None, 預設值:0

如果是整數,則為計算統計量的輸入軸。輸入的每個軸切片(例如,列)的統計量將出現在輸出的對應元素中。如果 None,則輸入將在計算統計量之前被展平。

inclusive{True, False}, 選項性

此旗標決定是否包含完全等於上限的值。預設值為 True。

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

定義如何處理輸入的 NaN。

  • propagate: 如果沿著計算統計量的軸切片(例如,列)中存在 NaN,則輸出中的對應條目將為 NaN。

  • omit: 在執行計算時將省略 NaN。如果沿著計算統計量的軸切片中剩餘的資料不足,則輸出中的對應條目將為 NaN。

  • raise: 如果存在 NaN,將引發 ValueError

keepdimsbool, 預設值:False

如果設定為 True,則縮減的軸將保留在結果中,作為大小為一的維度。使用此選項,結果將正確地廣播到輸入陣列。

返回值:
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