Install

Install
+

BBTK @BBTK_VERSION@ +(@BBTK_VERSION_DATE@) build instructions

cmake >= 2.4.6

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

wxWidgets >= +2.6.3
optional :

wxWidgets >= -2.6.3
-

yum install wxGTK-devel -(fedora extras repos)
-

L_aT_eX -to generate the pdf doc
+to generate the pdf guides
tth to generate the html doc

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

tth to generate the html +guides
+
itk to compile packages itk, itkvtk

yum install -InsightToolkit-devel (creatis repos)
-

vtk to compile package vtk, wxvtk
doxygen to build the sources +documentation
graphviz/dot to generate the +packages doc with pipeline graphs
+

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.3.0 (Fedora Core 9)
+

+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)
-    -    4.1.1 20070105 (Red Hat 4.1.1-51)
-        -4.1.2 20070626 (Red Hat 4.1.2-13)
-        4.2.0 (OpenSuse 10.3)
-    - cmake:
@@ -120,25 +98,33 @@ set LD_LIBRARY_PATH    - wxGTK-devel:
-        -2.6.3
        +2.8.6
-        -2.8
        +2.6.3
-   +   - InsightToolkit:
    -    2.8.1-5

-    +        3.2
-    -    3.4
    +    2.8.1-5
-   +   - vtk:
    @@ -148,19 +134,26 @@ set LD_LIBRARY_PATH style="font-weight: normal;">Install from sources     Uncompress the -archive or checkout the source from the cvs repository (see Download page).
+archive or checkout the source from the cvs repository
    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.
-    Type 'c' many -times then 'g'.
+ style="font-style: italic;"> for a description.
+
+==> +IMPORTANT NOTE :
+
+    +Type 'c' many +times until no area is flagged with a '*' and three times more +then type 'g', to generate.
    > make
-    > make install
+    > sudo make install
   Enjoy !

@@ -173,53 +166,39 @@ times then 'g'.
style="font-weight: normal;">Requirements

Mandatory

.net
+
.net V7 to +compile the kernel and the packages
CMake -2.4 patch 6CMake +2.4 patch 6 to -generate the project file for .net
-

+generate the project file for .net

wxWidgets-2.8.5 +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
wxWidgets-2.8.5 (sources) to -build graphical interface boxes
-
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 +
VTK +5.0.3 source to build vtk boxes

InsightToolkit-3.4.0 to build itk boxes

Miktex (TeX compiler +

Miktex +(TeX compiler and TeX-Pdf translation tool) to build documentations

TTH (TeX to HTML translation +

TTH (TeX +to HTML translation tool) to build html documentations

Doxygen to build the +

Doxygen +to build the code documentations

Graphviz to generate the -graphs in doxygen doc and black box pipelines graphs +

Graphviz +to generate the +graphs in doxygen doc and black box pipelines graphs

@@ -227,8 +206,7 @@ graphs in doxygen doc and black box pipelines graphsKnown working configurations

.net -????
+
.net V7

cmake

@@ -261,106 +239,20 @@ patch 6

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).

yourSourceDirectory

Create the build folder C:\Creatis\bbtkBinyourSourceDirectory\bin
Drag and drop the file -C:\Creatis\bbtk\CMakeLists.txt on the CMakeSetup iconDrag and drop the file yourSourceDirectory\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 : for a description

To build with WxWidgets : the .ddl +must be accessible; either their names are in system PATH variable, +either copy +them in the current bin directory (bin/Debug or bin/Release, depending +whether you compiled in Debug or Release mode)

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\debugTo build with VTK : the .ddl must be accessible; either their +names are in system PATH variable, either copy +them in the current bin directory (bin/Debug or bin/Release, depending +whether you compiled in Debug or Release mode)

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 : ...To +build with ITK : the .ddl must be accessible; either their +names are in system PATH variable, either copy +them in the current bin directory (bin/Debug or bin/Release, depending +whether you compiled in Debug or Release mode)

Open -the solution created by cmake : C:\Creatis\bbtkBin\BBTK.sln and build +the solution created by cmake : ourSourceDirectory\bin\BBTK.sln and build the entire solution.

If @@ -443,7 +309,6 @@ needs to build the BBTK documentation.

Enjoy !
-

@@ -451,11 +316,18 @@ Enjoy !
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_PACKAGE_itk is ON).
-Advanced options are not shown +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...

