Visual Studio Codeでmatplotlibのコールバック関数が機能しない

Question

前提・実現したいこと

Pythonのmatplotlibの図の中でオブジェクトがクリックされたかどうか確認したいです。

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

以下のコードのように、matplotlibのfigureの.canvas.mpl_connect()関数にクリックイベントを紐づけたのですが、意図して動作をせず、図内のオブジェクトをクリックしても紐づけた関数が実行されません。

該当のソースコード

import matplotlib.pyplot as plt
import numpy as np

def click(event):
    print('clicked object')

x = np.random.randn(100)
y = np.random.randn(100)

fig = plt.figure()
fig.canvas.mpl_connect('pick_event', click)
plt.xlabel("x")
plt.ylabel("y")
plt.scatter(x, y)
plt.show()

補足情報（FW/ツールのバージョンなど）

環境は
Visual Studio Code 1.60.0
Python 3.6.8

Answer 1

pick_eventは、対象となるオブジェクトのpickerプロパティがNoneの場合には発生しません。

Pick Event Demo — Matplotlib 3.4.3 documentation

pickerプロパティの初期値はNoneなので、利用者がTrueに変更してください。例えば、Scatterを生成するときに、オプション引数で指定します。

-plt.scatter(x, y)
+plt.scatter(x, y, picker=True, pickradius=2.5)

pickradiusを指定すると、各ポイントを中心とする、pick_eventを発生させる円の半径を変更できます。
設定しなくてもそれなりの大きさになっていますが、ちょっと広めだったので、ここではScatterの円マーカーの大きさ(面積)の初期値20に対応する、おおよその半径2.5を設定しています。

あとは、紐付けた関数clickの内部で、

def click(event):
    if isinstance(event.artist, PathCollection):
        print(f"clicked {len(event.ind)} point{'s' if len(event.ind) > 1 else ''}")
        for i in event.ind:
            print(f"    point[{i:3d}]: ({x[i]:10.7f}, {y[i]:10.7f})")
    else:
        print('clicked object')

のように、eventオブジェクトを使って、クリックした点の情報(インデックスや座標など)を得ることができます。なお、マーカーが重なっているような場合は、複数の点のインデックスが得られます。

Comments

[yamatan]

ありがとうございます、やりたいことができました。

教えて頂いた後に調べてみると、matplotlibの公式ドキュメント (https://matplotlib.org/stable/gallery/event_handling/pick_event_demo.html) にも書いてあるようで、私のリサーチ不足でした。

コードの参考例をありがとうございます。pickされたポイントが複数ある場合は、クリックした座標に一番近い点を表示することで対応できそうです。
参考になりました。

改めてありがとうございます。