numpy.clip#

numpy.clip(a, a_min=<no value>, a_max=<no value>, out=None, *, min=<no value>, max=<no value>, **kwargs)[源代码]#

裁剪(限制)数组中的值。

给定一个区间,区间外的值将被裁剪到区间边缘。 例如,如果指定区间 [0, 1],则小于 0 的值变为 0,大于 1 的值变为 1。

等效于但快于 np.minimum(a_max, np.maximum(a, a_min))

不执行检查以确保 a_min < a_max

参数:
aarray_like

包含要裁剪的元素的数组。

a_min, a_maxarray_like 或 None

最小值和最大值。如果为 None,则不对相应的边缘执行裁剪。如果 a_mina_max 均为 None,则返回数组的元素保持不变。两者都针对 a 进行广播。

outndarray,可选

结果将放置在此数组中。 它可能是用于就地裁剪的输入数组。 out 的形状必须适合保存输出。 其类型会被保留。

min, maxarray_like 或 None

与数组 API 兼容的 a_mina_max 参数的替代方案。可以同时传递 a_mina_maxminmax。默认值:None

2.1.0 版本中的新功能。

**kwargs

对于其他仅限关键字的参数,请参阅 ufunc 文档

返回:
clipped_arrayndarray

一个数组,包含 a 的元素,但其中值 < a_min 的被替换为 a_min,而值 > a_max 的被替换为 a_max

注释

a_min 大于 a_max 时,clip 返回一个数组,其中所有值都等于 a_max,如第二个示例所示。

示例

>>> import numpy as np
>>> a = np.arange(10)
>>> a
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
>>> np.clip(a, 1, 8)
array([1, 1, 2, 3, 4, 5, 6, 7, 8, 8])
>>> np.clip(a, 8, 1)
array([1, 1, 1, 1, 1, 1, 1, 1, 1, 1])
>>> np.clip(a, 3, 6, out=a)
array([3, 3, 3, 3, 4, 5, 6, 6, 6, 6])
>>> a
array([3, 3, 3, 3, 4, 5, 6, 6, 6, 6])
>>> a = np.arange(10)
>>> a
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
>>> np.clip(a, [3, 4, 1, 1, 1, 4, 4, 4, 4, 4], 8)
array([3, 4, 2, 3, 4, 5, 6, 7, 8, 8])