scipy.ndimage.

correlate#

scipy.ndimage.correlate(input, weights, output=None, mode='reflect', cval=0.0, origin=0, *, axes=None)[源代码]#

多维相关。

该数组与给定的核进行相关运算。

参数:

inputarray_like

输入数组。

weightsndarray

权重数组，与输入具有相同的维度数

outputarray 或 dtype，可选

放置输出的数组，或者返回数组的 dtype。默认情况下，将创建一个与输入具有相同 dtype 的数组。

mode{‘reflect’, ‘constant’, ‘nearest’, ‘mirror’, ‘wrap’}, 可选

mode 参数确定如何将输入数组扩展到其边界之外。默认为 ‘reflect’。每个有效值的行为如下

‘reflect’ (d c b a | a b c d | d c b a): 输入通过反射最后一个像素的边缘进行扩展。这种模式有时也称为半采样对称。
‘constant’ (k k k k | a b c d | k k k k): 输入通过用相同的常量值填充边缘之外的所有值进行扩展，该常量值由 cval 参数定义。
‘nearest’ (a a a a | a b c d | d d d d): 输入通过复制最后一个像素进行扩展。
‘mirror’ (d c b | a b c d | c b a): 输入通过反射最后一个像素的中心进行扩展。这种模式有时也称为全采样对称。
‘wrap’ (a b c d | a b c d | a b c d): 输入通过环绕到相反的边缘进行扩展。

为了与插值函数保持一致，还可以使用以下模式名称

‘grid-mirror’: 这是 ‘reflect’ 的同义词。
‘grid-constant’: 这是 ‘constant’ 的同义词。
‘grid-wrap’: 这是 ‘wrap’ 的同义词。

cval标量，可选

如果 mode 为 ‘constant’，则用此值填充输入边缘之外的区域。默认值为 0.0。

originint 或序列，可选

控制滤波器在输入数组像素上的位置。值为 0（默认值）将滤波器置于像素的中心，正值将滤波器向左移动，负值将滤波器向右移动。通过传递与输入数组维度数长度相等的原点序列，可以指定沿每个轴的不同偏移。

axesint 的元组或 None，可选

如果为 None，则沿着所有轴过滤 input。否则，沿着指定的轴过滤 input。当指定 axes 时，用于 mode 或 origin 的任何元组都必须与 axes 的长度匹配。这些元组中的第 i 个条目对应于 axes 中的第 i 个条目。

返回:

resultndarray: input 与 weights 相关运算的结果。

另请参阅

convolve: 用核卷积图像。

示例

相关是移动滤波器掩码（通常称为核）在图像上并在每个位置计算乘积之和的过程。

>>> from scipy.ndimage import correlate
>>> import numpy as np
>>> input_img = np.arange(25).reshape(5,5)
>>> print(input_img)
[[ 0  1  2  3  4]
[ 5  6  7  8  9]
[10 11 12 13 14]
[15 16 17 18 19]
[20 21 22 23 24]]

定义用于相关的核（权重）。在此示例中，它用于中心以及向上、向下、向左和向右相邻元素的总和。

>>> weights = [[0, 1, 0],
...            [1, 1, 1],
...            [0, 1, 0]]

我们可以计算相关结果：例如，元素 [2,2] 是 7 + 11 + 12 + 13 + 17 = 60。

>>> correlate(input_img, weights)
array([[  6,  10,  15,  20,  24],
    [ 26,  30,  35,  40,  44],
    [ 51,  55,  60,  65,  69],
    [ 76,  80,  85,  90,  94],
    [ 96, 100, 105, 110, 114]])