ITK/Release 4/Modularization/Configure and build ITK: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
(→‎Default mode: fix typo)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Key CMake options created for modular ITK =
= CMake options to customizing ITK modules =


== Main mode (groups) ==
== Default mode ==
*  '''ITKGroup<xxx>''':  select a group of modules. The default grouping/categorization of the modules can be found in "ITK/CMake/ITKGroup.cmake". The core group is turned on by default.


   When a group is ON, all the modules in the group and their depending modules are "enabled".
*  '''ITK_BUILD_ALL_MODULES''':   request to build all the default modules in the toolkit, by default this option is ON.
  The corresponding CMake variables " <module name>_ENABLED" for each of those modules are ON.
All non-default modules have "EXCLUDE_FROM_ALL" tags in their module definition files(itk-module.cmake), including the remote modules (source
  Users could change the categorization by editing "CMake/ITKGroup.cmake" according to their needs.
code located outside of the main ITK repository) and modules who depend on external third-party libraries, such as vtkGlue, BridgeOpenCV, BridgeVXL, etc.


== Advanced mode (modules) ==
== Group Options==
*  '''Module_<xxx>''':   build a module.
 
*  '''ITK_BUILD_ALL_MODULES''':  build all the modules in the toolkit (for testing the entire toolkit, this option is often used)
*  '''ITKGroup<xxx>''': request to build a group of modules. The source code is organized as such that modules belong to the same group stay in the same group directory. The core group is turned on by default.
   When a module is ON, the module and its depending modules are "enabled".
 
   The corresponding CMake variables " <module name>_ENABLED" are ON.
   When a group is ON, all the modules in the group and their depending modules are enabled. When a group of OFF, all the modules in the group except the ones that are required by other enabled modules.
 
 
== Module Options ==
*  '''Module_<xxx>''':   request to build a module. This option is hidden from the CMake gui when the module is enabled by module dependencies (other modules depend on this module), by the the group option or by the default mode(ITK_BUILD_ALL_MODULES).

Latest revision as of 15:15, 30 October 2013

CMake options to customizing ITK modules

Default mode

  • ITK_BUILD_ALL_MODULES: request to build all the default modules in the toolkit, by default this option is ON.

All non-default modules have "EXCLUDE_FROM_ALL" tags in their module definition files(itk-module.cmake), including the remote modules (source code located outside of the main ITK repository) and modules who depend on external third-party libraries, such as vtkGlue, BridgeOpenCV, BridgeVXL, etc.

Group Options

  • ITKGroup<xxx>: request to build a group of modules. The source code is organized as such that modules belong to the same group stay in the same group directory. The core group is turned on by default.
 When a group is ON, all the modules in the group and their depending modules are enabled. When a group of OFF, all the modules in the group except the ones that are required by other enabled modules.


Module Options

  • Module_<xxx>: request to build a module. This option is hidden from the CMake gui when the module is enabled by module dependencies (other modules depend on this module), by the the group option or by the default mode(ITK_BUILD_ALL_MODULES).
Retrieved from "https://public.kitware.com/Wiki/index.php?title=ITK/Release_4/Modularization/Configure_and_build_ITK&oldid=54375"