Unknown user: Text replacement - "slicerWiki/index.php" to "wiki"

2019-11-21T17:04:50Z

Text replacement - "slicerWiki/index.php" to "wiki"

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

2013-06-14T07:43:26Z

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

UpdateBot: Nightly -> 4.2

2012-10-31T21:59:00Z

Nightly -> 4.2

New page

Slicer supports three types of modules. While the developer has to choose between one of the three types to implement its module, the end user won't notice the difference as they all share the same look & feel. The choice for a given type of module is usually based on the type of inputs/parameters for a given module.

= Command Line Interface (CLI) =
CLIs are standalone executables with a limited input/output arguments complexity (simple argument types, no user interactions...). They are typically implemented using [http://www.itk.org ITK].
* Shared lib or executable
* UI automatically generated
* Where to start ?
# Create initial skeleton using [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]]
# Read [[Documentation/{{documentation/version}}/Developers/Build_Module|Compiling slicer modules outside of the slicer source tree.]]
# Learn from existing [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/CLI/ existing modules]
* Links:
** [[Slicer3:Execution_Model_Documentation|Slicer3 execution model]] (Slicer4 is very similar)
** [http://www.na-mic.org/Wiki/index.php/File:Slicer4_CLI.ppt CLI in Slicer4] (presentation of 2012 NAMIC AHM)

= Loadable Modules =
Loadable modules are [http://en.wikipedia.org/wiki/C%2B%2B C++] plugins that are built against Slicer. They define custom GUIs for their specific behavior as they have full control over the application.
* C++ shared library
* Full control over the UI (based on [http://qt.nokia.com/products/ Qt]) and Slicer internals (MRML, logics, display managers...)
* Optimized for heavy computations
* Where to start ?
# Create initial skeleton using [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]]
# Read [[Documentation/{{documentation/version}}/Developers/Build_Module|Compiling slicer modules outside of the slicer source tree.]]
# Learn from existing [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/ existing modules]
* Links:
**[http://www.na-mic.org/Wiki/index.php/File:LoadableModules.pptx Loadable modules] (presentation of 2012 NAMIC AHM)
**[[Documentation/{{documentation/version}}/Developers/Tutorials/CreateLoadableModule|How to write a loadable module]]

= Scripted Modules =
Scripted modules are written in [http://www.python.org/ Python] and typically but not necessarily use the high level API of Slicer and toolkits.
* Python Console
* Full access to the API: [http://www.vtk.org VTK], [http://www.itk.org ITK], MRML, [http://qt.nokia.com/products/ Qt] and Slicer are fully wrapped
* Recommended for fast prototyping
* Where to start ?
# Create initial skeleton using [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]]
# Read [[Documentation/{{documentation/version}}/Developers/Build_Module|Compiling slicer modules outside of the slicer source tree.]]
# Learn from existing [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Scripted/ existing modules]
* Links:
** [http://www.slicer.org/slicerWiki/index.php/Documentation/{{documentation/version}}/Developers/Python_scripting Python Scripting]
** [[Documentation/{{documentation/version}}/Training#Slicer4_Programming_Tutorial|Python Scripting Tutorial]]

=Module Factory=
Loading modules into slicer happens in multiple steps:
*module factories must be registered into the factory manager
* directories where the modules to load are located must be passed to the factory manager
* Optionally specify module names to ignore
* scan the directories and test which file is a module and register it (not instantiated yet)
* Instantiate all the register modules
* Connect each module with the scene and the application
More details can be found in the [http://slicer.org/doc/html/classqSlicerAbstractModuleFactoryManager.html online doc]

==ToDo==
* Transform all core modules into Loadable modules.
** the factory manager only support file based modules, core modules are not file based (linked into the core factory itself)
* Move factory registration in qSlicerApplication (or a general application library) to support module discovery/loading without needing to instantiate Slicer.
** Currently can't be moved into qSlicerApplication as the CLI factories that are in QTCLI depend on QTGUI
** QtTesting is also limited with the QTCLI dependency on QtGUI (->qSlicerApplication would need to access QtTesting code from QtCli)
** Proposed architecture
Base
Application -> classes that are useful to build an application (mix of qSlicerCoreApplication, qSlicerApplication, Main.cxx...)
Core -> formally QtCore
Modules -> contains the factories and module specific code
Loadable
CLI
Scripted
Scripted -> all that is python specific
Cxx
Python
Widgets -> formally QtGUI
* Add category hierarchy in the Settings module panel
* Register factory settings/command-options(e.g. disable-loadable-modules) when registering module factories
** To have the settings panel be generic but have the code proper of each registered factory somewhere else
* Add mechanism for modules to register dialogs (toolbars that open dialogs), e.g. the sceneview module needs to register the sceneView dialog into an icon.
* Ignore modules from the launcher command line.
* cloning" of module panels at run time. See [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2012/008965.html "here] and [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2012/008039.html here]

← Older revision		Revision as of 07:43, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	Slicer supports three types of modules. While the developer has to choose between one of the three types to implement its module, the end user won't notice the difference as they all share the same look & feel. The choice for a given type of module is usually based on the type of inputs/parameters for a given module.		Slicer supports three types of modules. While the developer has to choose between one of the three types to implement its module, the end user won't notice the difference as they all share the same look & feel. The choice for a given type of module is usually based on the type of inputs/parameters for a given module.

@@ Line 37: / Line 37: @@
 # Learn from existing [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Scripted/ existing modules]
 * Links:
-** [http://www.slicer.org/slicerWiki/index.php/Documentation/{{documentation/version}}/Developers/Python_scripting Python Scripting]
+** [http://www.slicer.org/wiki/Documentation/{{documentation/version}}/Developers/Python_scripting Python Scripting]
 ** [[Documentation/{{documentation/version}}/Training#Slicer4_Programming_Tutorial|Python Scripting Tutorial]]

Documentation/4.2/Developers/Modules - Revision history

Unknown user: Text replacement - "slicerWiki/index.php" to "wiki"

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

UpdateBot: Nightly -> 4.2