ITK/Configuring and Building

From KitwarePublic
Jump to navigationJump to search

Configuring And Building

This page describes the various ways of configuring and building ITK in common configurations. The build instructions are generally the same across platforms. Nuances will be noted.


ITK is configured with the cross-platform configuration tool, CMake. CMake will create project files for your build system of choice, e.g. Makefile's, Visual Studio project files, KDevelop project files, etc. The content of these project files is based on a domain specific language kept in CMakeLists.txt files distributed with the source code, the results of introspecting of the software and hardware features available on a system, and the preferences of the user building the system.

There are three executables used to perform a CMake:

  1. cmake: A command line interface.
  2. ccmake: An ncurses (terminal) GUI. (only available on Unix-like systems).
  3. cmake-gui: A Qt-based GUI.

To perform a CMake configuration, we need three things:

  1. The source code directory.
  2. A different to perform the build (make this directory manually).
  3. One of the three CMake executables.

Persistent configuration variables are stored in a file called CMakeCache.txt that lives at the top level of the build directory. Configuration variables can have different types, e.g. a boolean, a string, a filepath, etc. By convention, most persistent configuration variable names are composed of all capital letters and underscores such as BUILD_SHARED_LIBS. For this reason, they may resemble environmental variables, but they are not environmental variables.

Configuration with the cmake executable

The cmake executable is the simplest executable, and it is appropriate for shell use or scripting. To use the executable, first change your current working directory to the build directory. For example,

 cd ~/bin/ITK

Next, run the cmake executable. For a first time configuration, the required argument is the path to the top level of the source tree. For example,

 cmake ~/src/ITK

Using a predefined Configuration

CMake can be run interactively to configure a build, in which case all settings begin with system defaults (as determined by CMakeLists.txt) and the user customises them.

Alternatively, a predefined configuration (such as those shown above) can be provided, which will provide initial settings for the build (also known as priming). By creating a file called CMakeCache.txt in the top level of the build directory, the settings defined therein will be used to override the default settings for the build.

Wrapping ITK

ITK can be wrapped for several different languages such as Python, Tcl and Java.

ITK: [Welcome | Site Map]