OpenCV と OpenCV Contrib 最新版のインストール，CUDA 対応可能（ソースコードを使用）（Windows 上）

OpenCV (Open Computer Vision Library) は，実時間コンピュータビジョン (real time computer vision) のアルゴリズムと文書とサンプルコードの集まり．

OpenCV のインストールは，複数の方法がある．

vcpkg を使う．その詳細は: 別ページで説明している．
公開されているパッケージを使う．その詳細は: 別ページで説明している．
最新版を検証，開発者に貢献したいなどの場合には，ソースコードからビルドして，インストールする．その詳細は: 別ページで説明している．

ユースケース．OpenCVはWindows でも簡単にインストールできるが，OpenCV conrtib を存分に使いたい，自分の環境にあわせてビルドしたい（NVidia CUDA を使うなど）場合は，ソースコードからビルドする．

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

OpenCV について [PDF] , [パワーポイント]
OpenCV の機能とプログラム例は，別ページにまとめている．

参考 Web ページ: https://jamesbowley.co.uk/accelerating-opencv-4-build-with-cuda-intel-mkl-tbb-and-python-bindings/

謝辞：OpenCV および関連ソフトウエア類の作者に感謝します

前準備

Python のインストール，pip と setuptools の更新（Windows 上）

Windows での Python のインストール，pip と setuptools の更新: 別ページで説明している．（あとのトラブルが起きにくいような手順を定めている）

Python の URL: http://www.python.org/

【Windows での Python, pip の使い方】

Python, pip は，次のコマンドで起動できる．

