This is the Slicer 4 visual blog. Please click [[Slicer3:VisualBlog| here]] if you are looking for the old Slicer 3 visual blog.

<gallery caption="2013" widths="200px" perrow="4">
Image:SlicerIGT-VisualBlog2013.png| Some applications of the SlicerIGT extension for image-guided and navigated medical interventions. For more information see [[http://www.slicerigt.org]].
Image:UKFTractography_CC.jpg|[http://wiki.slicer.org/slicerWiki/index.php/Documentation/Nightly/Extensions/UKFTractography UKFTractography] is a module for computing tractography of DWI images using an unscented Kalman filter. Because of its 2-tensor algorithm, it is able to model fiber crossings and capture many more fibers than a single tensor algorithm.
Image:SPV1.png|[http://wiki.slicer.org/slicerWiki/index.php/Documentation/Nightly/Extensions/ShapePopulationViewer ShapePopulationViewer] is an external tool that allows the user to dynamically interact with multiple surfaces at the same time : an interesting tool for shape visualisation and comparison. It now is available as a Slicer Extension.
Image:SlicerRT_0.13_SubjectHierarchy_ProstateEclipseLoaded.png|[http://www.na-mic.org/Wiki/index.php/2014_Winter_Project_Week:SubjectHierarchy The Subject hierarchy module and mechanism] organizes and handles loaded data in the RT extension package, providing processing and analysis features through plugins. It aspires to be a convenient central organizing point for many of the operations that 3D Slicer and its extensions perform.
Image:DownloadFile 2.jpg|[[Documentation/4.3/Modules/DataStore|The Data Store]] allows a user to easily upload and download MRB files.
Image:SlicerRT ContourRepresentations.png|[[Documentation/4.3/Modules/Contours|The Contours module]] manages contours in the RT extension package.
Image:MultiVolume-4.3.0-update.png| [[Documentation/4.3/Modules/MultiVolumeExplorer|MultiVolumeExplorer module]] has been updated to include the capability to plot multivolume pixel values from 2 multivolumes at the same time. This feature is particularly helpful while visualizing the results of model fits, such as those produced by the updated [[Documentation/4.3/Modules/PkModeling|PkModeling extension]].
Image:MatlabBridgeLogo.png| A new extension allows to run matlab scripts without having to recompile Slicer. For more information see [[Documentation/Nightly/Extensions/MatlabBridge|'''here''']]
Image:ExtensionManagerScreen Shot 2013-05-23 at 9.40.23 PM.png| Extension Manager, the slicer multiplatform Appstore is open for business and free.
Image:ScreenshotLobeSegmentation.png| Semi-automatic lobe segmentation for regional lung disease analysis as part of the Chest Imaging Platform funded by NHLBI 1R01HL116931
Image:CMRToolkit.png|The [http://capulet.med.utah.edu/namic/cmrslicer Cardiac MR Extension] provides tools for segmentation and analysis of heart tissue and structure for treatment and diagnosis of Atrial Fibrillation.
</gallery>
<gallery caption="2012" widths="200px" perrow="4">
Image:BoxChart.png| A box plot
Image:2012-09-07-FetalBrain.png| Fetal brain development. The visualization is using volume rendering and the Multivolume modules in Slicer 4. Click [[media:FetalBrainGowth.mov|'''here''']] for the full movie (~24mb). Data downloaded from [http://biomedic.doc.ic.ac.uk/brain-development/index.php?n=Main.Fetal Imperial College].
Image:Screen Shot 2012-09-05 at 10.01.35 AM.png|Leveraging multi viewer layout to arrange 6 slices in the 3D viewer
Image:ComplexQueryWithImage.jpg|Visualization of complex query "motor system + mass + straight gyrus" using the faceted query module
Image:Screen Shot 2012-05-30 at 8.03.23 AM.png| Fibers colored by their mean orientation is now available in the Tractography Display module
Image:SlicerRT-0.2_screenshot.png|[https://www.assembla.com/spaces/slicerrt/milestones/1089853-slicerrt-0-2-release SlicerRT 0.2] has been released! [https://www.assembla.com/spaces/slicerrt/ SlicerRT] is 3D Slicer with extensions for radiotherapy research, which is developed by SparKit project with the contributions from Slicer community.
Image:Screen Shot 2012-04-11 at 8.07.36 AM.png|The new extension manager
Image:Screen Shot 2012-04-11 at 8.11.59 AM.png|Up to date download statistics
Image:Screen Shot 2012-04-05 at 11.35.08 AM.png|A combination of ROI cropping of streamlines, fiducial based seeding and labelmap seeding allows to assess the deformation of streamlines which are due to tumor based deformations.
Image:2012-03-05-downloadpage.png|New download page which highlights the operating system of the downloading system.
Image:2012-03-04-Welcome.png|New look for the Welcome module and the "Load/Save" toolbar
Image:2012-03-04-DWI2FBT.png|Step one of the DWI to Full-brain tractography wizard
Image:2012-03-04-SliceViewerControllers.png|Improved 2-stage user interface for the Slice Viewer Controllers
Image:2012-03-04-DicomWidget.png|Updated Dicom Module
Image:2012-03-04-CoreModuleIcons.png|Updated Icons for the Core Modules
Image:2012-03-04-CompareViews.png|Updated CompareViewers and Viewer Controler Module
Image:Screen Shot 2012-02-23 at 7.53.51 AM.png|MultiVolumeExplorer with support for charting. See [[Documentation/Snapshot/Modules/MultiVolumeExplorer|here]] for more information.
Image:Screen Shot 2012-02-09 at 10.11.08 AM.png|[[Documentation/4.0/Modules/LabelStatistics|Label Statistics]] with charting and visualization
Image:3D Slicer 4.0.1.2012-02-03 180.png|Image Quantification with Label Statistics, Charting, and Volume Rendering
Image:Slicer2011-gource.png|Frame from a movie of slicer code activity in 2011. See '''[http://boggs.bwh.harvard.edu/slicer/slicer4-2011-gource.x264.mp4 the full movie here]'''. Made with [http://code.google.com/p/gource/ gource]. Inspired by a [http://vimeo.com/33989053 an ITKv4 gource movie]
Image:AnEarlyChartView.png|A ChartView using QWebView and jqPlot with plots defined in MRML
Image:ALaterChartView.png|A ChartView using QWebView and jqPlot with plots defined in MRML
Image:ABarChartView.png|A bar chart tie MRML to a QWebView
</gallery>
<gallery caption="2011" widths="200px" perrow="4">
Image:Prostate multiparametric visualization Slicer4.png|Compareviewers
Image:Slicer4_ChangeTracker_Ad.png|ChangeTracker visualization of analysis results
Image:Slicer4-SceneViewGUI.jpeg|Sceneview Module
Image:Selection 142.png|Dicom widget
Image:3D Slicer 4.0.gamma-2011-10-20 141.png|Endoscopy module
Image:VolumeRendering-CTA-2011.png|Volumerendering of a CT angiogram
Image:Tumor-Volume-Rendering-PostGad-2011.png|Volumerendering of a subvolume of a post Gadolinium T1 weighted image of a GBM. Note the relation of surrounding vessels to the tumor.
Image:2011-11-12-CroppingWholeBrainTractography-detail.png|Note the deformation of the corpus callosum fibers
Image:2011-11-12-CroppingWholeBrainTractography.png|Using an ROI to crop streamlines from a whole brain tractography. The streamlines display color by orientation, the ellipsoids are displaying fractional anisotropy.
Image:Screen Shot 2011-11-02 at 1.52.42 PM.png|Annotation module 2011-11
Image:MainGUI-2011-11.png|Main Gui with pop-up slice controllers
Image:DataProbe-2011-11.png|The Data Probe
Image:ModelsModule-2011-11.png|Models organized in a hierarchy
Image:Conventional-Widescreen-10-2011.png|New Look Oct 2011
Image:QSlicerVolumeRenderingModule-DualView.png|Dual camera, dual 3D viewer
Image:4.0-Main-GUI-Facelift.png|After the facelift for the GUI
Image:QSlicerModelsModule.png|New models module appearance
Image:SlicerWithVolumeRendering.png|Slicer4 with Volume Rendering
Image:Slicer4-AnnotationGUI.jpg|Slicer4 Annotation Module
Image:SlicerWithDTI.png|Glyph display on cross-sections
Image:FirstCompareViewInSlicer4-2011.png| First CompareView in Slicer4 2011
Image:2011-01-24-Annotation.png| Slicer 4 Annotation Module 2011-01-24
Image:2011-01-24-Annotation.png| Slicer 4 Annotation Module 2011-01-24
Image:LiveUltrasoundModule-Slicer4.jpg| Slicer 4 Live ultrasound module for IGT spine procedures
Image:LiveUltrasoundModule-Slicer4_2.jpg| Slicer 4 Live ultrasound module for IGT prostate procedures
</gallery>

<gallery caption="2010" widths="200px" perrow="4">
Image:2010-SlicerAM QtAnnotation.png| Slicer 4 Annotation Module
Image:SlicerQT-2009-12-10.png|Slicer with Qt only
Image:QSlicerROIModule.png| ROI Module
</gallery>

2013-05-25T19:08:48Z

Ungi:

<noinclude>
__TOC__
</noinclude>= Extensions by Category =

==Cat 1==

==Cat 2==
* [[Documentation/{{documentation/version}}/Extensions/SkullStripper|SkullStripper]] (Xiaodong Tao)
* [[Documentation/{{documentation/version}}/Extensions/CARMA|Cardiac MRI Toolkit]] (Alan Morris, Salma Bengali)[[image:UnderConstruction.png|tumb|10px]]
* [[Documentation/{{documentation/version}}/Extensions/PkModeling|PkModeling]] (Emma Zhu, Jim Miller)
* [[Documentation/{{documentation/version}}/Extensions/FacetedVisualizer|FacetedVisualizer]] (Harini Veeraraghavan, Jim Miller)
* [[Documentation/{{documentation/version}}/Extensions/Reporting|Reporting]] (Andrey Fedorov, Nicole Aucoin, Steve Pieper) (work in progress)
* [[Documentation/{{documentation/version}}/Extensions/SlicerRT|SlicerRT]] (Csaba Pinter, Andras Lasso, Kevin Wang, Steve Pieper)
** [[Documentation/{{documentation/version}}/Modules/DicomRtImport|DICOM-RT import]]
** [[Documentation/{{documentation/version}}/Modules/Contours|Contours]]
** [[Documentation/{{documentation/version}}/Modules/DoseVolumeHistogram|Dose volume histogram]]
** [[Documentation/{{documentation/version}}/Modules/DoseAccumulation|Dose accumulation]]
** [[Documentation/{{documentation/version}}/Modules/DoseComparison|Dose comparison]]
** [[Documentation/{{documentation/version}}/Modules/Isodose|Isodose line and surface display]]
** [[Documentation/{{documentation/version}}/Modules/ContourComparison|Contour comparison]]
** [[Documentation/{{documentation/version}}/Modules/ContourMorphology|Contour morphology]]
** [[Documentation/{{documentation/version}}/Modules/PatientHierarchy|Patient hierarchy]]
** [[Documentation/{{documentation/version}}/Modules/DeformationFieldVisualizer|Deformation field visualizer]]
** Modules from [[Documentation/{{documentation/version}}/Extensions/Plastimatch|Plastimatch]] (Greg Sharp)
*** [[Documentation/{{documentation/version}}/Modules/PlmBSplineDeformableRegistration|Plastimatch Automatic deformable image registration]]
*** [[Documentation/{{documentation/version}}/Modules/PlmDICOMRTImport|Plastimatch DICOM-RT import]]
*** [[Documentation/{{documentation/version}}/Modules/PlmDICOMRTExport|Plastimatch DICOM-RT export]] [[image:UnderConstruction.png|tumb|10px]]
*** [[Documentation/{{documentation/version}}/Modules/PlmLANDWARP|Plastimatch LANDWARP Landmark]]
*** [[Documentation/{{documentation/version}}/Modules/PlmXFORMWARP|Plastimatch XFORMWARP]] [[image:UnderConstruction.png|tumb|10px]]
* [[Documentation/{{documentation/version}}/Extensions/SlicerIGT|SlicerIGT]] (Tamas Ungi, Adam Rankin, Andras Lasso, Junichi Tokuda, Laurent Chauvin)
** [[Documentation/{{documentation/version}}/Modules/CollectFiducials|CollectFiducials]] (Tamas Ungi)
** [[Documentation/{{documentation/version}}/Modules/CreateModels|CreateModels]] (Tamas Ungi, Matthew Holden)
** [[Documentation/{{documentation/version}}/Modules/OpenIGTLinkRemote|OpenIGTLinkRemote]] (Tamas Ungi, Andras Lasso)
** [[Documentation/{{documentation/version}}/Modules/UltrasoundSnapshots|UltrasoundSnapshots]] (Tamas Ungi, Franklin King)
** [[Documentation/{{documentation/version}}/Extensions/VolumeResliceDriver|VolumeResliceDriver]] (Junichi Tokuda, Tamas Ungi, Laurent Chauvin)
* [[Documentation/{{documentation/version}}/Extensions/iGyne|iGyne]] (Xiaojun Chen and iGyne Team)
* [[Documentation/{{documentation/version}}/Extensions/LongitudinalPETCT|LongitudinalPETCT]] (Paul Mercea, Andrey Fedorov)
* [[Documentation/{{documentation/version}}/Extensions/DTIProcess|DTIProcess]] (Francois Budin)
* [[Documentation/{{documentation/version}}/Extensions/DTIAtlasFiberAnalyzer|DTIAtlasFiberAnalyzer]] (Francois Budin)
* [[Documentation/{{documentation/version}}/Extensions/FiberViewerLight|FiberViewerLight]] (Francois Budin)
* [[Documentation/{{documentation/version}}/Extensions/DTIPrep|DTIPrep]] (Francois Budin)
* [[Documentation/{{documentation/version}}/Extensions/DTIAtlasBuilder|DTIAtlasBuilder]] (Adrien Kaiser)
* [[Documentation/{{documentation/version}}/Extensions/TubeTK|TubeTK]] (Stephen Aylward, Jean-Christophe Fillion-Robin, Christopher Mullins, Michael Jeulin-L, Matthew McCormick)
* [[Documentation/{{documentation/version}}/Extensions/UKFTractography|UKFTractography]] (Ryan Eckbo, Yogesh Rathi)
* [[Documentation/{{documentation/version}}/Extensions/TrackerStabilizer|TrackerStabilizer]] (Laurent Chauvin, Jayender Jagadeesan)
* [[Documentation/{{documentation/version}}/Extensions/ChangeTracker|ChangeTracker]] (Andrey Fedorov)
* [[Documentation/{{documentation/version}}/Extensions/SobolevSegmenter|SobolevSegmenter]] (Arie Nakhmani)
* [[Documentation/{{documentation/version}}/Extensions/QuickTools|QuickTools]] (Julien Finet)
** [[Documentation/{{documentation/version}}/Modules/ImageMaker|Image Maker]]
* [[Documentation/{{documentation/version}}/Extensions/XNATSlicer|XNATSlicer]]
* [[Documentation/{{documentation/version}}/Extensions/ErodeDilateLabel|ErodeDilateLabel]] (Junichi)

==Cat 3==
* [[Documentation/{{documentation/version}}/Extensions/LesionSegmentation|LesionSegmentation]] (Mark Scully)
**[[Documentation/{{documentation/version}}/Modules/TrainModel|LesionSegmentation->TrainModel]] (Mark Scully)
**[[Documentation/{{documentation/version}}/Modules/PredictLesions|LesionSegmentation->PredictLesions]] (Mark Scully)

<noinclude>
{{:Documentation/{{documentation/version}}/FAQ/Extensions|Extensions}}
</noinclude>

File:PerkTutorScreenshot.png

2013-02-23T19:17:49Z

Ungi:

File:PerkTutorLogo.png

2013-02-23T19:11:58Z

Ungi:

Documentation/Labs/DeprecatedModules

2013-02-21T20:41:10Z

2012-06-09T01:14:33Z

Ungi: /* 1) Create the module directory */

=Consider also reading=
*[[Media:QtPortInSlicer.ppt|QtPortInSlicer - How to write a module]]
*[[Documentation/{{documentation/version}}/Developers/Tutorials/ExternalModuleWriting|How to write an external module]]

= Initialization =
=== 1) Create the module directory ===

Use the [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]] to generate files and directory based on a template.
{|
! style="border-bottom: 1px solid darkgrey;"| Linux
! style="border-bottom: 1px solid darkgrey;"| Mac
! style="border-bottom: 1px solid darkgrey;"| Windows
|-
| colspan=2; valign="top" |
Start terminal (<code>bash</code> or <code>Terminal.app</code>), then type the following: 
$ cd /path/to/Slicer4
$ python Utilities/Scripts/ModuleWizard.py MY_MODULE_NAME
| valign="top" |
Start <code>cmd.exe</code> terminal, then type the following (in 64-bit mode replace <code>PCbuild</code> with <code>PCbuild\amd64</code>): 
$ cd C:\path\to\Slicer4
$ ..\Slicer4-Superbuild\python-build\PCBuild\python.exe Utilities\Scripts\ModuleWizard.py MY_MODULE_NAME
|}
Replace <code>MY_MODULE_NAME</code> with the name of the module you want (e.g. <code>HelloWorld</code>) 
After running the script, a new directory <code>MY_MODULE_NAME</code> will be created in <code>Slicer4/Modules/Loadable</code>
 

=== 2) Add the module in CMake ===
Edit the file [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/CMakeLists.txt?view=markup Slicer4/Modules/Loadable/CMakeLists.txt]:
Add the name of your module at the end of the qtmodules variable assignment:
...
set(qtmodules
...
MY_MODULE_NAME
)
...
 
=== 3) Compile ===
Compile the inner build (''Slicer-build'' inside the Superbuild directory).
{|
! style="border-bottom: 1px solid darkgrey;"| Linux
! style="border-bottom: 1px solid darkgrey;"| Mac
! style="border-bottom: 1px solid darkgrey;"| Windows
|-
| colspan=2; valign="top" |
$ cd ../Slicer4-Superbuild/Slicer-build;
$ make -j4
| valign="top" |
$ cd ..\Slicer4-Superbuild\Slicer-build;
$ .\Slicer.exe --VisualStudio Slicer.sln
In Visual Studio, go to Build -> Build Solution
|}
 

=== 4) Check the module ===
Start Slicer and make sure the module is present (listed under "Module Template")
$ ./Slicer
To change the module title that shows up in Slicer, edit the file <code>Slicer4/Modules/Loadable/MY_MODULE_NAME/CMakeLists.txt</code>
set(MODULE_TITLE "Your title")
Other [http://slicer.org/doc/html/classqSlicerAbstractCoreModule.html#properties properties] for the module such as '''help''', '''acknowledgment''' or '''categories''' can be re-implemented directly in C++ by editing <code>Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAME.cxx</code>.
 

=== 5) Open Qt Designer using the launcher ===
''Slicer'' (the launcher) searches Qt Designer on your machine (using <code>QT_QMAKE_EXECUTABLE</code> set at configure time). It starts the designer after setting the correct environment variables (<code>QT_PLUGIN_PATH</code> for the widgets designer plugins and PATH/LD_LIBRARY_PATH for the libraries).
$ ./Slicer --designer
 

=== 6) Change the UI ===
Using Qt Designer, edit the module UI file: <code>Modules/Loadable/MY_MODULE_NAME/Resources/UI/qSlicerMY_MODULE_NAMEModule.ui</code> 
[[Slicer4:Developers:Projects:QtSlicer/Tutorials/QtDesigner|More info on how to use the designer]]
 

=== 7) Edit the module files ===
Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAME.[h|cxx]
Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAMEWidget.[h|cxx]
Slicer4/Modules/Loadable/MY_MODULE_NAME/Logic/vtkSlicerMY_MODULE_NAMELogic.[h|cxx]
...
 

= Qt Designer =
* How to set icons to widgets
** In the icon property entry of the widget (Property Editor), select a resource file
*** Slicer4/Modules/Loadable/MY_MODULE_NAME/Resources/qSlicerMY_MODULE_NAMEModule.qrc
*** Slicer4/Libs/MRML/Widgets/Resources/qMRMLWidget.qrc
*** Slicer4/Base/QTGUI/Resources/qSlicerBaseQTGUI.qrc
* How to add an icon in a resource file
** Add the icon in Slicer4/Modules/Loadable/MY_MODULE_NAME/Resources/Icon
** Edit the resource file by adding the line
*** "<file>Icons/MyIcon.png</file>"

= Dependency between modules =
It is possible that your module needs to access information from another module. Typically the logic or the custom MRML classes of a module.
The following code is an example of what can be done to make your module dependent to the Volumes module logic:

In CMakeLists.txt:
set(qt_module_include_directories
${CMAKE_CURRENT_SOURCE_DIR}/Widgets
${CMAKE_CURRENT_BINARY_DIR}/Widgets
${vtkSlicerVolumesModuleLogic_SOURCE_DIR}
${vtkSlicerVolumesModuleLogic_BINARY_DIR}
)
...
set(qt_module_target_libraries
...
vtkSlicerVolumesModuleLogic
)

In qSlicerMY_MODULE_NAMEModule.cxx:

QStringList qSlicerMY_MODULE_NAMEModule::dependencies()const
{
return QStringList() << "Volumes";
}

void qSlicerMY_MODULE_NAMEModule::setup()
{
this->Superclass::setup();

vtkSlicerMY_MODULE_NAMELogic* moduleLogic =
vtkSlicerMY_MODULE_NAMELogic::SafeDownCast(this->logic());

qSlicerAbstractCoreModule* volumesModule =
qSlicerCoreApplication::application()->moduleManager()->module("Volumes");
if (volumesModule)
{
vtkSlicerVolumesLogic* volumesLogic =
vtkSlicerVolumesLogic::SafeDownCast(volumesModule->logic());
moduleLogic->SetVolumesLogic(volumesLogic);
}

By specifying the module as a dependency, you are insured that the dependency module will be setup before your module is setup.

Follow the same pattern in CMakeLists.txt to add dependency on a module widgets:
set(qt_module_include_directories
...
${qSlicerVolumesModuleWidgets_SOURCE_DIR}
${qSlicerVolumesModuleWidgets_BINARY_DIR}
...
)
...
set(qt_module_target_libraries
...
qSlicerVolumesModuleWidgets
)

It works the same if you want to access the custom MRML (''vtkSlicerDEPENDENT_MODULEModuleMRML_SOURCE_DIR'') or displayable manager (''vtkSlicerDEPENDENT_MODULEModuleDisplayableManager_SOURCE_DIR'') classes.

== Examples ==
# [[Documentation/{{documentation/version}}/Modules/CropVolume|Crop Volume]] module [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/CropVolume/qSlicerCropVolumeModule.cxx?view=markup depends on] [[Documentation/{{documentation/version}}/Modules/Volumes|Volumes]] module

Documentation/4.1/Developers/Tutorials/CreateLoadableModule

2012-06-09T01:14:20Z

Ungi: /* 1) Create the module directory */

=Consider also reading=
*[[Media:QtPortInSlicer.ppt|QtPortInSlicer - How to write a module]]
*[[Documentation/{{documentation/version}}/Developers/Tutorials/ExternalModuleWriting|How to write an external module]]

= Initialization =
=== 1) Create the module directory ===

Use the [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]] to generate files and directory based on a template.
{|
! style="border-bottom: 1px solid darkgrey;"| Linux
! style="border-bottom: 1px solid darkgrey;"| Mac
! style="border-bottom: 1px solid darkgrey;"| Windows
|-
| colspan=2; valign="top" |
Start terminal (<code>bash</code> or <code>Terminal.app</code>), then type the following: 
$ cd /path/to/Slicer4
$ python Utilities/Scripts/ModuleWizard.py MY_MODULE_NAME
| valign="top" |
Start <code>cmd.exe</code> terminal, then type the following (in 64-bit mode replace <code>PCbuild</code> with <code>PCbuild\amd64</code>: 
$ cd C:\path\to\Slicer4
$ ..\Slicer4-Superbuild\python-build\PCBuild\python.exe Utilities\Scripts\ModuleWizard.py MY_MODULE_NAME
|}
Replace <code>MY_MODULE_NAME</code> with the name of the module you want (e.g. <code>HelloWorld</code>) 
After running the script, a new directory <code>MY_MODULE_NAME</code> will be created in <code>Slicer4/Modules/Loadable</code>
 

=== 2) Add the module in CMake ===
Edit the file [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/CMakeLists.txt?view=markup Slicer4/Modules/Loadable/CMakeLists.txt]:
Add the name of your module at the end of the qtmodules variable assignment:
...
set(qtmodules
...
MY_MODULE_NAME
)
...
 
=== 3) Compile ===
Compile the inner build (''Slicer-build'' inside the Superbuild directory).
{|
! style="border-bottom: 1px solid darkgrey;"| Linux
! style="border-bottom: 1px solid darkgrey;"| Mac
! style="border-bottom: 1px solid darkgrey;"| Windows
|-
| colspan=2; valign="top" |
$ cd ../Slicer4-Superbuild/Slicer-build;
$ make -j4
| valign="top" |
$ cd ..\Slicer4-Superbuild\Slicer-build;
$ .\Slicer.exe --VisualStudio Slicer.sln
In Visual Studio, go to Build -> Build Solution
|}
 

