+ +User Project documentation
+
+ +

Follow this link User Install Instructions
+
+Read the users' guide if you +want to learn how to use bbtk development environnement (bbStudio) and +how to write black box scripts.
+
+Read the package +developers' guide to learn how to create your own black boxes and +packages.
+
+Developers might also be interested in doxygen documentation of the +source code of bbtk library.
+
+The boxes lists contain the boxes of bbtk core packages (std,wx,vtk...) +for current version.
+
+All this documentation is also available from bbStudio.
+
+
+

+ + diff --git a/doc/template_WebSite/install.html b/doc/template_WebSite/install.html new file mode 100644 index 0000000..9b5f41b --- /dev/null +++ b/doc/template_WebSite/install.html @@ -0,0 +1,870 @@ + + + + + BBTK @BBTK_VERSION@ Install + + +

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

Linux +
+
Windows +
1. Requirements
2. Known working configurations
3. Steps
+
CMake build options

Linux

Requirements

cmake >= 2.4.6
crea >= 0.2.0
+
wxWidgets >= +2.6.3
optional :
+

L_aT_eX +to generate the pdf guides
+
tth to generate the html +guides
+
itk to compile packages itk, +itkvtk
vtk to compile package vtk, +wxvtk
doxygen to build the sources +documentation
graphviz/dot to generate the +packages doc with pipeline graphs
+

+ +

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)
+    +- 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
+    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 until no area is flagged with a '*' and three times more +then type 'g', to generate.
+    > make
+    > sudo make install
+   Enjoy !
+
+ +

Uninstall
+

+    You can run bbtk-uninstall.sh +as root.
+    WARNING :
+       This is a brute force **UNSAFE** +uninstaller which removes all files and folders starting with 'bb' in :
+        INSTALL-PREFIX/bin
+        INSTALL-PREFIX/lib
+        INSTALL-PREFIX/include
+        INSTALL-PREFIX/share/bbtk
+    However it lists the files found and prompts you +before proceeding...
+
+
+

Windows

+ +

Requirements

Mandatory

.net V7 to +compile the kernel and the packages
+
CMake +2.4 patch 6 to +generate the project file for .net
wxWidgets-2.8.5 +to +build graphical interface boxes

Optional

VTK +5.0.3 source to build vtk boxes
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 V7
+
cmake

2.4 +patch 6

wxWidgets

2.8.5

InsightToolkit

3.4.0

5.0.3 +
+

+ +

Steps
+

+ + +

Uncompress +the sources in yourSourceDirectory +or checkout the source from the cvs
Create +the build folder yourSourceDirectory\bin
Drag 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
+

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)
To 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 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 : ourSourceDirectory\bin\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' ?	ON
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 +	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_demo	Build the package 'demo' ? +Requires : ALL the other +packages +	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' ?	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 +
EXECUTABLE_OUTPUT_PATH +	Single output directory for +building all the executables +	- +
LIBRARY_OUTPUT_PATH	Single output directory for +building all the libraries	- +
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_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	- +

+ + diff --git a/doc/template_WebSite/menu.html b/doc/template_WebSite/menu.html new file mode 100644 index 0000000..cc2028e --- /dev/null +++ b/doc/template_WebSite/menu.html @@ -0,0 +1,42 @@ + + + + USER DOCUMENTATION + + + + +Home
+Build instructions
+

Guides and documentation +
+ User's +Guide (pdf) +
+ Package Developer's Guide +
+ +

+ +

Boxes
+ +Alphabetical +list
+List by +package
+List by +category
+List of +adaptors +
+ +

+ + + diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt new file mode 100644 index 0000000..03bc324 --- /dev/null +++ b/lib/CMakeLists.txt @@ -0,0 +1,86 @@ +#---------------------------------------------------------------------------- +# SET THE NAME OF YOUR LIBRARY +# (Replace 'MyLib' by your own library name) + +############################# +SET ( LIBRARY_NAME TransformLib ) +############################# + +#---------------------------------------------------------------------------- + +#---------------------------------------------------------------------------- +# CREATES A USER OPTION IN CMAKE +OPTION ( BUILD_${LIBRARY_NAME} "Build ${LIBRARY_NAME} library ?" ON) +#---------------------------------------------------------------------------- + +#---------------------------------------------------------------------------- +IF ( BUILD_${LIBRARY_NAME} ) +#---------------------------------------------------------------------------- + + #---------------------------------------------------------------------------- + # BUILD LIBRARY + #---------------------------------------------------------------------------- + + #---------------------------------------------------------------------------- + # LIBRARY HEADERS (TO BE INSTALLED) + # EITHER LIST ALL .h, *.txx IN CURRENT DIR USING NEXT LINE: + + FILE(GLOB ${LIBRARY_NAME}_HEADERS "*.h" "*.txx") + + # OR MANUALLY LIST YOUR HEADERS WITH NEXT COMMAND + # SET ( ${LIBRARY_NAME}_HEADERS + # + # ) + #---------------------------------------------------------------------------- + + #---------------------------------------------------------------------------- + # LIBRARY SOURCES (TO BE COMPILED) + # EITHER LIST ALL .cxx, *.cpp, *.cc IN CURRENT DIR USING NEXT LINE: + + FILE(GLOB ${LIBRARY_NAME}_SOURCES *.cxx *.cpp *.cc) + + # OR MANUALLY LIST YOUR FILES WITH NEXT COMMAND (WITHOUT EXTENSION) + # SET ( ${LIBRARY_NAME}_SOURCES + # + # ) + #---------------------------------------------------------------------------- + + #---------------------------------------------------------------------------- + # LIBRARY DEPENDENCIES (LIBRARIES TO LINK WITH) + # + # Uncomment the Libraries you need + # + SET ( ${LIBRARY_NAME}_LINK_LIBRARIES + # ${crea_LIBRARIES} + # ${WXWIDGETS_LIBRARIES} + # ${KWWidgets_LIBRARIES} + ${VTK_LIBRARIES} + # ${ITK_LIBRARIES} + # ${GDCM_LIBRARIES} + # ${BOOST_LIBRARIES} + + # If this library must link against other libraries + # Add here any extra Library you need + + ) + #---------------------------------------------------------------------------- + + #---------------------------------------------------------------------------- + # MACRO WHICH DOES ALL THE JOB : BUILD AND INSTALL + + # The default is to create a Dynamic Library. + # if you need to create a static library + # comment out the following line : + + CREA_ADD_LIBRARY( ${LIBRARY_NAME} ) + + # and uncomment the 2 lines hereafter: + + # ADD_LIBRARY(${LIBRARY_NAME} STATIC ${${LIBRARY_NAME}_SOURCES}) + # TARGET_LINK_LIBRARIES(${LIBRARY_NAME} ${${LIBRARY_NAME}_LINK_LIBRARIES} ) + + # + #---------------------------------------------------------------------------- + + #--------------------------------------------------------------------------- +ENDIF ( BUILD_${LIBRARY_NAME} ) diff --git a/lib/creaSystem.h b/lib/creaSystem.h new file mode 100644 index 0000000..d91ccee --- /dev/null +++ b/lib/creaSystem.h @@ -0,0 +1,26 @@ + +#ifndef _$PROJECT_NAME$SYSTEM_H_ +#define _$PROJECT_NAME$SYSTEM_H_ + + +// Windoze related troubles (as usual) + +//----------------------------------------------------------------------------- + +#if defined(_WIN32) + #ifdef $PROJECT_NAME$_EXPORT_SYMBOLS + #define $PROJECT_NAME$_EXPORT __declspec( dllexport ) +#else + #define $PROJECT_NAME$_EXPORT __declspec( dllimport ) + #endif + #define $PROJECT_NAME$_CDECL __cdecl +#else + #define $PROJECT_NAME$_EXPORT + #define $PROJECT_NAME$_CDECL +#endif // defined(_WIN32) + +#ifdef __BORLANDC__ + #include +#endif + +#endif diff --git a/lib/creaSystem.h.in b/lib/creaSystem.h.in new file mode 100644 index 0000000..d91ccee --- /dev/null +++ b/lib/creaSystem.h.in @@ -0,0 +1,26 @@ + +#ifndef _$PROJECT_NAME$SYSTEM_H_ +#define _$PROJECT_NAME$SYSTEM_H_ + + +// Windoze related troubles (as usual) + +//----------------------------------------------------------------------------- + +#if defined(_WIN32) + #ifdef $PROJECT_NAME$_EXPORT_SYMBOLS + #define $PROJECT_NAME$_EXPORT __declspec( dllexport ) +#else + #define $PROJECT_NAME$_EXPORT __declspec( dllimport ) + #endif + #define $PROJECT_NAME$_CDECL __cdecl +#else + #define $PROJECT_NAME$_EXPORT + #define $PROJECT_NAME$_CDECL +#endif // defined(_WIN32) + +#ifdef __BORLANDC__ + #include +#endif + +#endif diff --git a/lib/sourceTransformer.cxx b/lib/sourceTransformer.cxx new file mode 100644 index 0000000..8bcdcd2 --- /dev/null +++ b/lib/sourceTransformer.cxx @@ -0,0 +1,100 @@ + +#include "sourceTransformer.h" +#include "vtkMatrix4x4.h" + +/* + CONSTRUCTOR: Initializes the two points with empty vectors, the angle in 0. +*/ +Transformer::Transformer() +{ + std::vector empty (3,0); + _angle= 0; + _centerPoint=empty; + _scaleX=1; + _scaleY=1; + //If the transform already exists, we delete it before we create a new transform + //and set the matrix with the identity matrix + _transform= vtkTransform::New(); + vtkMatrix4x4 *_matrix = vtkMatrix4x4::New(); + _matrix->Identity(); + _transform->SetMatrix(_matrix); + +} + +/* + DESTRUCTOR +*/ +Transformer::~Transformer() +{ + //We delete the existing transform + if (_transform != NULL ) { _transform->Delete(); } +} + +/* + SETS A NEW TRANSFORM +*/ +void Transformer::SetTransform(vtkTransform *transform) +{ + _transform=transform; +} + +/* + SETS CENTER POINT +*/ +void Transformer::SetCenterPoint(std::vector point) +{ + _centerPoint=point; +} + +/* + SETS THE ANGLE +*/ +void Transformer::SetAngle(double angle) +{ + _angle=angle; +} + +/* + SETS THE X SCALE +*/ +void Transformer::SetScaleX(double scaleX) +{ + _scaleX=scaleX/100.0; +} + +/* + SETS THE Y SCALE +*/ +void Transformer::SetScaleY(double scaleY) +{ + _scaleY=scaleY/100.0; +} + +/* + SETS THE Y SCALE + */ +void Transformer::SetScaleZ(double scaleZ) +{ + _scaleZ=scaleZ/100.0; +} + + + +/* + GETS THE RESULTANT TRANSFORM +*/ +vtkTransform *Transformer::GetResult() +{ + return _transform; +} + +/* + MAKES THE TRANSFORMATIONS +*/ +void Transformer::Run() +{ + _transform->Translate(_centerPoint[0], _centerPoint[1], _centerPoint[2]); + _transform->Scale(_scaleX, _scaleY,_scaleZ); + _transform->RotateWXYZ(_angle, 0, 0, 1); + _transform->Update(); +} diff --git a/lib/sourceTransformer.h b/lib/sourceTransformer.h new file mode 100644 index 0000000..7af6494 --- /dev/null +++ b/lib/sourceTransformer.h @@ -0,0 +1,30 @@ + +#ifndef _$PROJECT_NAME$SOURCE01_H_ +#define _$PROJECT_NAME$SOURCE01_H_ + +#include "vtkTransform.h" +#include + +class Transformer{ +public: + Transformer(); + ~Transformer(); + void SetTransform(vtkTransform *transform); + void SetCenterPoint(std::vector point); + void SetAngle(double angle); + void SetScaleX(double scaleX); + void SetScaleY(double scaleY); + void SetScaleZ(double scaleZ); + void Run(); + vtkTransform *GetResult(); +private: + std::vector _centerPoint; + double _angle; + double _scaleX; + double _scaleY; + double _scaleZ; + //vtkImageData *_image; + vtkTransform *_transform; +}; + +#endif diff --git a/lib/sourceVectorMath.cxx b/lib/sourceVectorMath.cxx new file mode 100644 index 0000000..37eb419 --- /dev/null +++ b/lib/sourceVectorMath.cxx @@ -0,0 +1,6 @@ +#include "sourceVectorMath.h" + +VectorMath::VectorMath() +{ + +} \ No newline at end of file diff --git a/lib/sourceVectorMath.h b/lib/sourceVectorMath.h new file mode 100644 index 0000000..96f8f06 --- /dev/null +++ b/lib/sourceVectorMath.h @@ -0,0 +1,29 @@ +#ifndef _$PROJECT_NAME$SOURCE01_H_ +#define _$PROJECT_NAME$SOURCE01_H_ + +#include "vtkMath.h" +#include + +class VectorMath{ +public: + VectorMath(); + ~VectorMath(); + /*void SetTransform(vtkTransform *transform); + void SetCenterPoint(std::vector point); + void SetAngle(double angle); + void SetScaleX(double scaleX); + void SetScaleY(double scaleY); + void SetScaleZ(double scaleZ); + void Run(); + vtkTransform *GetResult(); +private: + std::vector _centerPoint; + double _angle; + double _scaleX; + double _scaleY; + double _scaleZ; + //vtkImageData *_image; + vtkTransform *_transform;*/ +}; + +#endif \ No newline at end of file diff --git a/lib/template_lib/creaSystem.h b/lib/template_lib/creaSystem.h new file mode 100644 index 0000000..d91ccee --- /dev/null +++ b/lib/template_lib/creaSystem.h @@ -0,0 +1,26 @@ + +#ifndef _$PROJECT_NAME$SYSTEM_H_ +#define _$PROJECT_NAME$SYSTEM_H_ + + +// Windoze related troubles (as usual) + +//----------------------------------------------------------------------------- + +#if defined(_WIN32) + #ifdef $PROJECT_NAME$_EXPORT_SYMBOLS + #define $PROJECT_NAME$_EXPORT __declspec( dllexport ) +#else + #define $PROJECT_NAME$_EXPORT __declspec( dllimport ) + #endif + #define $PROJECT_NAME$_CDECL __cdecl +#else + #define $PROJECT_NAME$_EXPORT + #define $PROJECT_NAME$_CDECL +#endif // defined(_WIN32) + +#ifdef __BORLANDC__ + #include +#endif + +#endif diff --git a/lib/template_lib/creaSystem.h.in b/lib/template_lib/creaSystem.h.in new file mode 100644 index 0000000..d91ccee --- /dev/null +++ b/lib/template_lib/creaSystem.h.in @@ -0,0 +1,26 @@ + +#ifndef _$PROJECT_NAME$SYSTEM_H_ +#define _$PROJECT_NAME$SYSTEM_H_ + + +// Windoze related troubles (as usual) + +//----------------------------------------------------------------------------- + +#if defined(_WIN32) + #ifdef $PROJECT_NAME$_EXPORT_SYMBOLS + #define $PROJECT_NAME$_EXPORT __declspec( dllexport ) +#else + #define $PROJECT_NAME$_EXPORT __declspec( dllimport ) + #endif + #define $PROJECT_NAME$_CDECL __cdecl +#else + #define $PROJECT_NAME$_EXPORT + #define $PROJECT_NAME$_CDECL +#endif // defined(_WIN32) + +#ifdef __BORLANDC__ + #include +#endif + +#endif -- 2.47.1

bbtk package @BBTK_PACKAGE_NAME@

bbtk coding style (and other religious/agnostic beliefs)

Help Contents

Guides

Boxes

Linux

Requirements

Known working configurations

Install from sources

Uninstall
+

Windows

Requirements

Mandatory

Optional

Known working configurations

Steps
+

CMake build options

bbtk package @BBTK_PACKAGE_NAME@

bbtk coding style (and other religious/agnostic beliefs)

Help Contents

Guides

Boxes

Linux

Requirements

Known working configurations

Install from sources

Uninstall +

Windows

Requirements

Mandatory

Optional

Known working configurations

Steps +

CMake build options

Uninstall
+

Steps
+