OpenCV でマウスイベント(OpenCV,Python を使用)

1. エグゼクティブサマリー

OpenCV と Python を使用して画像ウィンドウ上のマウスイベントを処理するプログラムを扱う.cv2.setMouseCallback 関数によりコールバック関数を登録し,cv2.EVENT_LBUTTONDOWNcv2.EVENT_MOUSEMOVEcv2.EVENT_LBUTTONUPcv2.EVENT_RBUTTONDOWN の各イベントに応じた座標表示や図形描画を行う.

このプログラムでは,次のマウス操作が可能である.

サンプル画像として,OpenCV 公式リポジトリで公開されている home.jpg を使用する.

【サイト内の OpenCV 関連ページ】

【OpenCV の公式情報】

2. 前準備(必要ソフトウェアの入手)

ここでは、最低限の事前準備について説明する。機械学習や深層学習を行う場合は、NVIDIA CUDA、Visual Studio、Cursorなどを追加でインストールすると便利である。これらについては別ページ https://www.kkaneko.jp/cc/dev/aiassist.htmlで詳しく解説しているので、必要に応じて参照してください。

Python 3.12 のインストール(Windows 上) [クリックして展開]

以下のいずれかの方法で Python 3.12 をインストールする。Python がインストール済みの場合、この手順は不要である。

方法1:winget によるインストール

管理者権限コマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。

winget install --scope machine --id Python.Python.3.12 -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_pip=1 Include_test=0 Include_launcher=1 InstallLauncherAllUsers=1"

--scope machine を指定することで、システム全体(全ユーザー向け)にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動すると PATH が自動的に設定される。

