scipy.ndimage.

rank_filter#

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

计算多维秩过滤器。

参数:
inputarray_like

输入数组。

rankint

rank 参数可以小于零，例如，rank = -1 表示最大的元素。

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 将被忽略。

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

cval标量，可选

如果 mode 为 'constant'，则用于填充输入超出边缘的值。默认值为 0.0。

originint 或序列，可选

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

axestuple of int or None, optional

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

返回:
rank_filterndarray

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

附注

数组 API 标准支持

除了 NumPy 之外，rank_filter 还对符合 Python Array API 标准的后端提供了实验性支持。通过设置环境变量 SCIPY_ARRAY_API=1 并提供 CuPy、PyTorch、JAX 或 Dask 数组作为数组参数，可以测试这些功能。支持以下后端和设备（或其他功能）的组合。

库

CPU

GPU

NumPy

✅

不适用

CuPy

不适用

✅

PyTorch

✅

⛔

JAX

⚠️ 无 JIT

⛔

Dask

⚠️ 计算图

不适用

有关更多信息，请参阅 对数组 API 标准的支持。

示例

>>> from scipy import ndimage, datasets
>>> import matplotlib.pyplot as plt
>>> fig = plt.figure()
>>> plt.gray()  # show the filtered result in grayscale
>>> ax1 = fig.add_subplot(121)  # left side
>>> ax2 = fig.add_subplot(122)  # right side
>>> ascent = datasets.ascent()
>>> result = ndimage.rank_filter(ascent, rank=42, size=20)
>>> ax1.imshow(ascent)
>>> ax2.imshow(result)
>>> plt.show()
../../_images/scipy-ndimage-rank_filter-1.png
本页内容