numpy.ma.diff#

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

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

参数:
aarray_like

输入数组

nint, 可选

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

axisint, 可选

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

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)