Foliumでオリジナルカラーマップのコロプレス図を描きたい

Question

前提・実現したいこと

PythonのFoliumライブラリを使用して、GeoJSONファイルと紐づけたいデータ（pandas DataFrame形式）をもとに、オリジナルのカラーマップでコロプレス図を描きたいと思っています。

下記のサイトを参考にスクリプトを作成しましたが、エラーが発生しました。
https://medium.com/analytics-vidhya/create-and-visualize-choropleth-map-with-folium-269d3fd12fa0

pandas DataFrameで、indexはgeoJSONファイルのfeatures.properties.idに対応したコード番号、列データとしてカラーマップで表現したい値を格納しました。

使用したGeoJSONファイル（japan.geojson（https://github.com/dataofjapan/land））の冒頭部分を以下に示します。

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "properties": {
                "nam": "Kyoto Fu",
                "nam_ja": "京都府",
                "id": 26
            },
            "geometry": {
                "type": "MultiPolygon",
                "coordinates": [
                    [
                        [
                            [
                                135.036697387695,
                                35.537334442138686
                            ],

発生している問題・エラーメッセージ

以下のよなエラーが発生し、コロプレス図が作成されません。

Traceback (most recent call last):
  File "C:\Users(ユーザー名)\AppData\Local\Programs\Python\Python39\lib\site-packages\pandas\core\indexes\base.py", line 2898, in get_loc
    return self._engine.get_loc(casted_key)
  File "pandas\_libs\index.pyx", line 70, in pandas._libs.index.IndexEngine.get_loc
  File "pandas\_libs\index.pyx", line 101, in pandas._libs.index.IndexEngine.get_loc
  File "pandas\_libs\hashtable_class_helper.pxi", line 1675, in pandas._libs.hashtable.PyObjectHashTable.get_item
  File "pandas\_libs\hashtable_class_helper.pxi", line 1683, in pandas._libs.hashtable.PyObjectHashTable.get_item
KeyError: 26

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "C:\Users(ユーザー名)\python_proj\quake_map_japan\folium_choropleth\for_teratail.py", line 39, in <module>
    folium.GeoJson(
  File "C:\Users(ユーザー名)\AppData\Local\Programs\Python\Python39\lib\site-packages\folium\features.py", line 458, in __init__
    self._validate_function(style_function, 'style_function')
  File "C:\Users(ユーザー名)\AppData\Local\Programs\Python\Python39\lib\site-packages\folium\features.py", line 523, in _validate_function
    if not callable(func) or not isinstance(func(test_feature), dict):
  File "C:\Users(ユーザー名)\python_proj\map\folium_choropleth\test.py", line 42, in <lambda>
    'fillColor': step(df[feature['properties']['id']]),
  File "C:\Users(ユーザー名)\AppData\Local\Programs\Python\Python39\lib\site-packages\pandas\core\frame.py", line 2906, in __getitem__
    indexer = self.columns.get_loc(key)
  File "C:\Users(ユーザー名)\AppData\Local\Programs\Python\Python39\lib\site-packages\pandas\core\indexes\base.py", line 2900, in get_loc
    raise KeyError(key) from err
KeyError: 26

該当のソースコード

import folium
import json
import pandas as pd
import branca.colormap as cmp

# DataFrame作成
data = {
    'value' : [1, 2, 3, 4, 5, 6, 7, 8]
}
idx = [22, 14, 19, 11, 12, 13, 20, 23]
df = pd.DataFrame(data, index=idx)

# 地図の設定
japan_location = [37, 137]
m = folium.Map(
    location=japan_location,
    tiles='https://cyberjapandata.gsi.go.jp/xyz/pale/{z}/{x}/{y}.png',
    attr='Geospatial Information Authority of Japan',
    zoom_start=5,
    width=670,
    height=690,
    zoom_control=False
)

# geojsonファイルを開く
geojson_file = 'japan.geojson'
with open(geojson_file, encoding="utf-8_sig") as f:
    japan_geojson =  json.load(f)

# カラーマップ作成
step = cmp.StepColormap(
 ['yellow', 'green', 'purple'],
 vmin=1, vmax=10,
 index=[3, 6, 8, 10],
 caption='Color Scale for Map'
)

# コロプレス図を作画
folium.GeoJson(
    japan_geojson,
    style_function=lambda feature: {
        'fillColor': step(df[feature['properties']['id']]),
        'color': 'black',
        'weight': 1,
        'dashArray': '5, 3'
    }
).add_to(m)
step.add_to(m)

# ファイル保存
m.save('test.html')

試したこと

indexに26がないのが問題かと思い、geoJSONファイルの冒頭のfeatureのproperties.idを22に書き換えましたが、同様のエラーが発生しました。

geoJSONファイルのidがstr型になっているのかもしれないと思い、

'fillColor': step(df[feature['properties']['id']]),

の部分を下記のように書き換えましたが、同様のエラーが発生しました。

'fillColor': step(df[int(feature['properties']['id'])]),

補足情報

Pythonのバージョン
3.9.0

ライブラリのバージョン
Folium: 0.11.0
pandas: 1.1.5

Answer 1

エラーの直接の原因は DataFrame の値を参照する文法が間違っていることです。

'fillColor': step(df[feature['properties']['id']]),

この箇所で feature['properties']['id'] には1から47のいずれかの値が入りますので、たとえばidが26であるfeatureのときは

df[26]

で DataFrame の値を参照しようとしますが、この文法は26という列名の列を取り出す操作ですので、ここではエラーになります。正しくは

df.loc[26, "value"]

もしくは

df.at[26, "value"]

でなければなりません。つまり元のソースコードを修正すると

'fillColor': step(df.at[feature['properties']['id'], 'value']),

となります。

ただしこの修正を行っても、GeoJSONファイルのidの値は1から47であるにも関わらず、それと紐づけたいデータであるはずの DataFrame には 22, 14, 19, 11, 12, 13, 20, 23 のid番号とそれに対応した値しか格納されていませんので、同じ箇所で同様のKeyErrorが発生しエラーになるのは変わりません。

DataFrame の作成部分をたとえば、

data = {
    'value' : [random.randint(1, 10) for i in range(47)]
}
idx = [i for i in range(1, 48)]
df = pd.DataFrame(data, index=idx)

と変更してみれば、エラーなく動くのが確認できるでしょう。この例の場合は冒頭に

import random

を追記するのも忘れないでください。

Comments

[mhtl]

ご助言のとおり修正したところ、エラーは発生せずファイルが作成されました。本当に助かりました。ありがとうございます。