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

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

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

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

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

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

【OpenCV の公式情報】

Python 3.12 のインストール

Pythonのインストールを行い、Pythonのプログラムを実行する環境を整える。扱う環境は、Windows搭載パソコンである。金子研究室では、Python 3.12.10を推奨する。

[Windows での Python 3.12 のインストール手順を見るには、ここをクリック]

Windows での Python 3.12 のインストール

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

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

インストールコマンドの実行方法

管理者権限コマンドプロンプトを起動する(手順:Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」)。そして、コマンド全体をコマンドプロンプトにコピー&ペーストする。

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

REM Python 3.12 をシステム領域にインストール
winget install --id Python.Python.3.12 -e --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_test=0 Include_pip=1 Include_launcher=1 InstallLauncherAllUsers=1 TargetDir=\"C:\Program Files\Python312\""

REM Python と Scripts を PATH 先頭に追加
powershell -NoProfile -Command "$p='C:\Program Files\Python312'; $s=\"$p\Scripts\"; $c=[Environment]::GetEnvironmentVariable('Path','Machine'); if((Test-Path $p) -and (';'+$c+';' -notlike \"*;$p;*\") -and (';'+$c+';' -notlike \"*;$s;*\")){[Environment]::SetEnvironmentVariable('Path',\"$p;$s;$c\",'Machine')}"

方法 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' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

Python の開発環境 Visual Studio Code のインストールと Python 用の設定

Python の開発環境Visual Studio Code(プログラムを編集するソフトウェア。以下、VS Code)を整える。

[Windows での Visual Studio Code のインストールと Python 用の設定手順を見るには、ここをクリック]

Windows での Visual Studio Code のインストールと Python 用の設定手順

1. VS Code と拡張機能のインストール

以下のコマンドにより,既存の VS Code を削除し,全ユーザー共有の設定で再インストールしたうえで,拡張機能(VS Code に機能を追加するソフトウェア)をまとめて導入する.

インストールコマンドの実行方法

管理者権限コマンドプロンプトを起動する(手順:Windows キーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」)。そして,コマンド全体をコマンドプロンプトにコピー&ペーストする。

インストールコマンド


REM ============================================================
REM Microsoft Visual Studio Code
REM ============================================================
winget uninstall -e --id Microsoft.VisualStudioCode --silent --disable-interactivity --accept-source-agreements
rmdir /s /q C:\ProgramData\vscode-extensions 2>nul
rmdir /s /q "%APPDATA%\Code" 2>nul
rmdir /s /q "%USERPROFILE%\.vscode" 2>nul
rmdir /s /q "%LOCALAPPDATA%\Microsoft\vscode-update" 2>nul

REM VS Code をシステム領域に新規インストール
winget install --scope machine --id Microsoft.VisualStudioCode -e --silent --accept-source-agreements --accept-package-agreements

REM 全ユーザー共有の拡張機能フォルダ
mkdir C:\ProgramData\vscode-extensions 2>nul
icacls "C:\ProgramData\vscode-extensions" /grant "Everyone:(OI)(CI)M" /T

REM スタートメニューのショートカットを --extensions-dir 付きで再作成
rmdir /s /q "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code" 2>nul
del "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk" 2>nul
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); $lnk.TargetPath='C:\Program Files\Microsoft VS Code\Code.exe'; $lnk.Arguments='--extensions-dir \"C:\ProgramData\vscode-extensions\"'; $lnk.Save()"
REM ショートカットの検証
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); Write-Host 'TargetPath:' $lnk.TargetPath; Write-Host 'Arguments:' $lnk.Arguments"

REM ファイル / フォルダ右クリックの「Code で開く」を登録
reg add "HKLM\SOFTWARE\Classes\*\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\Background\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%V\"" /f

REM --extensions-dir 付きで起動する code.cmd ラッパを作成
REM (%* を echo で書くと対話的 cmd で失われるため、PowerShell で [char]37+'*' を書き出す)
powershell -NoProfile -Command "$pct=[char]37; $q=[char]34; $c='@echo off'+[char]13+[char]10+$q+'C:\Program Files\Microsoft VS Code\bin\code.cmd'+$q+' --extensions-dir '+$q+'C:\ProgramData\vscode-extensions'+$q+' '+$pct+'*'+[char]13+[char]10; [IO.File]::WriteAllText('C:\ProgramData\vscode-extensions\vscode.cmd',$c,[Text.Encoding]::ASCII)"

REM 拡張機能のインストール
set "CODE=C:\Program Files\Microsoft VS Code\bin\code.cmd"
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot-chat
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.python
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.vscode-pylance
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.debugpy
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension MS-CEINTL.vscode-language-pack-ja
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension saoudrizwan.claude-dev
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension rust-lang.rust-analyzer
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension tamasfe.even-better-toml
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension anthropic.claude-code
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension almenon.arepl
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --list-extensions --show-versions
echo === セットアップ完了 ===

2. Python インタプリタの選択

同一マシンに複数の Python がインストールされている場合,VS Code で使用する Python 本体(インタプリタ:Python プログラムを解釈・実行するソフトウェア)を選択する必要がある.

  1. コマンドパレット(コマンド名で機能を呼び出す VS Code の入力欄)を開く(Ctrl+Shift+P
  2. Python: Select Interpreter と入力する
  3. 表示される一覧から,使用する Python(例:C:\Program Files\Python312\python.exe)を選択する.

Python プログラム実行手順

[Windows での Python プログラム実行手順を見るには、ここをクリック]

Windows での Python 実行手順(Visual Studio Codeを使用)

プログラムファイルの作成と保存

  1. 左サイドバーの「エクスプローラー」アイコン(Ctrl+Shift+E)をクリックする
  2. 「NO FOLDER OPENED」(作業対象フォルダが未選択の状態)と表示される場合は,「Open Folder」をクリックし,プログラムを保存するフォルダを選択する

    続いて「フォルダを信用するか」を確認する画面(フォルダ内のコードを実行してよいか確認する VS Code の仕組み)が表示されるので,チェックして Yes を選択する

  3. フォルダ名の右側に表示される「新しいファイル」アイコンをクリックする
  4. ファイル名(例:aitask.py.ファイル名は何でも良い)を入力し Enter を押す.拡張子は .py(Python ファイルを示す拡張子)とする
  5. 実行したいコードを選択し,Ctrl+C でコピーする.VS Code のエディタ領域に Ctrl+V で貼り付ける
  6. Ctrl+S で保存する

プログラムの実行

  1. エディタ右上の三角形「▷」アイコン(Run Python File:現在開いている Python ファイルを実行するボタン)をクリックする.または,エディタ上で右クリックし「ターミナルで Python ファイルを実行」を選択する
  2. VS Code 下部のターミナル(コマンドの入出力を表示する画面)に,実行結果(print 関数の出力等)が表示される
  3. tkinter(Python 標準の GUI ライブラリ)のファイル選択ダイアログを使うプログラムを実行した場合は,ダイアログが開くので対象画像を選択する
  4. VS Code 下部のターミナルで実行結果を確認する.OpenCV ウィンドウ(OpenCV が画像を表示するために開く専用ウィンドウ)が開いた場合はそちらも確認する.OpenCV ウィンドウは,マウスクリックでウィンドウをアクティブ(操作対象の状態)にしてからキーを押すと終了する

必要なライブラリのインストール

管理者権限コマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、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章のソースコードをテキストエディタ(Visual Studio Codeやメモ帳など)に貼り付け,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 によりウィンドウを閉じてプログラムを終了する.