BBTK build instructions

Linux
Windows
CMake build options

Linux

Requirements

cmake >= 2.4.6

http://www.cmake.org/HTML/Download.html

wxWidgets >= 2.6.3 yum install
- yum install wxGTK-devel (fedora extras repos)
optional :

L_aT_eX to generate the pdf doc
tth to generate the html doc

http://hutchinson.belmont.ma.us/tth/

itk to compile packages itk, itkvtk

yum install InsightToolkit-devel (creatis repos)

vtk to compile package vtk, wxvtk

yum install vtk-devel (fedora extras repos)
Patches needed:

problem with /usr/lib/vtk-5.0/VTKConfig.cmake : had to change line 9: SET(VTK_INSTALL_PREFIX "${VTK_DIR}") by SET(VTK_INSTALL_PREFIX "") to be compatible with CMake/Modules/FindVTK.cmake
add /usr/local/lib in /etc/ld.so.conf or set LD_LIBRARY_PATH

Known working configurations

- gcc:
        4.2.0 (OpenSuse 10.3)
        4.1.2 20070925 (Red Hat 4.1.2-33)
        4.1.2 20070626 (Red Hat 4.1.2-13)
      4.1.1 20070105 (Red Hat 4.1.1-51)
        4.0.2 20051125 (Red Hat 4.0.2-8)
    - cmake:
        2.4-patch 6
   - wxGTK-devel:
        2.8.6
        2.6.3
   - InsightToolkit:
        3.4
        3.2
        2.8.1-5
   - vtk:
        5.0.3-1

Install from sources

    Uncompress the archive or checkout the source from the cvs repository (see Download page).
    In the parent folder of the bbtk sources type :
    > mkdir bbtkbin; cd bbtkbin
    > ccmake ../bbtk
    Check the desired options. See CMake build options for a description.

