DCMTK をプロジェクトに統合するためのベストプラクティス

CMake モジュール FindDCMTK の解説

FindDCMTK は、CMake モジュールの一つで、DCMTK ライブラリをプロジェクトに統合するために必要な情報を検索します。DCMTK は、医療画像処理のためのオープンソースツールキットであり、DICOM 標準をサポートしています。

FindDCMTK は、以下の2つのステップで DCMTK を検索します。

ステップ1: DCMTKConfig.cmake ファイルの存在を確認します。

• DCMTKConfig.cmake ファイルは、DCMTK のインストール時に作成されます。
• このファイルが存在する場合、FindDCMTK は以下の情報を設定します。
  • DCMTK_INCLUDE_DIRS: DCMTK ヘッダーファイルのディレクトリ
  • DCMTK_LIBRARIES: DCMTK ライブラリのファイル
  • DCMTK_FOUND: TRUE

ステップ2: ステップ1で DCMTKConfig.cmake ファイルが見つからなかった場合、FindDCMTK は以下の情報を設定します。

• DCMTK_FOUND: FALSE

FindDCMTK は、以下のコマンドを使用して呼び出すことができます。

find_package(DCMTK [NO_MODULE])

• NO_MODULE オプションを指定すると、FindDCMTK は DCMTKConfig.cmake ファイルのみを検索します。
• NO_MODULE オプションを指定しない場合、FindDCMTK は DCMTKConfig.cmake ファイルが見つからなかった場合、デフォルトの情報を設定します。

FindDCMTK の詳細については、以下のリソースを参照してください。

例

以下の例は、FindDCMTK を使用して DCMTK をプロジェクトに統合する方法を示します。

find_package(DCMTK)

if(DCMTK_FOUND)
  include_directories(${DCMTK_INCLUDE_DIRS})
  link_libraries(${DCMTK_LIBRARIES})

  # ...
else()
  message(WARNING "DCMTK not found")
  # ...
endif()

補足

• FindDCMTK は、CMake 3.2 以降で使用できます。
• DCMTK は、Linux、Windows、Mac OS X など、多くのプラットフォームで利用可能です。

FindDCMTK を使用したサンプルコード

シンプルなサンプル

find_package(DCMTK)

if(DCMTK_FOUND)
  message(STATUS "DCMTK version: ${DCMTK_VERSION}")
  include_directories(${DCMTK_INCLUDE_DIRS})
  link_libraries(${DCMTK_LIBRARIES})

  # ...

else()
  message(WARNING "DCMTK not found")
  # ...
endif()

• DCMTK のバージョン
• ヘッダーファイルのディレクトリ
• ライブラリのファイル

DCMTK の機能を使用するサンプル

find_package(DCMTK)

if(DCMTK_FOUND)
  message(STATUS "DCMTK version: ${DCMTK_VERSION}")
  include_directories(${DCMTK_INCLUDE_DIRS})
  link_libraries(${DCMTK_LIBRARIES})

  # DCMTK の機能を使用するコード

  # ...

else()
  message(WARNING "DCMTK not found")
  # ...
endif()

このコードは、上記のサンプルコードに加えて、DCMTK の機能を使用するコードを追加します。

DCMTK のオプションを使用するサンプル

find_package(DCMTK
  COMPONENTS
    dcmim
    dcmpct
    dfl
    dcmjpeg
    dcmnet
    dcmsr
    dsr2sr
    dsrxml
    dsriodcc
    dcmwlm
    wlistctn
    wlmscpfs
    wlmscpw)

if(DCMTK_FOUND)
  message(STATUS "DCMTK version: ${DCMTK_VERSION}")
  include_directories(${DCMTK_INCLUDE_DIRS})
  link_libraries(${DCMTK_LIBRARIES})

  # DCMTK のオプションを使用するコード

  # ...

else()
  message(WARNING "DCMTK not found")
  # ...
endif()

このコードは、FindDCMTK の COMPONENTS オプションを使用して、必要な DCMTK オプションを指定します。

DCMTK のパスを指定するサンプル

set(DCMTK_DIR "/path/to/dcmtk")

find_package(DCMTK
  PATHS
    ${DCMTK_DIR})

if(DCMTK_FOUND)
  message(STATUS "DCMTK version: ${DCMTK_VERSION}")
  include_directories(${DCMTK_INCLUDE_DIRS})
  link_libraries(${DCMTK_LIBRARIES})

  # ...

else()
  message(WARNING "DCMTK not found")
  # ...
endif()

このコードは、FindDCMTK の PATHS オプションを使用して、DCMTK の検索パスを指定します。

キャッシュを使用するサンプル

set(CMAKE_MODULE_PATH "/path/to/cmake/modules")

find_package(DCMTK
  USE_MODULE
  NO_PACKAGE_ROOT_DIR)

if(DCMTK_FOUND)
  message(STATUS "DCMTK version: ${DCMTK_VERSION}")
  include_directories(${DCMTK_INCLUDE_DIRS})
  link_libraries(${DCMTK_LIBRARIES})

  # ...

else()
  message(WARNING "DCMTK not found")
  # ...
endif()

このコードは、FindDCMTK の USE_MODULE オプションを使用して、キャッシュを使用します。

これらのサンプルコードは、FindDCMTK を使用して DCMTK をプロジェクトに統合する方法を示しています。

FindDCMTK 以外の方法

手動で設定する

FindDCMTK を使用せずに、DCMTK を手動で設定するには、以下の情報を設定する必要があります。

• ライブラリの依存関係

これらの情報は、DCMTK のインストールフォルダにあるドキュメントに記載されています。

CMakeLists.txt ファイルを編集する

FindDCMTK を使用せずに、CMakeLists.txt ファイルを直接編集して DCMTK を設定することもできます。

set(DCMTK_INCLUDE_DIRS "/path/to/dcmtk/include")
set(DCMTK_LIBRARIES "/path/to/dcmtk/lib/dcmtk.so")

# ...

include_directories(${DCMTK_INCLUDE_DIRS})
link_libraries(${DCMTK_LIBRARIES})

上記の例では、DCMTK のヘッダーファイルのディレクトリとライブラリのファイルパスを直接設定しています。

サードパーティ製の CMake モジュールを使用する

FindDCMTK 以外にも、サードパーティ製の CMake モジュールを使用して DCMTK を統合することができます。

これらのモジュールは、FindDCMTK と同様の機能を提供します。

C++ コードから直接インクルードする

C++ コードから直接 DCMTK のヘッダーファイルをインクルードすることもできます。

#include "/path/to/dcmtk/include/dcmtk/config/osconfig.h"
#include "/path/to/dcmtk/include/dcmtk/dcmtk/dcmjpeg/dcrleccd.h"

// ...

上記の例では、DCMTK のヘッダーファイルを直接インクルードしています。

どの方法を選択するべきかは、プロジェクトのニーズと環境によって異なります。

• FindDCMTK は、最も簡単で便利な方法です。
• 手動で設定する方法は、最も柔軟な方法ですが、設定が複雑になる可能性があります。
• サードパーティ製の CMake モジュールを使用する方法は、FindDCMTK と手動設定の中間の方法です。
• C++ コードから直接インクルードする方法は、最も簡単な方法ですが、移植性が低くなる可能性があります。

FindDCMTK は、DCMTK をプロジェクトに統合するための便利な方法です。ただし、他の方法も存在し、プロジェクトのニーズと環境によって最適な方法は異なります。