多次元配列から任意の要素を取得するnumpy.choose()の使い方

numpy.choose()は、インダイスの配列によって、多次元配列から要素を取得する際に使います。これを使わない場合と比べて、かなり自由に任意の値を取得することが可能になります。

解説が多少長くなっていますので、まずサンプルコードを先に見てからの方が理解が早いかもしれません。それでは見ていきましょう。

目次

1. numpy.choose()の使い方

まずは基本書式を確認しましょう。

numpy.choose関数

書き方:

np.choose(a, choices, out=None, mode='raise')

パラメーター:

引数 解説
a  int array     この配列は必ず[0, n-1]の範囲の整数を格納している必要があります。n はchoicesの数です。mode=wrapまたはmode=clipでは、整数の範囲の制限はありません。
choices  sequence
of arrays
Choice配列です。配列a とchoicesに渡す配列のシーケンスのそれぞれの配列はすべて同一shapeかブロードキャスト可能である必要があります。もしchoices が単一の配列(非推奨)の場合は、最も外側の次元がシーケンスを定義づけに割かれます。 
out* array 出力結果の配列で既存の配列を上書きします。それぞれの配列のshapeとdtypeが合致している必要があります。 
mode* {‘raise’,
‘wrap’,
‘clip’}
[0, n-1]の範囲外のインダイスの処理を指定します。
・raise(デフォルト): 例外をあげる
・wrap: 値をmod n にする
・clip: 0より小さな値を0に、n-1より大きな値をn-1にmapする 
* はオプション引数であることを示します。

戻り値: 

併合した配列
a とchoices に渡した配列を併合した新しい配列を生成します。

例外:

ValueError:
a と choices のそれぞれの配列がブロードキャスト可能でないか同じshapeでない場合

一緒に確認したい関数:

  • ndarray.choose: 同機能のメソッド版
  • numpy.take_along_axis: choicesが1つの配列の場合はこちらが推奨
ndarray.chooseメソッド

書き方:

ndarray.choose(choices, out=None, mode='raise')

Note

この関数は基本的に以下のコードと同じです。

np.choose(a,choices) == np.array([c[a[i]][i] for i in ndi.ndindex(a.shape)])
*ndi = numpy.lib.index_tricks

基本的にはこのように覚えておけば問題ありません。

しかし、modeの指定によって、配列a のインダイスの数値が、choices に渡すシーケンス内の配列の数を超えている場合の扱いが異なります。この点を含めると、厳密には次のような手順で処理されます。

numpy.choose(a, choices)には、第一引数a に要素が整数(int型)のインデックス配列を渡し、第二引数choices に配列のシーケンスを渡します。すると、a 及び choices のそれぞれの配列は、必要ならまず、Ba と Bchoices[i], i = 0,…,n-1 を呼び出すことでブロードキャストします。必然的に、それぞれのi についてBa.shape == Bchoices[i].shapeとなります。次に Ba.shape の形状の新しい配列が以下のルールに則って生成されます。

  • mode=raise (デフォルト)では、配列a のそれぞれの要素(つまりBa) は [0, n-1] の範囲でなければいけません。i が、この範囲においてBa の(j0, j1, …, jm) の位置の値だとしたら、新しい配列の同位置の値はBchoices[i] の同位置の値になります。
  • mode=wrap では、配列a (つまりBa)の値は、あらゆる符号付き整数になり得ます。[0, n-1]の範囲外の整数を範囲内にmapする際にはモジュラー計算が使われます。そして、新しい配列が上述のコードの通り生成されます。
  • mode=clip では、配列a (つまりBa)の値は、あらゆる符号付き整数になり得ます。負の整数は0にmapされます。n-1より大きな値はn-1にmapされます。そして、新しい配列が上述のコードの通りに生成されます。

2. サンプルコード

それではサンプルコードを確認しましょう。

まず、第一引数に渡す配列a と第二引数に渡す配列choices を作成しておきます。