- +

- @@ -473,60 +345,205 @@ here...
- + - - + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - - - - - - - + - - + + - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - - - + - - - + - - - + - - - + - - - + - - - +

Option
@@ -465,7 +337,7 @@ here...

Default

ALL_BUILD
+

--BUILD_ALL

Set to ON to build all the components of the toolkit

BBTK_DATA_ROOT
+

BBTK_COMPILE_DEBUG_MESSAGES

Compile debug messages in bbtk ?

Enter the path to the bbtk_data folder (will be written in -the default bbtk_config.xml file)
+

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 +?
+

BUILD_APPLICATIONS

Set to ON to build bbtk applications : interpreter -(bbi), xml to C++ code (bbfy), package documentation (bbdoc)

Build bbtk applications : development studio (bbStudio), +interpreter +(bbi), xml to C++ code (bbfy), etc. ?
+

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_bbi_GRAPHICAL
+ style="vertical-align: top; background-color: rgb(192, 192, 192);">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

Set -to ON to build bbi in graphical mode allowing to use widget boxes -(requires wxWidgets)
+ style="vertical-align: top; background-color: rgb(192, 192, 192);">ON
+

BUILD_BBTK_DOC_GUIDES_PDF
+

Build +pdf versions of the guides ?
+Requires latex, pdftex
+

ON
+

BUILD_BBTK_DOC_PACKAGE

OFF
+ style="vertical-align: top; background-color: rgb(192, 192, 192);">Build +packages html documentations ?
+

BUILD_EXAMPLES
+

BUILD_BBTK_PACKAGE_demo
+

Build the package 'demo' ?
+Requires : itk, vtk

Set to ON to build the C++ examples

OFF

BUILD_PACKAGE_itk
+

BUILD_BBTK_PACKAGE_itk

Set to ON to build the package itk (requires the -InsightToolkit installed)
+

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' ?

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
+

ON
+

itk_IMAGE_DIM_2

Set -to ON to compile itk images of dimension 2
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of dimension 2 ?

ON
@@ -537,8 +554,8 @@ to ON to compile itk images of dimension 2
style="vertical-align: top; background-color: rgb(204, 204, 204);"> itk_IMAGE_DIM_3

Set -to ON to compile itk images of dimension 3
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of dimension 3 ?

ON
@@ -549,8 +566,8 @@ to ON to compile itk images of dimension 3
style="vertical-align: top; background-color: rgb(204, 204, 204);"> itk_IMAGE_DIM_4

Set -to ON to compile itk images of dimension 4
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of dimension 4 ?

ON
@@ -562,8 +579,8 @@ to ON to compile itk images of dimension 4
itk_IMAGE_TYPE_CHAR

Set -to ON to compile itk images of type char
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of type char ?

ON
@@ -574,8 +591,8 @@ to ON to compile itk images of type char
style="vertical-align: top; background-color: rgb(204, 204, 204);"> itk_IMAGE_TYPE_DOUBLE

Set -to ON to compile itk images of type double
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of type double ?

ON
@@ -587,8 +604,8 @@ to ON to compile itk images of type double
itk_IMAGE_TYPE_FLOAT

Set -to ON to compile itk images of type float
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of type float ?

ON
@@ -600,8 +617,8 @@ to ON to compile itk images of type float
itk_IMAGE_TYPE_INT

Set -to ON to compile itk images of type int
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of type int ?

ON
@@ -613,8 +630,8 @@ to ON to compile itk images of type int
itk_IMAGE_TYPE_SHORT

Set -to ON to compile itk images of type short
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of type short ?

ON
@@ -626,8 +643,8 @@ to ON to compile itk images of type short
itk_IMAGE_TYPE_UCHAR

Set -to ON to compile itk images of type unsigned char
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of type unsigned char ?

ON
@@ -639,8 +656,8 @@ to ON to compile itk images of type unsigned char
itk_IMAGE_TYPE_UINT

Set -to ON to compile itk images of type unsigned int
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of type unsigned int ?

ON
@@ -652,189 +669,183 @@ to ON to compile itk images of type unsigned int
itk_IMAGE_TYPE_USHORT

Set -to ON to compile itk images of type unsigned short
+ style="vertical-align: top; background-color: rgb(204, 204, 204);">Compile +itk images of type unsigned short ?

