Medical Imaging Interaction Toolkit  2015.5.2
Medical Imaging Interaction Toolkit
Build Instructions

Introduction

The CMake-based build system of MITK supports a "superbuild" process, meaning that it will download, configure, and build all required third-party libraries (except Qt) automatically. These instructions will show you how to use the MITK superbuild.

Note
This page explains explicitly how to build MITK itself. If you want to create your own project based on MITK, the process described below is completely automated. Please see Creating a new MITK project.

For more advanced users, the last sections explains how to inject custom build libraries into the superbuild process.

Prerequisites

You need:

  1. Git from http://git-scm.com (there are also numerous third-party graphical clients available). We recomment using Git, but see below for a way how to get the current source code without using it.
  2. CMake (version 3.2 or higher)
  3. Qt 5.x if you plan to develop Qt-based applications (Qt 4 is still supported but may be dropped in near future)
  4. If you are using Mac OS X you need an XCode installation as it provides the neccessary compilers and SDKs

A note about Qt

As we do not provide Qt in the MITK superbuild you need to install Qt manually. Installing Qt dramatically improved since Qt 5, as The Qt Company provides sophisticated online installers for all supported platforms.

Note
Make sure that you select a Qt version which provides the right OpenGL-enabled packages for your architecture and compiler.

Get a source tree

Since MITK is under active development we recommend to use Git to check out the latest stable release from the homepage. If you decide to use the most current nightly release, make sure to get a stable tree: Check the MITK dashboard before checking out. If the build tree is not clean, you can specify an older revision for the checkout or get a stable tar ball from www.mitk.org.

If you don't want to use Git, you may also download a snapshot of the current source code (or any other older version) as a tar.gz package.

To clone MITK's current Git repository do:

git clone http://git.mitk.org/MITK.git

Build MITK with CMake

Create a new directory for the superbuild binary tree, change to it and call CMake:

In the shell (assuming your current directory is the same as the one where you issued the git clone command):

mkdir MITK-superbuild
cd MITK-superbuild
ccmake ../MITK

If you use Windows or prefer to use the CMake GUI, start the CMake GUI and enter the location of the source tree and binary tree, choose a suitable generator and configure the project.

CMake will present you a couple of options, these are the most important ones:

  • CMAKE_PREFIX_PATH The path to your Qt installation, e.g., C:/Qt/5.4/msvc2013_64_opengl or /home/user/Qt/5.4/gcc_64
  • MITK_USE_ACVD Build MITK code which depends on ACVD (this will download and build ACVD)
  • MITK_USE_BLUEBERRY Build the BlueBerry application framework
  • MITK_USE_Boost Build MITK code which depends on Boost (this will download Boost 1.56)
  • MITK_USE_Boost_LIBRARIES If you need binary Boost libraries, specify them here.
  • MITK_USE_OpenCV Build MITK code which depends on OpenCV (this will download and build OpenCV 2.4)
  • MITK_USE_Python Enables Python wrapping in MITK. This will also configure ITK, VTK, and OpenCV (if enabled) to build Python wrappers.
  • MITK_USE_QT Build MITK code which depends on Qt

If you are satisfied with the configuration of your MITK superbuild, generate the project files with CMake by pressing "Generate".

Linux and Mac OS X users usually just enter "make" (optionally supplying the number threads to be used for a parallel build):

make -j6

Windows users using Visual Studio can open the generated MITK-superbuild.sln solution file in the MITK-superbuild directory and start the build by building the BUILD_ALL project.

Customize your MITK superbuild

The MITK superbuild configures MITK as well as all external libraries. The build directories of these libraries, and of MITK itself are located inside the MITK-superbuild directory. For example, the directory layout may look like:

MITK-superbuild
|- ep "external projects"
|-bin
|-lib
|-include
|-src
|- MITK-build

To change the configuration of the MITK build itself, choose the MITK-build directory as the binary directory in the CMake GUI (not the MITK-superbuild directory). After generating the project files, build the MITK project by either issuing "make" in the MITK-build directory (Linux, Mac OS X), or by opening MITK-build/MITK.sln (Windows).

You may also change the configuration of any project configured via the superbuild process. Make sure to also build the changed project and also the projects which depend on it.

Running Applications

On Linux, just execute the application you want to run. MITK executables are located in MITK-superbuild/MITK-build/bin

On Windows, the PATH environment variable must contain the directories containing the third-party libraries. The MITK build system generated Windows batch files in the MITK-build directory set up a correct environment and opens the appropriate Visual Studio solution file. Use these batch files to be able to start and debug MITK applications from inside Visual Studio.

Documentation

If you have the Doxygen documentation tool installed, you get a new project (Visual Studio) or "make" target named "doc". You can build this to generate the HTML documentation of MITK in the Documentation/Doxygen directory of your MITK-build binary tree or in the MITK_DOXYGEN_OUTPUT_DIR CMake variable (if specified).

Extend MITK on your own (using the application framework BlueBerry)

Please see How to create a new MITK Plugin

Use MITK in your own project (as a toolkit)

To use MITK in your external project, add the CMake command find_package(MITK REQUIRED) to your CMakeLists.txt and make use of the CMake macros mitk_create_module() and mitk_create_executable() provided by MITK.

Here is an example CMakeLists.txt (from the Examples/QtAppExample/ directory) which allows you to create a Qt-based application using MITK to display an image.

cmake_minimum_required(VERSION 3.2 FATAL_ERROR)
project(QtAppExample)
# Check that MITK has been build with Qt support
if(NOT MITK_USE_QT)
message(SEND_ERROR "MITK needs to be built with MITK_USE_QT set to ON")
endif()
# Create the executable - it needs the MitkQtWidgetsExt module
mitk_create_executable(${PROJECT_NAME} DEPENDS MitkQtWidgets)

Superbuild customization

You can inject pre-build third-party libraries into the MITK superbuild by setting certain CMake variables before the first configure step. MITK will then use these third-party libraries instead of downloading and building them by itself. Note that you must take care of configuring those libraries with all options MITK requires.

The variables listed below are provided for injecting third-party libraries. Their occurrence in the CMake GUI or in ccmake may depend on specific MITK_USE_* options set to ON. You may also use the variable names below without the EXTERNAL_ prefix, for example when providing their values on a command line call to CMake.

  • EXTERNAL_BOOST_ROOT Set this variable to your custom Boost installation
  • EXTERNAL_CTK_DIR Set this variable to your CTK binary tree (the directory containing the CTKConfig.cmake file)
  • EXTERNAL_CableSwig_DIR Set this variable to your CableSwig binary tree for Python wrapping (the directory containing the CableSwigConfig.cmake file)
  • EXTERNAL_DCMTK_DIR Set this variable to your DCMTK binary tree (the directory containing the DCMTKConfig.cmake file)
  • EXTERNAL_GDCM_DIR Set this variable to your GDCM binary tree (the directory containing the GDCMConfig.cmake file)
  • EXTERNAL_ITK_DIR Set this variable to your ITK binary tree (the directory containing the ITKConfig.cmake file)
  • EXTERNAL_OpenCV_DIR Set this variable to your OpenCV binary tree (the directory containing the OpenCVConfig.cmake file)
  • EXTERNAL_VTK_DIR Set this variable to your VTK binary tree (the directory containing the VTKConfig.cmake file)

To set CMake options before the first configure step is invoked, supply them on the command line, i.e.

ccmake -DITK_DIR:PATH=/opt/ITK-release ../MITK

See the following link for more information about how to configure third-party libraries: How to build ITK, VTK and Qt