In [1]:
import numpy as np
a = np.array([2, 3, 1, 0])
choices = np.array([[0, 1, 2, 3], [10, 11, 12, 13], [20, 21, 22, 23], [30, 31, 32, 33]])

numpy.choose()は、この配列choices の中から、第一引数に渡したインダイス配列a に従って順番に要素を取得していきます。詳しくは、以下のコード及び説明をしっかりご確認ください。

In [2]:
# 出力結果の最初の要素は、
# choicesの3つ目の配列の最初の要素の20に
# 出力結果の2つ目の要素は、
# choicesの4つ目の配列の2つ目の要素31に
# 出力結果の3つ目の要素は、
# choicesの2つ目の配列の3つ目の要素12に
# 出力結果の4つ目の要素は、
# choicesの最初の配列の4つ目の要素3になる
np.choose(a, choices)
Out[2]:
array([20, 31, 12,  3])

numpy.choose()はデフォルト(mode=’raise’)の場合、以下のようにリスト内包表記で要素を取り出す操作と出力結果は同じです。

In [3]:
# 以下のコードと同じ
np.array([choices[a[i]][i] for i in np.ndindex(a.shape)])
Out[3]:
array([20, 31, 12,  3])

しかし、mode を ‘clip’ または ‘wrap’にすると処理が変わります。

In [4]:
# modeを'clip'にすると、
# 範囲外のインダイス 4 を 3 に変換
np.choose([2, 4, 1, 0], choices, mode='clip')
Out[4]:
array([20, 31, 12,  3])
In [5]:
# modeを'wrap'にすると、
# 範囲外のインダイス 4 を [4 mod 配列数] に変換
# mod は剰余演算(余りを求める演算のこと)
# この場合は 4 mod 4 = 0となる。
np.choose([2, 4, 1, 0], choices, mode='wrap')
Out[5]:
array([20,  1, 12,  3])

このように numpy.choose() は、choices の要素の中から、インダイス配列a の指定にしたがって順々に要素を取得して新しい配列を作成します。

以下はブロードキャストを使った場合のサンプルコードです。ブロードキャストについては『覚えておくべきNumPy配列のブロードキャストのルール』で詳しく解説していますので是非ご確認ください。

In [1]:
import numpy as np
a = np.array([[1, 0, 1], [0, 1, 0], [1, 0, 1]])
a
Out[1]:
array([[1, 0, 1],
       [0, 1, 0],
       [1, 0, 1]])
In [2]:
choices = np.array([-10, 10])
choices
Out[2]:
array([-10,  10])
In [3]:
# 1の場所に10を、0の場所に-10を取得
np.choose(a, choices)
Out[3]:
array([[ 10, -10,  10],
       [-10,  10, -10],
       [ 10, -10,  10]])

もう1つ高度な例を見てみましょう。どのように処理が行われているかを理解するには、『NumPyの配列のスライスの必須テクニックまとめ』の理解が役立ちます。ぜひ確認しておいてください。

In [1]:
import numpy as np
a = np.array([0, 1]).reshape((2,1,1))
a
Out[1]:
array([[[0]],

       [[1]]])
In [2]:
c1 = np.array([1, 2, 3]).reshape((1,3,1))
c1
Out[2]:
array([[[1],
        [2],
        [3]]])
In [3]:
c2 = np.array([-1, -2, -3, -4, -5]).reshape((1,1,5))
c2
Out[3]:
array([[[-1, -2, -3, -4, -5]]])
In [4]:
# 出力結果は2x3x5
# res[0,:,:] を c1に
# res[1,:,:] を c2 に
np.choose(a, (c1, c2))
Out[4]:
array([[[ 1,  1,  1,  1,  1],
        [ 2,  2,  2,  2,  2],
        [ 3,  3,  3,  3,  3]],

       [[-1, -2, -3, -4, -5],
        [-1, -2, -3, -4, -5],
        [-1, -2, -3, -4, -5]]])

3. まとめ

以上がnumpy.choose()の使い方です。



よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

コメント

コメントする

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください

目次
閉じる