numpy.gradient#

numpy.gradient(f, *varargs, axis=None, edge_order=1)[source]#

返回 N 维数组的梯度。

梯度使用内部点的二阶精确中心差分以及边界处的二阶或一阶精确单边(前向或后向)差分计算。因此,返回的梯度与输入数组具有相同的形状。

参数:
farray_like

包含标量函数样本的 N 维数组。

varargs标量或数组列表,可选

f 值之间的间距。所有维度默认为单位间距。可以使用以下方式指定间距:

  1. 单个标量,为所有维度指定一个样本距离。

  2. N 个标量,为每个维度指定一个常数样本距离。即 dxdydz 等。

  3. N 个数组,指定 F 沿每个维度值的坐标。数组的长度必须与对应维度的尺寸匹配。

  4. 2 和 3 的 N 个标量/数组的任意组合。

如果给出 axis,则 varargs 的数量必须等于轴的数量。默认值:1。(参见下面的示例)。

edge_order{1, 2},可选

使用边界处 N 阶精确差分计算梯度。默认值:1。

版本 1.9.1 中的新增内容。

axisNone 或 int 或 int 元组,可选

梯度仅沿给定轴或轴计算。默认值(axis = None)是为输入数组的所有轴计算梯度。axis 可以为负数,在这种情况下,它从最后一个轴到第一个轴计数。

版本 1.11.0 中的新增内容。

返回值:
gradientndarray 或 ndarray 元组

对应于 f 关于每个维度导数的 ndarray 元组(如果只有一个维度,则为单个 ndarray)。每个导数都与 f 具有相同的形状。

注释

假设 \(f\in C^{3}\)(即 \(f\) 至少具有 3 个连续导数)并且设 \(h_{*}\) 为非均匀步长,我们最小化真实梯度与其从相邻网格点的线性组合估计之间的“一致性误差” \(\eta_{i}\)

\[\eta_{i} = f_{i}^{\left(1\right)} - \left[ \alpha f\left(x_{i}\right) + \beta f\left(x_{i} + h_{d}\right) + \gamma f\left(x_{i}-h_{s}\right) \right]\]

通过用其泰勒级数展开式替换 \(f(x_{i} + h_{d})\)\(f(x_{i} - h_{s})\),这转化为求解以下线性系统

\[\begin{split}\left\{ \begin{array}{r} \alpha+\beta+\gamma=0 \\ \beta h_{d}-\gamma h_{s}=1 \\ \beta h_{d}^{2}+\gamma h_{s}^{2}=0 \end{array} \right.\end{split}\]

得到的 \(f_{i}^{(1)}\) 近似值为:

\[\hat f_{i}^{(1)} = \frac{ h_{s}^{2}f\left(x_{i} + h_{d}\right) + \left(h_{d}^{2} - h_{s}^{2}\right)f\left(x_{i}\right) - h_{d}^{2}f\left(x_{i}-h_{s}\right)} { h_{s}h_{d}\left(h_{d} + h_{s}\right)} + \mathcal{O}\left(\frac{h_{d}h_{s}^{2} + h_{s}h_{d}^{2}}{h_{d} + h_{s}}\right)\]

值得注意的是,如果 \(h_{s}=h_{d}\)(即数据等距),我们找到了标准的二阶近似值

\[\hat f_{i}^{(1)}= \frac{f\left(x_{i+1}\right) - f\left(x_{i-1}\right)}{2h} + \mathcal{O}\left(h^{2}\right)\]

通过类似的过程,可以推导出用于边界的向前/向后近似值。

参考

[1]

Quarteroni A., Sacco R., Saleri F. (2007) 数值数学(应用数学课本)。纽约:施普林格。

[2]

Durran D. R. (1999) 地球物理流体动力学中波动方程的数值方法。纽约:施普林格。

[3]

Fornberg B. (1988) 在任意间距网格上生成有限差分公式,计算数学 51,第 184 期:699-706。 PDF.

示例

>>> import numpy as np
>>> f = np.array([1, 2, 4, 7, 11, 16])
>>> np.gradient(f)
array([1. , 1.5, 2.5, 3.5, 4.5, 5. ])
>>> np.gradient(f, 2)
array([0.5 ,  0.75,  1.25,  1.75,  2.25,  2.5 ])

间距也可以使用表示 F 沿维度值的坐标的数组来指定。例如,均匀间距

>>> x = np.arange(f.size)
>>> np.gradient(f, x)
array([1. ,  1.5,  2.5,  3.5,  4.5,  5. ])

或非均匀间距

>>> x = np.array([0., 1., 1.5, 3.5, 4., 6.])
>>> np.gradient(f, x)
array([1. ,  3. ,  3.5,  6.7,  6.9,  2.5])

对于二维数组,返回值将是按轴排序的两个数组。在这个示例中,第一个数组代表行方向的梯度,第二个数组代表列方向的梯度

>>> np.gradient(np.array([[1, 2, 6], [3, 4, 5]]))
(array([[ 2.,  2., -1.],
        [ 2.,  2., -1.]]),
 array([[1. , 2.5, 4. ],
        [1. , 1. , 1. ]]))

在这个示例中,间距也指定了:axis=0 为均匀间距,axis=1 为非均匀间距

>>> dx = 2.
>>> y = [1., 1.5, 3.5]
>>> np.gradient(np.array([[1, 2, 6], [3, 4, 5]]), dx, y)
(array([[ 1. ,  1. , -0.5],
        [ 1. ,  1. , -0.5]]),
 array([[2. , 2. , 2. ],
        [2. , 1.7, 0.5]]))

可以使用 edge_order 指定边界如何处理

>>> x = np.array([0, 1, 2, 3, 4])
>>> f = x**2
>>> np.gradient(f, edge_order=1)
array([1.,  2.,  4.,  6.,  7.])
>>> np.gradient(f, edge_order=2)
array([0., 2., 4., 6., 8.])

可以使用 axis 关键字指定计算梯度的一组轴

>>> np.gradient(np.array([[1, 2, 6], [3, 4, 5]]), axis=0)
array([[ 2.,  2., -1.],
       [ 2.,  2., -1.]])

varargs 参数定义输入数组中样本点之间的间距。它可以采用两种形式

  1. 一个数组,指定坐标,这些坐标可能是不均匀的

>>> x = np.array([0., 2., 3., 6., 8.])
>>> y = x ** 2
>>> np.gradient(y, x, edge_order=2)
array([ 0.,  4.,  6., 12., 16.])
  1. 一个标量,表示固定的样本距离

>>> dx = 2
>>> x = np.array([0., 2., 4., 6., 8.])
>>> y = x ** 2
>>> np.gradient(y, dx, edge_order=2)
array([ 0.,  4.,  8., 12., 16.])

可以为每个维度提供不同的间距数据。参数数量必须与输入数据中的维度数量匹配。

>>> dx = 2
>>> dy = 3
>>> x = np.arange(0, 6, dx)
>>> y = np.arange(0, 9, dy)
>>> xs, ys = np.meshgrid(x, y)
>>> zs = xs + 2 * ys
>>> np.gradient(zs, dy, dx)  # Passing two scalars
(array([[2., 2., 2.],
        [2., 2., 2.],
        [2., 2., 2.]]),
 array([[1., 1., 1.],
        [1., 1., 1.],
        [1., 1., 1.]]))

混合标量和数组也是允许的

>>> np.gradient(zs, y, dx)  # Passing one array and one scalar
(array([[2., 2., 2.],
        [2., 2., 2.],
        [2., 2., 2.]]),
 array([[1., 1., 1.],
        [1., 1., 1.],
        [1., 1., 1.]]))