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)[源代码]

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

在每个元素处调用所提供的函数。过滤占用空间中该元素的输入值将作为双精度值的一维数组传递给函数。

参数
inputarray_like

输入数组。

function{Callable,scipy.LowLevelCallable}

函数应用于每个元素。

size标量或元组,可选

请参见下面的示意图。如果给定示意图,则忽略。

footprint数组,可选

或者 sizefootprint 必须定义。 size 在每个元素位置给出从输入数组获取的形状,以定义过滤函数的输入。 footprint 是一个布尔数组,它指定(隐式)一个形状,而且指定此形状中的哪些元素将传递给过滤函数。因此, size=(n,m) 相当于 footprint=np.ones((n,m)) 。我们会调整 size 设置为输入数组的维数,以便如果输入数组是Shape(10,10,10),并且 size 为2,则实际使用的大小为(2,2,2)。什么时候 footprint 给出了, size 被忽略。

output数组或数据类型,可选

要在其中放置输出的数组,或返回的数组的数据类型。默认情况下,将创建与输入数据类型相同的数组。

mode{‘反射’,‘常量’,‘最近’,‘镜像’,‘换行’},可选

这个 mode 参数确定如何将输入数组扩展到其边界之外。默认值为“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 参数。

“最近的” (a a a a | a b c d | d d d d )

通过复制最后一个像素来扩展输入。

“镜子” (d c b | a b c d | c b a )

通过反射最后一个像素的中心来扩展输入。此模式有时也称为全样本对称。

“包装” (a b c d | a b c d | a b c d )

通过缠绕到相反的边来扩展输入。

为与插值函数保持一致,还可以使用以下模式名称:

“网格镜”

这是“反映”的同义词。

‘栅格常数’

这是“常量”的同义词。

‘网格换行’

这是“包装”的同义词。

cval标量,可选

在以下情况下填充输入的过去边缘的值 mode 是“恒定的”。默认值为0.0。

originint或Sequence,可选

控制过滤在输入数组像素上的放置。值为0(默认值)时,过滤在像素上方居中,正值使过滤向左移动,负值向右移动。通过传递长度等于输入数组维数的原点序列,可以沿每个轴指定不同的移位。

extra_arguments序列,可选

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

extra_keywordsDICT,可选

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

注意事项

此函数还接受具有以下签名之一的低级回调函数,并将其包装在 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_valueuser_data 是否将数据指针提供给 scipy.LowLevelCallable 原封不动。

回调函数必须返回整数错误状态,如果出现错误,则返回0,否则返回1。如果出现错误,通常应该在返回前使用提示性消息设置python错误状态,否则调用函数会设置默认错误消息。

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