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 计算。保留输入掩码。

参数:
aarray_like

输入数组

n整型,可选

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

axis整型,可选

进行差分运算的轴,默认为最后一个轴。

prepend, appendarray_like,可选

在执行差分之前,要沿轴 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)