=== 4) Check the module ===
Start Slicer and make sure the module is present (listed under "Module Template")
$ ./Slicer
To change the module title that shows up in Slicer, edit the file <code>Slicer4/Modules/Loadable/MY_MODULE_NAME/CMakeLists.txt</code>
set(MODULE_TITLE "Your title")
Other [http://slicer.org/doc/html/classqSlicerAbstractCoreModule.html#properties properties] for the module such as '''help''', '''acknowledgment''' or '''categories''' can be re-implemented directly in C++ by editing <code>Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAME.cxx</code>.
 

=== 5) Open Qt Designer using the launcher ===
''Slicer'' (the launcher) searches Qt Designer on your machine (using <code>QT_QMAKE_EXECUTABLE</code> set at configure time). It starts the designer after setting the correct environment variables (<code>QT_PLUGIN_PATH</code> for the widgets designer plugins and PATH/LD_LIBRARY_PATH for the libraries).
$ ./Slicer --designer
 

=== 6) Change the UI ===
Using Qt Designer, edit the module UI file: <code>Modules/Loadable/MY_MODULE_NAME/Resources/UI/qSlicerMY_MODULE_NAMEModule.ui</code> 
[[Slicer4:Developers:Projects:QtSlicer/Tutorials/QtDesigner|More info on how to use the designer]]
 

