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)[source]#

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

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

参数:
inputarray_like (类数组)

输入数组。

function{可调用对象, 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（默认）将滤波器居中于像素，正值将滤波器向左移动，负值向右移动。通过传递一个长度等于输入数组维度数量的 origin 序列，可以沿每个轴指定不同的偏移量。

extra_arguments序列, 可选

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

extra_keywords字典, 可选

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

axes整型元组或 None, 可选

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

返回:
outputndarray

滤波后的数组。与 input 具有相同的形状。

另请参阅

vectorized_filter

类似的功能，但为向量化可调用对象进行了优化

备注

此函数非常适合与 scipy.LowLevelCallable 的实例一起使用；对于向量化的纯 Python 可调用对象，请考虑使用 vectorized_filter 以提高性能。

低级别回调函数必须具有以下签名之一：

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
本页内容