scipy.ndimage.

generic_filter#

scipy.ndimage.generic_filter(input, function, size=None, footprint=None, output=None, mode='reflect', cval=0.0, origin=0, extra_arguments=(), extra_keywords=None)[source]#

使用给定函数计算多维滤波器。

在每个元素上，都会调用提供的函数。该元素在滤波器覆盖范围内的输入值将作为一维双精度值数组传递给该函数。

参数:
inputarray_like

输入数组。

function{callable, scipy.LowLevelCallable}

要在每个元素上应用的函数。

size标量或元组，可选

参见下面的 footprint。如果给出了 footprint，则忽略。

footprint数组，可选

必须定义 size 或 footprint。 size 给出了从输入数组中取出的形状，在每个元素位置，用于定义过滤函数的输入。 footprint 是一个布尔数组，它（隐式地）指定了一个形状，但也指定了该形状内的哪些元素将传递给过滤函数。因此 size=(n,m) 等效于 footprint=np.ones((n,m))。我们根据输入数组的维度调整 size，因此，如果输入数组的形状为 (10,10,10)，而 size 为 2，则实际使用的 size 为 (2,2,2)。当给出 footprint 时，会忽略 size。

output数组或 dtype，可选

要放置输出的数组，或返回数组的 dtype。默认情况下，将创建一个与 input 具有相同 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。

origin整数或序列，可选

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

extra_arguments序列，可选

要传递给传递函数的额外位置参数序列。

extra_keywords字典，可选

要传递给传递函数的额外关键字参数字典。

返回值:
generic_filterndarray

已过滤的数组。与 input 具有相同的形状。

注释

此函数还接受以下签名之一的低级回调函数，并包装在 scipy.LowLevelCallable 中

int callback(double *buffer, npy_intp filter_size,
             double *return_value, void *user_data)
int callback(double *buffer, intptr_t filter_size,
             double *return_value, void *user_data)

调用函数遍历输入和输出数组的元素，在每个元素处调用回调函数。当前元素的滤波器覆盖范围内的元素通过 buffer 参数传递，覆盖范围内的元素数量通过 filter_size 传递。计算的值将返回到 return_value。 user_data 是按原样提供给 scipy.LowLevelCallable 的数据指针。

回调函数必须返回一个整数错误状态，如果出现错误则为零，否则为一。如果发生错误，您通常应该在返回之前使用信息性消息设置 Python 错误状态，否则调用函数将设置默认错误消息。

此外，还接受一些其他低级函数指针规范，但这些仅用于向后兼容性，在新的代码中不应使用。

示例

导入必要的模块并加载用于过滤的示例图像。

>>> import numpy as np
>>> from scipy import datasets
>>> from scipy.ndimage import zoom, generic_filter
>>> import matplotlib.pyplot as plt
>>> ascent = zoom(datasets.ascent(), 0.5)

通过将简单的 NumPy 聚合函数作为参数传递给 function 来计算内核大小为 5 的最大值滤波器。

>>> maximum_filter_result = generic_filter(ascent, np.amax, [5, 5])

虽然可以使用 maximum_filter 直接获得最大值滤波器，但 generic_filter 允许使用通用的 Python 函数或 scipy.LowLevelCallable 作为滤波器。这里，我们计算内核大小为 5 的最大值和最小值之间的范围作为示例。

>>> def custom_filter(image):
...     return np.amax(image) - np.amin(image)
>>> custom_filter_result = generic_filter(ascent, custom_filter, [5, 5])

绘制原始图像和过滤后的图像。

>>> fig, axes = plt.subplots(3, 1, figsize=(3, 9))
>>> plt.gray()  # show the filtered result in grayscale
>>> top, middle, bottom = axes
>>> for ax in axes:
...     ax.set_axis_off()  # remove coordinate system
>>> top.imshow(ascent)
>>> top.set_title("Original image")
>>> middle.imshow(maximum_filter_result)
>>> middle.set_title("Maximum filter, Kernel: 5x5")
>>> bottom.imshow(custom_filter_result)
>>> bottom.set_title("Custom filter, Kernel: 5x5")
>>> fig.tight_layout()
../../_images/scipy-ndimage-generic_filter-1.png
本页内容