=== 7) Edit the module files ===
Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAME.[h|cxx]
Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAMEWidget.[h|cxx]
Slicer4/Modules/Loadable/MY_MODULE_NAME/Logic/vtkSlicerMY_MODULE_NAMELogic.[h|cxx]
...
 

= Qt Designer =
* How to set icons to widgets
** In the icon property entry of the widget (Property Editor), select a resource file
*** Slicer4/Modules/Loadable/MY_MODULE_NAME/Resources/qSlicerMY_MODULE_NAMEModule.qrc
*** Slicer4/Libs/MRML/Widgets/Resources/qMRMLWidget.qrc
*** Slicer4/Base/QTGUI/Resources/qSlicerBaseQTGUI.qrc
* How to add an icon in a resource file
** Add the icon in Slicer4/Modules/Loadable/MY_MODULE_NAME/Resources/Icon
** Edit the resource file by adding the line
*** "<file>Icons/MyIcon.png</file>"

= Dependency between modules =
It is possible that your module needs to access information from another module. Typically the logic or the custom MRML classes of a module.
The following code is an example of what can be done to make your module dependent to the Volumes module logic:

In CMakeLists.txt:
set(qt_module_include_directories
${CMAKE_CURRENT_SOURCE_DIR}/Widgets
${CMAKE_CURRENT_BINARY_DIR}/Widgets
${vtkSlicerVolumesModuleLogic_SOURCE_DIR}
${vtkSlicerVolumesModuleLogic_BINARY_DIR}
)
...
set(qt_module_target_libraries
...
vtkSlicerVolumesModuleLogic
)

