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 = -1 表示最大的元素。

size标量或元组,可选

请参阅下面的 footprint。如果给出了 footprint,则忽略此参数。

footprint数组,可选

必须定义 sizefootprintsize 给出了从输入数组中提取的形状,在每个元素位置,定义滤波器函数的输入。footprint 是一个布尔数组,它(隐式地)指定一个形状,以及该形状内的哪些元素将传递给滤波器函数。因此,size=(n,m) 等价于 footprint=np.ones((n,m))。我们根据输入数组的维度调整 size,因此,如果输入数组的形状为 (10,10,10),并且 size 为 2,则实际使用的 size 为 (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(默认值)将滤波器居中放置在像素上方,正值将滤波器向左移动,负值将滤波器向右移动。通过传递长度等于输入数组维数的原点序列,可以沿每个轴指定不同的偏移。

axes整数元组或 None,可选

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

返回:
rank_filterndarray

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

示例

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