scipy.ndimage.

correlate#

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

多维关联。

数组与给定核进行关联。

参数：

inputarray_like

输入数组。

weightsndarray

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

outputarray or dtype, optional

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

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’ 的同义词。

cvalscalar, 可选

如果 mode 为 ‘constant’，用于填充输入边缘以外的值。默认值为 0.0。

originint or sequence, 可选

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

axestuple of int or 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]])