In qSlicerMY_MODULE_NAMEModule.cxx:

QStringList qSlicerMY_MODULE_NAMEModule::dependencies()const
{
return QStringList() << "Volumes";
}

void qSlicerMY_MODULE_NAMEModule::setup()
{
this->Superclass::setup();

vtkSlicerMY_MODULE_NAMELogic* moduleLogic =
vtkSlicerMY_MODULE_NAMELogic::SafeDownCast(this->logic());

qSlicerAbstractCoreModule* volumesModule =
qSlicerCoreApplication::application()->moduleManager()->module("Volumes");
if (volumesModule)
{
vtkSlicerVolumesLogic* volumesLogic =
vtkSlicerVolumesLogic::SafeDownCast(volumesModule->logic());
moduleLogic->SetVolumesLogic(volumesLogic);
}

By specifying the module as a dependency, you are insured that the dependency module will be setup before your module is setup.

Follow the same pattern in CMakeLists.txt to add dependency on a module widgets:
set(qt_module_include_directories
...
${qSlicerVolumesModuleWidgets_SOURCE_DIR}
${qSlicerVolumesModuleWidgets_BINARY_DIR}
...
)
...
set(qt_module_target_libraries
...
qSlicerVolumesModuleWidgets
)

It works the same if you want to access the custom MRML (''vtkSlicerDEPENDENT_MODULEModuleMRML_SOURCE_DIR'') or displayable manager (''vtkSlicerDEPENDENT_MODULEModuleDisplayableManager_SOURCE_DIR'') classes.

== Examples ==
# [[Documentation/{{documentation/version}}/Modules/CropVolume|Crop Volume]] module [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/CropVolume/qSlicerCropVolumeModule.cxx?view=markup depends on] [[Documentation/{{documentation/version}}/Modules/Volumes|Volumes]] module

Documentation/4.1/Developers/Tutorials/CreateLoadableModule

2012-06-09T01:13:47Z

Ungi: /* 1) Create the module directory */

=Consider also reading=
*[[Media:QtPortInSlicer.ppt|QtPortInSlicer - How to write a module]]
*[[Documentation/{{documentation/version}}/Developers/Tutorials/ExternalModuleWriting|How to write an external module]]

= Initialization =
=== 1) Create the module directory ===

