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)

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

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

参数:

输入array_like

输入数组。

函数{callable, scipy.LowLevelCallable}

应用于每个元素的函数。

大小标量或元组，可选

见下方足迹。如果提供了足迹，则忽略。

足迹数组，可选

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

输出数组或数据类型，可选

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

模式{‘reflect’, ‘constant’, ‘nearest’, ‘mirror’, ‘wrap’}，可选

mode 参数决定了输入数组在边界之外如何扩展。默认值是 ‘reflect’。每个有效值的行为如下：

‘reflect’ (d c b a | a b c d | d c b a)

输入通过反射最后一个像素的边缘来扩展。这种模式有时也被称为半样本对称。

‘常量’ (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-wrap’

这是 ‘wrap’ 的同义词。

cval标量，可选

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

起源int 或 sequence，可选

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

extra_arguments序列，可选

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

extra_keywordsdict, 可选

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

返回:

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错误状态，否则调用函数将设置默认错误消息。

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

示例

Try it in your browser!

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

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

Go BackOpen In Tab