Documentation/4.1/Developers/Tutorials/ExternalModuleWriting - Revision history

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:27:25Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

JChris.FillionR at 07:04, 18 June 2012

2012-06-18T07:04:07Z

JChris.FillionR: /* 1) Create the module directory */

2012-05-27T21:36:43Z

1) Create the module directory

JChris.FillionR: /* Initialization */

2012-05-25T22:28:37Z

Initialization

JChris.FillionR at 22:25, 25 May 2012

2012-05-25T22:25:59Z

JChris.FillionR at 22:17, 25 May 2012

2012-05-25T22:17:04Z

JChris.FillionR at 18:15, 16 May 2012

2012-05-16T18:15:34Z

JChris.FillionR: 4.0 -> 4.1

2012-04-12T04:41:29Z

4.0 -> 4.1

New page

Back to [[Documentation/{{documentation/version}}/Developers|Developers Information]]←

This tutorial describes how to make a (Slicer4 / QT) loadable module that is compiled outside of the slicer build tree.

Consider also reading:
:[[Media:QtPortInSlicer.ppt|QtPortInSlicer - How to write a module]]
:[[Documentation/{{documentation/version}}/Developers/Tutorials/ModuleWriting|How to write a module inside Slicer]]

* Create the skeleton code using the [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]]
$ export SD=$HOME/build/slicer-4/Slicer4
$ python ${SD}/Scripts/ModuleWizard.py \
--template ${SD}/QTModules/ModuleTemplate \
--target MY_MODULE_NAME \
MY_MODULE_NAME
* Setting up your CMakeLists.txt
** [http://forge.abcd.harvard.edu/gf/project/plastimatch/scmsvn/?action=browse&path=%2F%2Acheckout%2A%2Fplastimatch%2Ftrunk%2Fcmake%2FFindSlicer.cmake Download FindSlicer.cmake]
** Edit CMakeLists.txt, and make it (1) detect Slicer, (2) load the Slicer "Use file", and (3) add your module subdirectory.
find_package (Slicer QUIET)
if (SLICER_FOUND)
include ("${Slicer_USE_FILE}")
if (SLICER_IS_SLICER4)
add_subdirectory (MY_MODULE_NAME)
endif ()
endif ()
* You might need to undo some of Slicer's settings. If you don't think you need this, then you probably don't. But if you need it, you can do something like this:
if (Slicer_USE_FILE)
get_directory_property (OLD_INCLUDE_DIR INCLUDE_DIRECTORIES)
set_directory_properties (PROPERTIES INCLUDE_DIRECTORIES "")
set (OLD_CFLAGS ${CMAKE_C_FLAGS})
set (OLD_CXXFLAGS ${CMAKE_CXX_FLAGS})

include ("${Slicer_USE_FILE}")

get_directory_property (SLICER_INCLUDE_DIRS INCLUDE_DIRECTORIES)
set_directory_properties (PROPERTIES INCLUDE_DIRECTORIES
"${OLD_INCLUDE_DIR}")
set (CMAKE_C_FLAGS "${OLD_CFLAGS}" CACHE STRING "CMake CXX Flags" FORCE)
set (CMAKE_CXX_FLAGS "${OLD_CXXFLAGS}" CACHE STRING "CMake CXX Flags" FORCE)
endif ()
* You might need to copy over TestingMacros.h, it depends how you set up your include directories above.
$ cp ${SD}/TestingMacros.h MY_MODULE_NAME
* Compile your module. At this point, it will compile. You may see some warnings from CMake
CMake Warning at /home/gsharp/build/slicer-4/Slicer4/CMake/vtkMacroKitPythonWrap.cmake:86 (ADD_LIBRARY):
Cannot generate a safe runtime search path for target
vtkSlicerMY_MODULE_NAMEModuleLogicPython because files in some directories
may conflict with libraries in implicit directories:

runtime library [libpython2.6.so.1.0] in /usr/lib may be hidden by files in:
/home/gsharp/build/slicer-4/Slicer4-Build/python-build/lib

Some of these libraries may not be found correctly.
Call Stack (most recent call first):
/home/gsharp/build/slicer-4/Slicer4/CMake/SlicerMacroPythonWrapModuleLibrary.cmake:66 (vtkMacroKitPythonWrap)
/home/gsharp/build/slicer-4/Slicer4/CMake/SlicerMacroBuildModuleLogic.cmake:76 (SlicerMacroPythonWrapModuleLibrary)
src/slicer/QTModules/MY_MODULE_NAME/Logic/CMakeLists.txt:28 (SlicerMacroBuildModuleLogic)
These warnings are benign. Anyone know how to turn them off?
* The above setup will put the shared libraries directly into the slicer build directory. I guess this isn't what you want, but now is a good time to test that everything is working. Make sure the files are there.

On unix:

$ cd ${SLICER_BUILD}/Slicer-build
$ find . -name "*MY*" -print
./bin/MY_MODULE_NAMECxxTests
./bin/libvtkSlicerMY_MODULE_NAMEModuleLogicPythonD.so
./bin/vtkSlicerMY_MODULE_NAMEModuleLogicPython.so
./bin/Python/slicer/modulelogic/vtkSlicerMY_MODULE_NAMEModuleLogic.py
./bin/Python/slicer/modulelogic/vtkSlicerMY_MODULE_NAMEModuleLogic.pyc
./lib/Slicer3/QTLoadableModules/libvtkSlicerMY_MODULE_NAMEModuleLogic.so
./lib/Slicer3/QTLoadableModules/libqSlicerMY_MODULE_NAMEModule.so

When you fire up slicer, you should see the module. For me, it looks like this:

[[File:ExternalModuleWriting_screenshot.png]]

* It is possible (with some work), to tell your program to build the module in your own directory instead of Slicer's. However, there is not yet any way to tell slicer to look in your own directory. So we leave the tutorial and await further developments.

← Older revision		Revision as of 07:27, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	This tutorial describes how to make a (Slicer4 / QT) loadable module that is compiled outside of the slicer build tree.		This tutorial describes how to make a (Slicer4 / QT) loadable module that is compiled outside of the slicer build tree.

@@ Line 3: / Line 3: @@
 = Consider also reading =
 :[[Media:QtPortInSlicer.ppt|QtPortInSlicer - How to write a module]]
-:[[Documentation/{{documentation/version}}/Developers/Tutorials/ModuleWriting|How to write a module inside Slicer]]
+:[[Documentation/{{documentation/version}}/Developers/Tutorials/CreateLoadableModule|How to write a loadable module inside Slicer]]
 = Initialization =

@@ Line 8: / Line 8: @@
 === 1) Create the module directory ===
