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, *, axes=None)

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

在每个元素上调用提供的函数。该元素处的滤波器足迹内的输入值作为双精度值的一维数组传递给函数。

参数:

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，则使用的实际大小为 (2,2,2)。当给定 footprint 时，将忽略 size。

output数组或 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。

origin整数或序列，可选

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

extra_arguments序列，可选

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

extra_keywords字典，可选

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

axes整数元组或 None，可选

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

返回:

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()

返回在新标签页中打开