BUILD_PACKAGE_itkvtk
+

BUILD_BBTK_PACKAGE_demo

Build the package 'demo' ?
+Requires : ALL the other +packages

Set to ON to build the package itkvtk (requires the -InsightToolkit and VTK installed)

OFF

BUILD_PACKAGE_std
-

Set to ON to build the package std
-

ON
+

BUILD_BBTK_PACKAGE_itkvtk

BUILD_PACKAGE_vtk
+

Build the package 'itkvtk' ?
+Requires : itk, vtk

Set to ON to build the package vtk (requires VTK installed)

OFF

BUILD_PACKAGE_wx
+

BUILD_BBTK_PACKAGE_std

Set to ON to build the package wx (requires wxWidgets -installed)

Build the package 'std ?

OFF

BUILD_PACKAGE_wxvtk
-

Set to ON to build the package wxvtk (requires VTK and -wxWidgets installed)

BUILD_BBTK_PACKAGE_toolsbbtk

Build the package 'toolsbbtk' ?

OFF

BUILD_SHARED_LIBS
+

BUILD_BBTK_PACKAGE_vtk

Set to ON to build bbtk as a shared library (.so/.dll) - -Remark that packages as always build as such
+

Build the package 'vtk' ?
+Requires : vtk

ON
+

OFF

BUILD_bbtk_DOC
+

BUILD_BBTK_PACKAGE_wx

Set to ON to build documentations
+

Build the package 'wx' ?
+Requires : wxWidgets

OFF

-BUILD_bbtk_DOC_DOXYGEN
+

BUILD_BBTK_PACKAGE_wxvtk

Set to ON to -build doxygen documentation of bbtk and of the selected packages
+

Build the package 'wxvtk' ?
+Requires : wxWidgets, vtk

ON
+

OFF

-BUILD_bbtk_DOC_GUIDES_HTML
-

Set to ON to -build bbtk Users' guide, Package developers' guide and Developers' -guide in html format (requires LaTeX and tth)
-

ON
+

CMAKE_BUILD_TYPE

-BUILD_bbtk_DOC_GUIDES_PDF
+

Set to "Debug" or "Release"

Set to ON to -build bbtk Users' guide, Package developers' guide and -Developers' guide in pdf format (requires LaTeX)

ON
+

-BUILD_bbtk_DOC_PACKAGE
+

CMAKE_INSTALL_PREFIX

Set to ON to -generate the packages html doc with bbdoc
+

Set the install folder

ON
+

/usr/local

CMAKE_BUILD_TYPE
+

EXECUTABLE_OUTPUT_PATH

Set to "Debug" or "Release"
+

Single output directory for +building all the executables

CMAKE_INSTALL_PREFIX
-

Set the install location
-

/usr/local
+

LIBRARY_OUTPUT_PATH

Single output directory for +building all the libraries

GENERATE_RPMBUILD_SPEC
+

USE_BOOST

Set to ON to create a .spec file to generate a rpm with -rpmbuild
+

Automatically +set to ON when boost C++ library is needed with the choices made

OFF
+

USE_CONFIGURATION_FILE
-

Set to ON to use the configuration file (bbtk_config.xml) in -bbtk
+

USE_DOXYGEN

OFF
+

Automatically +set to ON when doxygen is needed with the choices made

VERBOSE_MAKEFILE
-

Set to ON to generate a verbose makefile which echos the -commands issued
+

USE_ITK

OFF
+

Automatically +set to ON when ITK library is needed with the choices made

bbtk_COMPILE_DEBUG_MESSAGES
+

USE_LATEX

Set to ON to compile debug messages in bbtk

OFF
+

Automatically +set to ON when LaTeX is needed with the choices made

bbtk_COMPILE_ERROR_MESSAGES
+

USE_TTH

Set to ON to compile error messages in bbtk

ON
+

Automatically +set to ON when tth is needed with the choices made

bbtk_COMPILE_MESSAGES
+

USE_VTK

Set to ON to compile normal messages in bbtk

ON
+

Automatically +set to ON when VTK library is needed with the choices made

bbtk_COMPILE_WARNING_MESSAGES
-

Set to ON to compile warning messages in bbtk
+

USE_WXWIDGETS

ON
+

Automatically +set to ON when wxWidgets library is needed with the choices made