Use the [[Documentation/{{documentation/version}}/Developers/ModuleWizard|module wizard]] to generate files and directory based on a template.
{|
! style="border-bottom: 1px solid darkgrey;"| Linux
! style="border-bottom: 1px solid darkgrey;"| Mac
! style="border-bottom: 1px solid darkgrey;"| Windows
|-
| colspan=2; valign="top" |
Start terminal (<code>bash</code> or <code>Terminal.app</code>), then type the following: 
$ cd /path/to/Slicer4
$ python Utilities/Scripts/ModuleWizard.py MY_MODULE_NAME
| valign="top" |
Start <code>cmd.exe</code> terminal, then type the following (in 64-bit mode replace "PCbuild" with "PCbuild\amd64": 
$ cd C:\path\to\Slicer4
$ ..\Slicer4-Superbuild\python-build\PCBuild\python.exe Utilities\Scripts\ModuleWizard.py MY_MODULE_NAME
|}
Replace <code>MY_MODULE_NAME</code> with the name of the module you want (e.g. <code>HelloWorld</code>) 
After running the script, a new directory <code>MY_MODULE_NAME</code> will be created in <code>Slicer4/Modules/Loadable</code>
 

=== 2) Add the module in CMake ===
Edit the file [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/CMakeLists.txt?view=markup Slicer4/Modules/Loadable/CMakeLists.txt]:
Add the name of your module at the end of the qtmodules variable assignment:
...
set(qtmodules
...
MY_MODULE_NAME
)
...
 
