numpy.take#

numpy.take(a, indices, axis=None, out=None, mode='raise')[source]#

沿轴从数组中提取元素。

当 axis 不为 None 时,此函数的功能与“高级”索引(使用数组索引数组)相同;但是,如果您需要沿给定轴的元素,则此函数更容易使用。例如 np.take(arr, indices, axis=3) 等效于 arr[:,:,:,indices,...]

无需高级索引,这等效于以下 ndindex 的用法,它将 iijjkk 设置为索引元组

Ni, Nk = a.shape[:axis], a.shape[axis+1:]
Nj = indices.shape
for ii in ndindex(Ni):
    for jj in ndindex(Nj):
        for kk in ndindex(Nk):
            out[ii + jj + kk] = a[ii + (indices[jj],) + kk]
参数:
aarray_like (Ni…, M, Nk…)

源数组。

indicesarray_like (Nj…)

要提取的值的索引。也允许标量作为索引。

axisint, 可选

选择值的轴。默认情况下,使用扁平化的输入数组。

outndarray, 可选 (Ni…, Nj…, Nk…)

如果提供,结果将放置在此数组中。它应该具有合适的形状和数据类型。请注意,如果 mode=’raise’,则 out 始终被缓冲;使用其他模式可获得更好的性能。

mode{‘raise’, ‘wrap’, ‘clip’}, 可选

指定越界索引的行为。

  • ‘raise’ – 抛出错误(默认)

  • ‘wrap’ – 环绕

  • ‘clip’ – 裁剪到范围

‘clip’ 模式意味着所有过大的索引都将被替换为指向该轴上最后一个元素的索引。请注意,这禁用了使用负数进行索引。

返回:
outndarray (Ni…, Nj…, Nk…)

返回的数组与 a 的类型相同。

另请参阅

compress

使用布尔掩码获取元素

ndarray.take

等效方法

take_along_axis

通过匹配数组和索引数组来获取元素

备注

通过消除上述描述中的内循环,并使用 s_ 来构建简单的切片对象,take 可以表示为将高级索引应用于每个一维切片。

Ni, Nk = a.shape[:axis], a.shape[axis+1:]
for ii in ndindex(Ni):
    for kk in ndindex(Nj):
        out[ii + s_[...,] + kk] = a[ii + s_[:,] + kk][indices]

因此,它等效于(但比)以下 apply_along_axis 的用法更快。

out = np.apply_along_axis(lambda a_1d: a_1d[indices], axis, a)

示例

>>> import numpy as np
>>> a = [4, 3, 5, 7, 6, 8]
>>> indices = [0, 1, 4]
>>> np.take(a, indices)
array([4, 3, 6])

在此示例中,如果 a 是一个 ndarray,“高级”索引可以被使用。

>>> a = np.array(a)
>>> a[indices]
array([4, 3, 6])

如果 indices 不是一维的,输出也具有这些维度。

>>> np.take(a, [[0, 1], [2, 3]])
array([[4, 3],
       [5, 7]])