==> IMPORTANT NOTE :

    Type 'c' many times (untill no area is flagged with a '*' -Linux- nor highlighted in red -Windows- then type 'g', to generate.
    > make
    > sudo make install
   Enjoy !

Windows

Requirements

Mandatory

.net
CMake 2.4 patch 6 to generate the project file for .net
wxWidgets-2.8.5 (sources) to build graphical interface boxes

Optional

TortoiseVCS (Direct CVS tool within Explorer) and Putty (Telnet and SSH client) to get the sources from the cvs module
VTK 5.0.3 source (VTK 5.0.3 source code) to build vtk boxes (and if you want : VTK 5.0.3 data (VTK 5.0.3 data folder) and VTK 5.0.3 documentation (VTK 5.0.3 html documentation))
InsightToolkit-3.4.0 to build itk boxes
Miktex (TeX compiler and TeX-Pdf translation tool) to build documentations
TTH (TeX to HTML translation tool) to build html documentations
Doxygen to build the code documentations
Graphviz to generate the graphs in doxygen doc and black box pipelines graphs

Known working configurations

.net
cmake

2.4 patch 6

wxWidgets

2.8.5

InsightToolkit

3.4.0

5.0.3

Steps

Download the required files listed before.

CMAKE 2.4.6

1. Uninstall previous versions of CMake (if any)
2. Double clic on the installation file cmake-2.4.6-win32-x86.exe

Install VTK 5.0.3

1. Decompress in C:\Creatis\VTK5.0.3, each one in a separate folder, the files
   - vtkdata-5.0.3.tar.gz
   - vtkDocHtml-5.0.3.tar.gz
   - basic-miktex-2.6.2742.exe.
2. Create the project of VTK5.0.3 in CMake with:
   - Binary folder C:\Creatis\VTK5.0.3Bin
   - Configuration:
     BUILD_SHARED_LIBS --> ON
     If you want to compile the examples set: BUILD_EXAMPLES --> ON
   - Check that the VTK_DATA_ROOT variable at CMake is C:\Creatis\VTK5.0.3\VTKData
   - Clic configure once again and create (ok) the project
3. Open the created VTK project at C:\Creatis\VTK5.0.3Bin\VTK.sln and build the entire solution

TTH : Decompress the file tth_exe.zip in C:\Creatis\tth_exe

MikTeX : Double clic on the installation file basic-miktex-2.6.2742.exe (it is not necessary to change the default installation path)

BBTK

Uncompress the sources in C:\Creatis\bbtk or checkout the source from the cvs (see Download page).
Create the build folder C:\Creatis\bbtkBin
Drag and drop the file C:\Creatis\bbtk\CMakeLists.txt on the CMakeSetup icon

Check the desired options for the build. See CMake build options for a description.
If you want to build with vtk :

Enable Show Advanced Values
Clic configure twice and check that the VTK_DIR variable at CMake is C:/Creatis/VTK5.0.3Bin
Clic configure one more time

If you want to build with itk :

Enable Show Advanced Values

Clic configure twice and check that the ITK_DIR variable at CMake is C:/Creatis/InsightToolkitBin

Clic configure one more time

Clic configure many times and create the project (click ok).

To build with WxWidgets : Copy the debug dll files like wxbase26d_<LIBRARY_NAME>*.dll from wxWidgets to the bbtk binaries directory. Example : copy C:\Creatis\wxWidgets-2.6.3\wxWidgets-2.6.3\lib\vc_dll to: C:\Creatis\bbtkBin\bin\debug
To build with VTK : Copy all the debug dll files from VTK5.0.3 to the bbtk binaries directory. Example : copy all files in C:\Creatis\VTK5.0.3Bin\bin\debug to: C:\Creatis\bbtkBin\bin\debug
To build with ITK : ...
Open the solution created by cmake : C:\Creatis\bbtkBin\BBTK.sln and build the entire solution.

If you get dll error messages close the message(s) and after it's done, rebuild the complete solution.
If you get package intallation messages for missing and required files like fileName.sty, install them all.
The packages correspond to on-line complements that the MikTex program needs to build the BBTK documentation.

Enjoy !

CMake build options

The options in grey only appear if the last non grey option is set to ON (e.g. itk_IMAGE_DIM_2 and the following ones in grey only appear if BUILD_BBTK_PACKAGE_itk is ON).
The variables in dark grey and italics are NOT options but are automatically set by cmake according to the options selected. In particular the variables 'USE_something' indicate the dependencies on external libraries or utilities.
Advanced options are not shown here...

Option	Explaination	Default
--BUILD_ALL	Set to ON to build all the components of the toolkit	OFF
BBTK_COMPILE_DEBUG_MESSAGES	Compile debug messages in bbtk ?	OFF
BBTK_COMPILE_ERROR_MESSAGES	Compile error messages in bbtk ?	ON
BBTK_COMPILE_MESSAGES	Compile normal messages in bbtk ?	ON
BBTK_COMPILE_WARNING_MESSAGES	Compile warning messages in bbtk ?	ON
BBTK_USE_SHIPPED_BOOST	Use the boost C++ library provided with bbtk ? If not set you need to have boost installed	ON
BBTK_USE_WXWIDGETS	Build with the wxWidgets library ?	ON
BUILD_APPLICATIONS	Build bbtk applications : development studio (bbStudio), interpreter (bbi), xml to C++ code (bbfy), etc. ?	ON
BUILD_BBS_APPLI_BINARIES	Build executables for all bbs applications of all packages ? If set will compile all bbs of folder appli of all packages, using bbc	OFF
BUILD_BBTK_DOC	Build bbtk documentations ?	OFF
BUILD_BBTK_DOC_DOXYGEN	Build doxygen documentation for bbtk kernel? Requires doxygen	ON
BUILD_BBTK_DOC_GUIDES_HTML	Build html versions of the guides ? Requires latex, pdftex, tth	ON
BUILD_BBTK_DOC_GUIDES_PDF	Build pdf versions of the guides ? Requires latex, pdftex	ON
BUILD_BBTK_DOC_PACKAGE	Build packages html documentations ?	ON
BUILD_BBTK_PACKAGE_demo	Build the package 'demo' ? Requires : itk, vtk	OFF
BUILD_BBTK_PACKAGE_itk	Build the package 'itk' ? Requires : itk	OFF
BUILD_BBTK_PACKAGE_itkvtk	Build the package 'itkvtk ? Requires : itk, vtk	OFF
BUILD_BBTK_PACKAGE_std	Build the package 'std' ?	OFF
BUILD_BBTK_PACKAGE_toolsbbtk	Build the package 'toolsbbtk' ?	ON
BUILD_BBTK_PACKAGE_vtk	Build the package 'vtk' ? Requires : vtk	ON
BUILD_BBTK_PACKAGE_wx	Build the package 'wx' ? Requires : wxWidgets	ON
BUILD_BBTK_PACKAGE_wxvtk	Build the package 'wxvtk' ? Requires : wxWidgets, vtk
itk_IMAGE_DIM_2	Compile itk images of dimension 2 ?	ON
itk_IMAGE_DIM_3	Compile itk images of dimension 3 ?	ON
itk_IMAGE_DIM_4	Compile itk images of dimension 4 ?	ON
itk_IMAGE_TYPE_CHAR	Compile itk images of type char ?	ON
itk_IMAGE_TYPE_DOUBLE	Compile itk images of type double ?	ON
itk_IMAGE_TYPE_FLOAT	Compile itk images of type float ?	ON
itk_IMAGE_TYPE_INT	Compile itk images of type int ?	ON
itk_IMAGE_TYPE_SHORT	Compile itk images of type short ?	ON
itk_IMAGE_TYPE_UCHAR	Compile itk images of type unsigned char ?	ON
itk_IMAGE_TYPE_UINT	Compile itk images of type unsigned int ?	ON
itk_IMAGE_TYPE_USHORT	Compile itk images of type unsigned short ?	ON
BUILD_BBTK_PACKAGE_itkvtk	Build the package 'itkvtk' ? Requires : itk, vtk	OFF
BUILD_BBTK_PACKAGE_std	Build the package 'std ?	OFF
BUILD_BBTK_PACKAGE_test	Build the package 'test' ?	OFF
BUILD_BBTK_PACKAGE_toolsbbtk	Build the package 'toolsbbtk' ?	OFF
BUILD_BBTK_PACKAGE_vtk	Build the package 'vtk' ? Requires : vtk	OFF
BUILD_BBTK_PACKAGE_wx	Build the package 'wx' ? Requires : wxWidgets	OFF
BUILD_BBTK_PACKAGE_wxvtk	Build the package 'wxvtk' ? Requires : wxWidgets, vtk	OFF
CMAKE_BUILD_TYPE	Set to "Debug" or "Release"	-
CMAKE_INSTALL_PREFIX	Set the install folder	/usr/local
USE_BOOST	Automatically set to ON when boost C++ library is needed with the choices made	-
USE_DOXYGEN	Automatically set to ON when doxygen is needed with the choices made	-
USE_GDCM	Build with the GDCM library?	OFF
USE_GSMIS	Build with the GSMIS library?	OFF
USE_ITK	Automatically set to ON when ITK library is needed with the choices made	-
USE_LATEX	Automatically set to ON when LaTeX is needed with the choices made	-
USE_TTH	Automatically set to ON when tth is needed with the choices made	-
USE_VTK	Automatically set to ON when VTK library is needed with the choices made	-
USE_WXWIDGETS	Automatically set to ON when wxWidgets library is needed with the choices made	-