=== 3) Compile ===
Compile the inner build (''Slicer-build'' inside the Superbuild directory).
{|
! style="border-bottom: 1px solid darkgrey;"| Linux
! style="border-bottom: 1px solid darkgrey;"| Mac
! style="border-bottom: 1px solid darkgrey;"| Windows
|-
| colspan=2; valign="top" |
$ cd ../Slicer4-Superbuild/Slicer-build;
$ make -j4
| valign="top" |
$ cd ..\Slicer4-Superbuild\Slicer-build;
$ .\Slicer.exe --VisualStudio Slicer.sln
In Visual Studio, go to Build -> Build Solution
|}
 

=== 4) Check the module ===
Start Slicer and make sure the module is present (listed under "Module Template")
$ ./Slicer
To change the module title that shows up in Slicer, edit the file <code>Slicer4/Modules/Loadable/MY_MODULE_NAME/CMakeLists.txt</code>
set(MODULE_TITLE "Your title")
Other [http://slicer.org/doc/html/classqSlicerAbstractCoreModule.html#properties properties] for the module such as '''help''', '''acknowledgment''' or '''categories''' can be re-implemented directly in C++ by editing <code>Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAME.cxx</code>.
 

=== 5) Open Qt Designer using the launcher ===
''Slicer'' (the launcher) searches Qt Designer on your machine (using <code>QT_QMAKE_EXECUTABLE</code> set at configure time). It starts the designer after setting the correct environment variables (<code>QT_PLUGIN_PATH</code> for the widgets designer plugins and PATH/LD_LIBRARY_PATH for the libraries).
$ ./Slicer --designer
 

