API · Pandas
Pandas cut 関数
このチュートリアルでは、pandas.cut() 関数を使って、データをビンとも呼ばれる範囲に分割する方法を説明します。
このページの内容
pandas.cut() 関数は数値を範囲(ビン)に割り当てます。入力値ごとに区間カテゴリを返すため、年齢やスコアなどの連続した測定値を分析用のグループにまとめるのに便利です。境界値を明示することも、pandas に範囲を指定した数のビンへ分割させることもできます。
構文、パラメータ、戻り値
関数は pandas.cut(x, bins, right=True, labels=None, retbins=False, precision=3, include_lowest=False, duplicates="raise", ordered=True) のように呼び出します。
よく使う引数は次のとおりです。
| パラメータ | 説明 |
|---|---|
x |
割り当てる数値の配列状データ。リスト、Series、DataFrame の列などを指定します。 |
bins |
等幅ビンの数を表す整数、境界値を明示するシーケンス、または IntervalIndex を指定します。整数を指定すると、pandas は x の最小値と最大値から範囲を求め、それを指定数の等幅ビンに分割します。また、両端の値が含まれるよう、範囲を両側に 0.1% 拡張します。シーケンスを指定した場合は境界値を直接使い、この整数ビン用の範囲調整は行いません。 |
right |
True(既定値)の場合、区間に右端の値を含めます。False にすると左閉区間になります。 |
labels |
ビンごとに指定する任意のラベルです。False を指定すると、整数のビン位置を返します。 |
retbins |
True の場合、ビンの作成に使った境界値も返します。 |
precision |
境界値の保存と表示に使う精度です。 |
include_lowest |
True の場合、最初の区間に最小の境界値を含めます。 |
duplicates |
境界値に重複がある場合の動作として、既定の "raise" または "drop" を選びます。 |
ordered |
返されるカテゴリを順序付きにするかどうかを指定します。既定値は True です。 |
通常、結果には x の各要素に対応するカテゴリ値が1つずつ含まれます。どの区間にも入らない値は NaN になります。retbins=True の場合、関数は値ごとの結果と境界値の配列を組にして返します。
DataFrame の値をビンに割り当てる
DataFrame の列を x に渡し、区間の境界値を bins で指定して、返された Series を新しい列に代入します。次の例を実行します。
このセクションのコードと表示されるラベルや出力は英語のままです。
import pandas as pd
df = pd.DataFrame(
{
"Name": ["Anish", "Birat", "Chirag", "Kabin", "Sachin"],
"Age": [23, 34, 38, 45, 27],
"Score": [316, 322, 332, 330, 325],
}
)
df["Age-Range"] = pd.cut(df["Age"], bins=[20, 30, 40, 50])
print(df[["Age", "Age-Range"]].to_string(index=False))
境界値が4つあるため、ビンは3つになります。各行の位置はそのまま保たれ、Age-Range の値から、その行の年齢がどの区間に入るかが分かります。たとえば、既定の区間規則では年齢23は (20, 30] に、年齢45は (40, 50] に割り当てられます。
区間の境界を調整する
既定では right=True のため、右閉区間になります。表記 (20, 30] は、20より大きく30以下の値を意味します。つまり、20は含まず、30は含みます。include_lowest=True を指定すると、最初の区間に最小の境界値も含まれます。right=False にすると、[20, 30) のような左閉右開区間になり、20を含み30を含みません。この設定では、最大の境界値は最後の区間に入りません。どの区間にも該当しない値は NaN になります。
次の例では、指定した境界値上または境界値の間にある年齢について、これらのオプションによる違いを比較します。
このセクションのコードと表示されるラベルや出力は英語のままです。
import pandas as pd
ages = pd.Series([20, 23, 30, 45, 50], name="Age")
result = pd.DataFrame(
{
"Age": ages,
"default": pd.cut(ages, bins=[20, 30, 40, 50]),
"include_lowest": pd.cut(
ages, bins=[20, 30, 40, 50], include_lowest=True
),
"left_closed": pd.cut(
ages, bins=[20, 30, 40, 50], right=False
),
}
)
print(result.to_string(index=False))
20と50の行を比べると、端点の指定が区間への割り当てにどう影響するか分かります。既定では50は最後の区間に含まれますが、20は最初の区間に含まれません。include_lowest=True を指定すると20も最初の区間に入り、right=False の場合は20が含まれる一方で50は最後の区間から外れます。
ビンにラベルを割り当てる
区間表記の代わりに分かりやすいカテゴリ名を表示するには、各ビンのラベルを渡します。ラベルは区間の順に対応するため、ビンが3つならラベルも3つ必要です。
このセクションのコードと表示されるラベルや出力は英語のままです。
import pandas as pd
ages = pd.Series([23, 34, 38, 45, 27], name="Age")
labels = ["21 to 30", "31 to 40", "41 to 50"]
age_groups = pd.cut(
ages,
bins=[20, 30, 40, 50],
labels=labels,
)
print(age_groups.to_string(index=False))
既定の設定では、最初のラベルは (20, 30]、2番目は (30, 40]、3番目は (40, 50] に対応します。名前ではなく数値のグループ位置が必要な場合は labels=False を渡します。すると pandas は、ビンに割り当てられた値に対して整数のビンコードを返します。
retbins=True でビンの境界値を取得する
値ごとのカテゴリと、その作成に使った境界値の両方が必要な場合は retbins=True を指定します。返される1つ目の項目は x の各値に対応する結果で、2つ目は共通のビン境界値の配列です。次の例では、両方を別々の変数に取り出します。
このセクションのコードと表示されるラベルや出力は英語のままです。
import pandas as pd
ages = pd.Series([23, 34, 38, 45, 27], name="Age")
age_groups, bin_edges = pd.cut(
ages,
bins=[20, 30, 40, 50],
labels=["21 to 30", "31 to 40", "41 to 50"],
retbins=True,
)
print("Groups:")
print(age_groups.to_string(index=False))
print("Bin edges:")
print(bin_edges)
age_groups には年齢ごとのラベル付き結果が1つずつ入り、bin_edges には [20, 30, 40, 50] が入ります。bins に整数を指定して pandas に等幅の境界値を計算させる場合にも、同じ方法が使えます。境界値を確認または再利用する必要があれば、返された値を保持してください。