Windows: python, python -m pip (または py -3.9, py -3.9 -m pip のようにバージョン指定）

【Python 開発環境のインストール】

Python を使うときは，Python開発環境や Python コンソール（Jupyter Qt Console，spyder，PyCharm，PyScripter など）の利用も便利である

Windows, Ubuntu での Python 開発環境，Python コンソール（Jupyter Qt Console, Jupyter ノートブック (Jupyter Notebook), Jupyter Lab, Nteract, spyder）のインストール: 別ページで，インストール手順を説明している．

numpy のインストール

Windows では，コマンドプロンプトを 管理者として実行実行．
numpy のインストール
```
python -m pip install -U numpy
```

Git, cmake のインストール

Windows での Git, cmake のインストール手順: 別ページで説明している．

Ubuntu での Git, cmake のインストール手順:

sudo apt -y update
sudo apt -y install git cmake cmake-curses-gui cmake-gui

git の URL: https://git-scm.com/
cmake のダウンロード URL: https://cmake.org/download/

マイクロソフト C++ ビルドツール (Build Tools) のインストール

Windows でのマイクロソフト C++ ビルドツール (Build Tools) のインストール手順: 別ページで説明している．

（NVIDIA GPU を使うとき）NVIDIA グラフィックスドライバ，NVIDIA CUDA ツールキット 11.4 のインストール

GPU は，グラフィックス・プロセッシング・ユニットの略で、コンピュータグラフィックス関連の機能，乗算や加算の並列処理の機能などがある．

NVIDIA CUDA は，NVIDIA社が提供している GPU 用のプラットフォームである．

関連 Web ページ

NVIDIA グラフィックスドライバのダウンロード用ページ: https://www.nvidia.co.jp/Download/index.aspx?lang=jp
NVIDIA CUDA ツールキットの URL: https://developer.nvidia.com/cuda-toolkit-archive

インストール手順の説明

Windows での NVIDIA グラフィックスドライバ，NVIDIA CUDA ツールキット 11.5，NVIDIA cuDNN 8.3 のインストール: 別ページで説明している．

（NVIDIA GPU を使うとき）NVIDIA cuDNN のインストール

ダウンロードページ

NVIDIA cuDNN のダウンロード用ページ: https://developer.nvidia.com/cudnn から cuDNN を入手
ダウンロードして展開（解凍）したら，パスを通しておくこと．

NVIDIA cuDNN のバージョン：

TensorFlow 2.7 の GPU 版での，cuDNN のバージョンは 8.3 系列（2021/11 時点で，NVIDIA CUDA ツールキット 11.5 で動く最新版）．
TensorFlow 2.6, TensorFlow 2.5 の GPU 版での，cuDNN のバージョンは 8.2 系列
TensorFlow 2.4 の GPU 版での，cuDNN のバージョンは 8.0.5が良さそうである．
TensorFlow 2.3, 2.2, 2.1, 2.0, 1.15, 1.14, 1.13 の GPU 版での，cuDNN のバージョンは 7 系列 （まずは，7.6.5を使い，7.6.5でうまく動かない場合には 7.4.2 を試す）．8 系列では動かない．
それより高いバージョンよりは使わないこと．

その根拠は次のページ． URL: https://www.tensorflow.org/install/source#common_installation_problems

詳細説明

Windows での NVIDIA cuDNN のインストール: 別ページで説明している．

OpenCV のインストール（ソースコードを使用）

OpenCV を C:\opencv, C:\opencv_contrib にインストールする

Windows で，コマンドプロンプトを管理者として実行する．

Windows のコマンドプロンプトを管理者として実行するには， 検索窓で「cmd」と入れたあと，右クリックメニューで「管理者として実行」を選ぶのが簡単．

ディレクトリを削除する

cd c:\
rmdir /s /q opencv
rmdir /s /q opencv_contrib

OpenCV のバージョンの確認
次のページなどで，最新バージョンのバージョン番号を確認できる．
https://github.com/opencv/opencv

OpenCV のソースコードをダウンロード

cd c:\
git clone --recursive https://github.com/opencv/opencv.git

OpenCV contrib のソースコードをダウンロード

OpenCV contrib が不要の場合は，この手順は不要である
```
cd c:\
rmdir /s /q opencv_contrib
git clone --recursive https://github.com/opencv/opencv_contrib.git
```
Python 3 のバージョンを調べる
バージョン 3.9 系列なのか、3.8 系列なのか、3.7 系列なのか、3.6 系列なのか、調べる．この情報はあとで使う．
下の実行例では、Python のバージョンは 3.8 系列（3.8.3） である
```
python --version
```
Python 3 の場所を調べる
複数表示されたときは，表示の一番上を使う．この結果は，あとの設定で使う．
```
where python
```
pylint, flake8 のインストール
```
python -m pip install pylint flake8
```
cmake の実行
cmake でのオプションについて
- 「cmake -G "Visual Studio 16 2019"」
  下の手順は「cmake -G "Visual Studio 16 2019"」とある通り、 Visual Studio 2019 のマイクロソフト C++ ビルドツール (Build Tools) を使う場合の手順である．
- パスの区切りは「\」でなくて「/」
  「c:\」ではなくて「c:/」のようにしている．「\」は使わずに「/」を使う．これは、opencv_contrib の modules 下の cmake のエラーを回避するため．
- Python 3 の設定
  次の設定では，実際に存在するファイル名を設定する必要がある．必要に応じて，実際の自分のパソコンのファイルを検索すること．
  - -DPYTHON_DEFAULT_EXECUTABLE=C:/Program Files/Python38/python.exe
  - -DPYTHON3_EXECUTABLE=C:/Program Files/Python38/python.exe
  - -DPYTHON3_INCLUDE_DIR=C:/Program Files/Python38/include
  - -DPYTHON3_LIBRARY=C:/Program Files/Python38/libs/python38.lib
  - -DPYTHON3_NUMPY_INCLUDE_DIRS=C:/Program Files/Python38/lib/site-packages/numpy/core/include
  ※ 先ほど調べた Python 3 のバージョンが、Python 3.8 系列のときは「python38.lib」となり、 Python 3.7 系列のときは「python37.lib」のようにとなる．
cmake の実行手順例は次の通り
```
cd c:\
cd opencv
rmdir /s /q build
mkdir build
cd build
del CMakeCache.txt
cmake -G "Visual Studio 16 2019" -A x64 -T host=x64 ^
-DCMAKE_BUILD_TYPE=RELEASE ^
-DWITH_CUDA=ON ^
-DOPENCV_EXTRA_MODULES_PATH=c:/opencv_contrib/modules ^
-DINSTALL_TESTS=ON ^
-DINSTALL_C_EXAMPLES=ON ^
-DWITH_PYTHON=ON ^
-DINSTALL_PYTHON_EXAMPLES=ON ^
-DBUILD_opencv_python2=OFF ^
-DPYTHON_DEFAULT_EXECUTABLE="C:/Program Files/Python38/python.exe" ^
-DBUILD_opencv_python3=ON ^
-DPYTHON3_EXECUTABLE="C:/Program Files/Python38/python.exe" ^
-DPYTHON3_INCLUDE_DIR="C:/Program Files/Python38/include" ^
-DPYTHON3_LIBRARY="C:/Program Files/Python38/libs/python38.lib" ^
-DPYTHON3_NUMPY_INCLUDE_DIRS="C:/Program Files/Python38/lib/site-packages/numpy/core/include" ^
-DBUILD_EXAMPLES=ON ^
-DWITH_OPENGL=ON ^
-DOPENCV_ENABLE_NONFREE=OFF ^
..
```
cmake でのオプションの調整
- NVIDIA CUDA ツールキット, NVIDIA cuDNN の設定例
  3546例えば，上に書いた cmake でのオプションに、次を付け加えるなどが考えられる．
```
-DWITH_CUDA=ON ^
-DCUDA_FAST_MATH=ON ^
-DWITH_CUBLAS=ON ^
-DWITH_CUDNN=ON ^
-DWITH_NVCUVID=ON ^
-DOPENCV_DNN_CUDA=ON ^
```
- Intel MKL を使いたいとき
  ※ Intel MKL は，「w_mkl_2019.4.245.exe」を用いてインストール済み，そして，「C:\Program Files (x86)\IntelSWTools\compilers_and_libraries_2019\windows\redist\intel64_win\tbb\vc_mt」にパスが通っているとする．
  上に書いた cmake でのオプションに、次を付け加える
```
-DWITH_MKL=ON ^
-DMKL_USE_MULTITHREAD=ON ^
-DWITH_TBB=ON ^
-DMKL_WITH_TBB=ON ^
```
- VTK を使いたいとき
  上に書いた cmake でのオプションに、次を付け加える．
  ※ Windows での VTK のインストール手順は、「Windows で VTK 最新版をソースコードからビルドして、インストールする（マイクロソフト C++ ビルドツール (Build Tools) を使用）」で説明している．
```
-DWITH_VTK=ON ^
-DVTK_DIR="C:/tools/VTK" ^
```
- OpenNI2 を使いたいとき
  上に書いた cmake でのオプションに、次を付け加える．
  ※ Windows でのインストール手順は、「Windows で libPCL 1.9.0, Boost, Eigen, OpenNI 2.2, NITE2 のインストール」で説明している．
```
-DWITH_OPENNI2=ON ^
-DOPENNI2_INCLUDE="C:/Program Files/OpenNI2/include" ^
-DOPENNI2_LIB="C:/Program Files/OpenNI2/lib" ^
-DOPENNI2_REDIST="C:/Program Files/OpenNI2/Redist" ^
```
- OpenBLAS を使いたいとき
  上に書いた cmake でのオプションに、次を付け加える．
  ※ Windows での OpenBLAS のインストールは「OpenBLAS をソースコードからビルドして、インストール（clang, flang を使用）（Windows 上）」で説明している．
```
-DOpenBLAS_LIB="C:/tools/OpenBLAS/lib/openblas.lib" ^
-DOpenBLAS_INCLUDE_DIR="C:/tools/OpenBLAS/include/openblas" ^
-DWITH_LAPACK=ON ^
-DLAPACK_LIBRARIES="C:/tools/lapack-release/lib/lapack.lib" ^
-DLAPACK_INCLUDE_DIR="C:/tools/lapack-release/CBLAS/include" ^
-DLAPACK_CBLAS_H="C:/tools/lapack-release/CBLAS/include/cblas.h" ^
```
cmake の実行結果の確認
Python 3 のところが自動設定される（Python 3 を使わない場合は，その設定は無視）
※ 下図のとおりになるとは限らない．

※ 最後のコマンドの実行の結果，エラーメッセージが出た場合には，自動設定がうまくいっていない．設定を変えてやり直す．
ソースコードからビルドし、インストールする
```
cmake --build . --config RELEASE --target INSTALL
```
結果の確認
エラーが無ければ，インストールが終わっている．エラーメッセージが出ていないことを確認．そして，インストールが終わっていることも確認．
※ 黄色の警告メッセージは無視しても良い
Windows のシステム環境変数 Path に次の値を追加し，パスを通す．

Windows での環境変数の設定は，マイコンピュータを右クリック → プロパティ→ 詳細設定 → 環境変数をクリック
Windowsの画面の表示では、「\」（円マーク）が表示される
- システム環境変数 Path
- 追加する値: c:\opencv\build\bin\release
Python 関係のファイルもインストールされていることを確認
「Python38」のところは，実際の Python インストールディレクトリに読み替えて実行すること．
```
dir "C:\Program Files\Python38\lib\site-packages\cv2"
```
※ Python 関係のファイルがインストールされていない場合でも，Python ローダ (python loader) を使用することは推奨しない．（Python ローダの利用を使用すると，エラーが出たときに，Python のインストールからやり直す可能性がある．Python ローダをよく知らずに実行するのは避けること）

Python でOpenCV のバージョン確認

python -c "import cv2; print( cv2.__version__ )"

本サイトは金子邦彦研究室のWebページである．

資料等の公開では，原則，「クリエイティブコモンズ BY NC SA」として公開するようにしている． PDFファイル，パワーポイントファイルなどには，「クリエイティブコモンズ BY NC SA」を明記するとともに，ロゴを記載するようにしている（作業が間に合っていない分もあるのでご容赦ください）．

公開している資料をご利用になる場合の，再配布の条件，剽窃の防止などについて，別ページで説明している．再配布や資料改変の際には，そのページをご確認ください．

サイトマップは，サイトマップのページをご覧下さい．本サイト内の検索は，サイト内検索のページをご利用下さい．

問い合わせ先：金子邦彦（かねこくにひこ）