=== 6) Change the UI ===
Using Qt Designer, edit the module UI file: <code>Modules/Loadable/MY_MODULE_NAME/Resources/UI/qSlicerMY_MODULE_NAMEModule.ui</code> 
[[Slicer4:Developers:Projects:QtSlicer/Tutorials/QtDesigner|More info on how to use the designer]]
 

=== 7) Edit the module files ===
Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAME.[h|cxx]
Slicer4/Modules/Loadable/MY_MODULE_NAME/qSlicerMY_MODULE_NAMEWidget.[h|cxx]
Slicer4/Modules/Loadable/MY_MODULE_NAME/Logic/vtkSlicerMY_MODULE_NAMELogic.[h|cxx]
...
 

= Qt Designer =
* How to set icons to widgets
** In the icon property entry of the widget (Property Editor), select a resource file
*** Slicer4/Modules/Loadable/MY_MODULE_NAME/Resources/qSlicerMY_MODULE_NAMEModule.qrc
*** Slicer4/Libs/MRML/Widgets/Resources/qMRMLWidget.qrc
*** Slicer4/Base/QTGUI/Resources/qSlicerBaseQTGUI.qrc
* How to add an icon in a resource file
** Add the icon in Slicer4/Modules/Loadable/MY_MODULE_NAME/Resources/Icon
** Edit the resource file by adding the line
*** "<file>Icons/MyIcon.png</file>"