方法2:インストーラーによるインストール

  1. Python 公式サイト(https://www.python.org/downloads/)にアクセスし、「Download Python 3.x.x」ボタンから Windows 用インストーラーをダウンロードする。
  2. ダウンロードしたインストーラーを実行する。
  3. 初期画面の下部に表示される「Add python.exe to PATH」に必ずチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから python コマンドを実行できない。
  4. 「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。

インストールの確認

コマンドプロンプトで以下を実行する。

python --version

バージョン番号(例:Python 3.12.x)が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

AIエディタ Windsurf のインストール(Windows 上) [クリックして展開]

Pythonプログラムの編集・実行には、AIエディタの利用を推奨する。ここでは、Windsurfのインストールを説明する。Windsurf がインストール済みの場合、この手順は不要である。

管理者権限コマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。

winget install --scope machine --id Codeium.Windsurf -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --custom "/SP- /SUPPRESSMSGBOXES /NORESTART /CLOSEAPPLICATIONS /DIR=""C:\Program Files\Windsurf"" /MERGETASKS=!runcode,addtopath,associatewithfiles,!desktopicon"
powershell -Command "$env:Path=[System.Environment]::GetEnvironmentVariable('Path','Machine')+';'+[System.Environment]::GetEnvironmentVariable('Path','User'); windsurf --install-extension MS-CEINTL.vscode-language-pack-ja --force; windsurf --install-extension ms-python.python --force; windsurf --install-extension Codeium.windsurfPyright --force"

--scope machine を指定することで、システム全体(全ユーザー向け)にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動すると PATH が自動的に設定される。

関連する外部ページ

Windsurf の公式ページ: https://windsurf.com/

必要なライブラリのインストール [クリックして展開]

管理者権限コマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。

pip install -U opencv-python numpy

3. 実行のための準備とその確認手順(Windows 前提)

3.1 画像ファイルの準備

https://github.com/opencv/opencv/tree/master/samples/data で公開されている home.jpg を使用する(謝辞:画像の作者に感謝します)

次のコマンドを実行する.

cd /d %LOCALAPPDATA%
curl -O https://raw.githubusercontent.com/opencv/opencv/master/samples/data/home.jpg

3.2 プログラムファイルの準備

第5章のソースコードをテキストエディタ(メモ帳,Windsurf 等)に貼り付け,main.py として保存する(文字コード:UTF-8).

3.3 実行コマンド

コマンドプロンプトでファイルの保存先ディレクトリに移動し,以下を実行する.

python main.py

3.4 動作確認チェックリスト

確認項目期待される結果
プログラム起動時home.jpg を読み込んだ画像ウィンドウ「bgr」が表示される
画像上で左ボタンをドラッグドラッグ範囲に緑色の矩形が描画され,コンソールに座標が表示される
画像上で右クリッククリック位置に赤色の円が描画され,コンソールに座標が表示される
q キーを押下画像ウィンドウが閉じ,プログラムが終了する

4. 概要・使い方・実行上の注意

このプログラムは,cv2.setMouseCallback で登録したコールバック関数により,画像ウィンドウ上のマウス操作を処理する.画像ファイル home.jpg を読み込み,ウィンドウ「bgr」に表示した状態で動作する.

左ボタンを押下すると cv2.EVENT_LBUTTONDOWN が発生し,開始座標を記録する.ドラッグ中は cv2.EVENT_MOUSEMOVE により矩形のプレビューが表示される.左ボタンを離すと cv2.EVENT_LBUTTONUP が発生し,矩形が画像上に確定される.右ボタンを押下すると cv2.EVENT_RBUTTONDOWN が発生し,クリック位置に半径20ピクセルの赤色の円が描画される.

ソースコードは第5章に掲載している.

5. ソースコード

import cv2
import numpy as np
import os

IMROOT = os.environ['LOCALAPPDATA'] + '/'

drawing = False
ix, iy = -1, -1

def mouse_event(event, x, y, flags, param):
    global drawing, ix, iy, bgr
    if event == cv2.EVENT_LBUTTONDOWN:
        drawing = True
        ix, iy = x, y
        print("cv2.EVENT_LBUTTONDOWN, %d, %d" % (x, y))
    elif event == cv2.EVENT_MOUSEMOVE:
        if drawing:
            img = bgr.copy()
            cv2.rectangle(img, (ix, iy), (x, y), (0, 255, 0), 2)
            cv2.imshow("bgr", img)
    elif event == cv2.EVENT_LBUTTONUP:
        drawing = False
        cv2.rectangle(bgr, (ix, iy), (x, y), (0, 255, 0), 2)
        print("cv2.EVENT_LBUTTONUP, %d, %d" % (x, y))
    elif event == cv2.EVENT_RBUTTONDOWN:
        cv2.circle(bgr, (x, y), 20, (0, 0, 255), 2)
        print("cv2.EVENT_RBUTTONDOWN, %d, %d" % (x, y))

bgr = cv2.imread(IMROOT + "home.jpg")
cv2.namedWindow("bgr")
cv2.setMouseCallback("bgr", mouse_event)

while True:
    cv2.imshow("bgr", bgr)
    if (cv2.waitKey(1) & 0xFF) == ord('q'):
        break

cv2.destroyAllWindows()

6. まとめ

マウスイベントのコールバック関数

cv2.setMouseCallback により,画像ウィンドウにコールバック関数を登録する.コールバック関数は,イベント種別,座標(x, y),フラグ,パラメータを引数として受け取る.

マウスイベントの種別

OpenCV では cv2.EVENT_LBUTTONDOWN(左ボタン押下),cv2.EVENT_LBUTTONUP(左ボタン解放),cv2.EVENT_MOUSEMOVE(マウス移動),cv2.EVENT_RBUTTONDOWN(右ボタン押下)などのイベント定数が定義されている.これらを条件分岐で判定し,イベントごとの処理を記述する.

画像上への図形描画

cv2.rectangle で矩形を,cv2.circle で円を画像上に描画する.描画色は BGR 形式のタプルで,線の太さはピクセル単位で指定する.

ドラッグ操作の実装

左ボタン押下時に開始座標を記録し,マウス移動中は bgr.copy() で複製した画像上にプレビュー矩形を表示する.左ボタン解放時に元画像上に矩形を確定させることで,ドラッグによる範囲指定を実現している.

画像ウィンドウの表示と終了処理

cv2.namedWindow でウィンドウを作成し,cv2.imshow でループ内で画像を更新表示する.cv2.waitKey(1) & 0xFF でキー入力を監視し,q キーの押下で cv2.destroyAllWindows によりウィンドウを閉じてプログラムを終了する.