-{{:Documentation/{{documentation/version}}/Developers/Tutorials/ModuleWriting/CreateModuleDirectory}}
+Use the [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]] to generate files and directory based on a template.
 === 2) Setting up your CMakeLists.txt ===

@@ Line 8: / Line 8: @@
 === 1) Create the module directory ===
-{{:{{FULLPAGENAME}}/CreateModuleDirectory}}
+{{:Documentation/{{documentation/version}}/Developers/Tutorials/ModuleWriting/CreateModuleDirectory}}
 === 2) Setting up your CMakeLists.txt ===

← Older revision		Revision as of 18:15, 16 May 2012
Line 1:		Line 1:
−	~~Back to [[Documentation/{{documentation/version}}/Developers\|Developers Information]]←~~
−
	This tutorial describes how to make a (Slicer4 / QT) loadable module that is compiled outside of the slicer build tree.		This tutorial describes how to make a (Slicer4 / QT) loadable module that is compiled outside of the slicer build tree.

@@ Line 1: / Line 1: @@
 This tutorial describes how to make a (Slicer4 / QT) loadable module that is compiled outside of the slicer build tree.
-Consider also reading:
+= Consider also reading =
 :[[Media:QtPortInSlicer.ppt|QtPortInSlicer - How to write a module]]
 :[[Documentation/{{documentation/version}}/Developers/Tutorials/ModuleWriting|How to write a module inside Slicer]]
-* Create the skeleton code using the [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]]
+= Initialization =
-  $ export SD=$HOME/build/slicer-4/Slicer4
+=== 1) Create the module directory ===
-  $ python ${SD}/Utilities/Scripts/ModuleWizard.py \
-       --template ${SD}/Modules/Loadable/ModuleTemplate \
+{{:{{FULLPAGENAME}}/CreateModuleDirectory}}
-       --target MY_MODULE_NAME \
-       MY_MODULE_NAME
+=== 1) Create the module directory ===
-* Setting up your CMakeLists.txt
-** [http://forge.abcd.harvard.edu/gf/project/plastimatch/scmsvn/?action=browse&path=%2F%2Acheckout%2A%2Fplastimatch%2Ftrunk%2Fcmake%2FFindSlicer.cmake Download FindSlicer.cmake]
+=== 2) Setting up your CMakeLists.txt ===
-** Edit CMakeLists.txt, and make it (1) detect Slicer, (2) load the Slicer "Use file", and (3) add your module subdirectory.
    find_package (Slicer QUIET)
    if (SLICER_FOUND)
@@ Line 38: / Line 40: @@
 * You might need to copy over TestingMacros.h, it depends how you set up your include directories above.
    $ cp ${SD}/TestingMacros.h MY_MODULE_NAME
 * Compile your module.  At this point, it will compile.  You may see some warnings from CMake
   CMake Warning at /home/gsharp/build/slicer-4/Slicer4/CMake/vtkMacroKitPythonWrap.cmake:86 (ADD_LIBRARY):