= Dependency between modules =
It is possible that your module needs to access information from another module. Typically the logic or the custom MRML classes of a module.
The following code is an example of what can be done to make your module dependent to the Volumes module logic:

In CMakeLists.txt:
set(qt_module_include_directories
${CMAKE_CURRENT_SOURCE_DIR}/Widgets
${CMAKE_CURRENT_BINARY_DIR}/Widgets
${vtkSlicerVolumesModuleLogic_SOURCE_DIR}
${vtkSlicerVolumesModuleLogic_BINARY_DIR}
)
...
set(qt_module_target_libraries
...
vtkSlicerVolumesModuleLogic
)

In qSlicerMY_MODULE_NAMEModule.cxx:

QStringList qSlicerMY_MODULE_NAMEModule::dependencies()const
{
return QStringList() << "Volumes";
}

void qSlicerMY_MODULE_NAMEModule::setup()
{
this->Superclass::setup();

vtkSlicerMY_MODULE_NAMELogic* moduleLogic =
vtkSlicerMY_MODULE_NAMELogic::SafeDownCast(this->logic());

qSlicerAbstractCoreModule* volumesModule =
qSlicerCoreApplication::application()->moduleManager()->module("Volumes");
if (volumesModule)
{
vtkSlicerVolumesLogic* volumesLogic =
vtkSlicerVolumesLogic::SafeDownCast(volumesModule->logic());
moduleLogic->SetVolumesLogic(volumesLogic);
}

By specifying the module as a dependency, you are insured that the dependency module will be setup before your module is setup.

Follow the same pattern in CMakeLists.txt to add dependency on a module widgets:
set(qt_module_include_directories
...
${qSlicerVolumesModuleWidgets_SOURCE_DIR}
${qSlicerVolumesModuleWidgets_BINARY_DIR}
...
)
...
set(qt_module_target_libraries
...
qSlicerVolumesModuleWidgets
)

It works the same if you want to access the custom MRML (''vtkSlicerDEPENDENT_MODULEModuleMRML_SOURCE_DIR'') or displayable manager (''vtkSlicerDEPENDENT_MODULEModuleDisplayableManager_SOURCE_DIR'') classes.

== Examples ==
# [[Documentation/{{documentation/version}}/Modules/CropVolume|Crop Volume]] module [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/CropVolume/qSlicerCropVolumeModule.cxx?view=markup depends on] [[Documentation/{{documentation/version}}/Modules/Volumes|Volumes]] module