numpy.ma.diff#

ma.diff(a, /, n=1, axis=-1, prepend=<no value>, append=<no value>)[源代码]#

计算给定轴上 n 阶离散差分。第一个差分由 out[i] = a[i+1] - a[i] 沿给定轴计算,更高阶差分通过递归使用 diff 计算。保留输入掩码。

参数:
a类数组对象

输入数组。

nint, optional

差分值的次数。如果为零,则按原样返回输入。

axisint, optional

差分所在的轴,默认为最后一个轴。

prepend, appendarray_like, optional

在沿轴执行差分之前,在 a 的前面或后面添加的值。标量值将沿轴扩展为长度为 1 的数组,并在所有其他轴上具有与输入数组相同的形状。否则,维度和形状必须匹配 a,但沿轴除外。

返回:
diffMaskedArray

n 阶差分。输出的形状与 a 相同,但沿 axis 的维度比 n 小。输出的类型与 a 中任意两个元素之间差分的类型相同。在大多数情况下,这与 a 的类型相同。一个值得注意的例外是 datetime64,它会产生一个 timedelta64 输出数组。

另请参阅

numpy.diff

顶级 NumPy 模块中的等效函数。

备注

布尔数组的类型得以保留,因此当连续元素相同时结果将为 False,当它们不同时结果将为 True

对于无符号整数数组,结果也将是无符号的。这并不令人意外,因为结果与直接计算差分一致

>>> u8_arr = np.array([1, 0], dtype=np.uint8)
>>> np.ma.diff(u8_arr)
masked_array(data=[255],
             mask=False,
       fill_value=np.uint64(999999),
            dtype=uint8)
>>> u8_arr[1,...] - u8_arr[0,...]
np.uint8(255)

如果不需要此行为,则应先将数组转换为更大的整数类型

>>> i16_arr = u8_arr.astype(np.int16)
>>> np.ma.diff(i16_arr)
masked_array(data=[-1],
             mask=False,
       fill_value=np.int64(999999),
            dtype=int16)

示例

>>> import numpy as np
>>> a = np.array([1, 2, 3, 4, 7, 0, 2, 3])
>>> x = np.ma.masked_where(a < 2, a)
>>> np.ma.diff(x)
masked_array(data=[--, 1, 1, 3, --, --, 1],
        mask=[ True, False, False, False,  True,  True, False],
    fill_value=999999)
>>> np.ma.diff(x, n=2)
masked_array(data=[--, 0, 2, --, --, --],
            mask=[ True, False, False,  True,  True,  True],
    fill_value=999999)
>>> a = np.array([[1, 3, 1, 5, 10], [0, 1, 5, 6, 8]])
>>> x = np.ma.masked_equal(a, value=1)
>>> np.ma.diff(x)
masked_array(
    data=[[--, --, --, 5],
            [--, --, 1, 2]],
    mask=[[ True,  True,  True, False],
            [ True,  True, False, False]],
    fill_value=1)
>>> np.ma.diff(x, axis=0)
masked_array(data=[[--, --, --, 1, -2]],
        mask=[[ True,  True,  True, False, False]],
    fill_value=1)