Difference between revisions of "Documentation/3.5"

From Slicer Wiki
Jump to: navigation, search
m
 
(88 intermediate revisions by 20 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 +
{{documentation/versionlist}}
 +
 +
=Main GUI=
 +
 +
==Main GUI==
 +
*[[Modules:MainApplicationGUI-Documentation-3.5| Main Application GUI]]
 +
*[[Modules:EventBindings-3.5| "Hot-keys" and Keyboard Shortcuts]]
 +
*[[Modules:DataModule-3.5| Loading Scenes and Individual Datasets through the Data Module]]
 +
*[[Modules:Loading-Data-3.5| Data Loading Details]]
 +
*[[Modules:Saving-Documentation-3.5| Saving Scenes and Data]]
 +
*[[Modules:SceneSnapshots-3.5| Creating and Restoring Scene Snapshots]]
 +
*[[Modules:ExtensionsManagementWizard-Documentation-3.5| Extensions Management Wizard]] (Terry G.)
 +
 
=Modules=
 
=Modules=
 
*Please copy the template linked below, paste it into your page and customize it with your module's information.
 
*Please copy the template linked below, paste it into your page and customize it with your module's information.
−
[[Slicer3:Module_Documentation-3.4_Template|Slicer3:Module_Documentation-3.5_Template]]
+
[[Slicer3:Module_Documentation-3.5_Template|Slicer3:Module_Documentation-3.5_Template]]
 
*See [[Documentation-3.5#Requirements for Modules|below]] for info to be put into the Help and Acknowledgment Tabs
 
*See [[Documentation-3.5#Requirements for Modules|below]] for info to be put into the Help and Acknowledgment Tabs
 
*To put your lab's logo into a module, see [[Slicer3:Execution_Model_Documentation#Adding_Module_Logos_to_Slicer3|here]]
 
*To put your lab's logo into a module, see [[Slicer3:Execution_Model_Documentation#Adding_Module_Logos_to_Slicer3|here]]
Line 14: Line 28:
 
* The module is '''feature complete''', it does everything that it advertises it can do
 
* The module is '''feature complete''', it does everything that it advertises it can do
 
* The module has a '''test'''. See [http://wiki.na-mic.org/Wiki/index.php/Slicer3:Execution_Model_Testing '''here'''] for more information.
 
* The module has a '''test'''. See [http://wiki.na-mic.org/Wiki/index.php/Slicer3:Execution_Model_Testing '''here'''] for more information.
−
* Module has '''documentation''' on the [[Documentation-3.5#Modules|Slicer wiki]]. Please use the template provided [[Documentation-3.5#Modules|'''here''']] to structure your page.  
+
* Module has '''documentation''' on the [[Documentation-3.5#Modules|Slicer wiki]]. Please use the template provided [[Documentation-3.5#Modules|'''here''']] to structure your page. Please keep in mind that our users are not computer scientists with a background in computer vision.
 
*Please add a pointer to the documentation on the Slicer wiki to the the '''Help''' tab of the module. See the '''Editor module''' in Slicer for an example.
 
*Please add a pointer to the documentation on the Slicer wiki to the the '''Help''' tab of the module. See the '''Editor module''' in Slicer for an example.
−
* The contributor (and their manager/advisor), the lab (with labs/institution logo) and the funding source (with grant number, logo optional) are listed in the '''Acknowledgment''' tab of the module. Please see the '''Models module''' for an example. The people listed in the acknowledgement will be the primary people for support and maintenance relative of the module.
+
* The contributor (and their manager/advisor), the lab (with labs/institution logo) and the funding source (with grant number, logo optional) are listed in the '''Acknowledgment''' tab of the module. Please see the '''Models module''' for an example. The people listed in the acknowledgement will be the primary people for support and maintenance relative of the module. [[Slicer3:Execution_Model_Documentation#Adding_Module_Logos_to_Slicer3|See here for more information.]]
 
** '''Style Guide:''' All acknowledgment icons should be 100x100 pixels, preferably in png format.
 
** '''Style Guide:''' All acknowledgment icons should be 100x100 pixels, preferably in png format.
 
** '''Accessing logos:''' Icons for BIRN, NAC, NA-MIC and IGT are included in Slicer3/Base/GUI//vtkSlicerBaseAcknowledgementLogoIcons.cxx/h and resources for them are in Slicer3/Base/GUI/Resources/vtkSlicerBaseAcknowledgementLogos_ImageData.h. The API for vtkSlicerModuleGUI provides access to these icons.  
 
** '''Accessing logos:''' Icons for BIRN, NAC, NA-MIC and IGT are included in Slicer3/Base/GUI//vtkSlicerBaseAcknowledgementLogoIcons.cxx/h and resources for them are in Slicer3/Base/GUI/Resources/vtkSlicerBaseAcknowledgementLogos_ImageData.h. The API for vtkSlicerModuleGUI provides access to these icons.  
 
** '''Adding logos:''' Please add additional image resources and logo icons to these files as required in order to promote shared use (and to prevent duplication in the code.)
 
** '''Adding logos:''' Please add additional image resources and logo icons to these files as required in order to promote shared use (and to prevent duplication in the code.)
 +
* Many modules are better suited to be [[Documentation-3.4#Extensions_for_Downloading|downloadable extensions]].  The same module creation guidelines apply, but the actual implementation is done outside of the slicer source code repository.
 +
* Follow [[Documentation-3.5-Rons-Rules|"Rons rules for tools"]]
 
| style="background: #e5e5e5" align="center"| Examples for the Help and  
 
| style="background: #e5e5e5" align="center"| Examples for the Help and  
 
Acknowledgment Panels
 
Acknowledgment Panels
Line 26: Line 42:
 
|}
 
|}
  
−
=List of Modules=
+
=List of Modules new to 3.5=
−
* [http://wiki.na-mic.org/Wiki/index.php/Slicer3:FourDAnalysis FourDAnalysis]
+
* [[Modules:AtlasCreator-Documentation-3.5|Atlas Creator]] (Sylvain Jaume)
−
* Utah Bspline
+
* [[Modules:MRIBiasFieldCorrection-Documentation-3.5|MRI Bias Field Correction]] (Sylvain Jaume)
−
* [http://wiki.na-mic.org/Wiki/index.php/Slicer3:Slicer-3-5-Module-PolyDataToLabelmap PolyDataToLabelmap]
+
* [[Modules:FourDImage-Documentation-3.5|4D Image (Viewer)]] (Junichi Tokuda)
−
* [http://wiki.na-mic.org/Wiki/index.php/Slicer3:FastMarchingSegmentation Fast Marching segmentation]
+
* [[Modules:FourDAnalysis-Documentation-3.5|4D Analysis (Time-intensity curve plotting and analysis)]] (Junichi Tokuda)
 +
* [[Modules:FastMarchingSegmentation-Documentation-3.5|Fast Marching segmentation]] (Andriy Fedorov)
 +
* [[Modules:GyriContourSegmentation-Documentation-3.5|Gyri Contour Segmentation]] (Peter Karasev)
 +
* [[Modules:ExtractSubvolumeROI-Documentation-3.5|Subvolume extraction with ROI widget]] (aka ExtractSubvolumeROI, CropVolume) (Andriy Fedorov)
 +
* [[Modules:RegistrationMetrics-Documentation-3.5 | Registration Metrics (HD and DSC) ]] (Haytham Elhawary)
 +
* [[Modules:Measurements-Documentation-3.5 | Measurements (rulers and angles) ]] (Nicole Aucoin)
 +
* [[Modules:RegisterImagesMultiRes-Documentation-3.5 | Affine registration ]] (Casey Goodlett)
 +
* [[Modules:CollectFiducials-Documentation-3.5 | Collect Patient Fiducials ]] (Andrew Wiles)
 +
* [[Modules:IGTToolSelector-Documentation-3.5 | IGT Tool Selector ]] (Andrew Wiles)
 +
 
 +
=List of pre-existing Modules=
 +
===Core===
 +
*[[Modules:Camera-Documentation-3.5| Camera Module]] (Sebastian Barre)
 +
*[[Modules:Welcome-Documentation-3.4| Welcome Module]] (Wendy Plesniak, Steve Pieper, Sonia Pujol, Ron Kikinis)
 +
*[[Modules:Volumes-Documentation-3.4| Volumes Module]] (Alex Yarmarkovich, Steve Pieper)
 +
**[[Modules:Volumes:Diffusion Editor-Documentation-3.4| Diffusion Editor]] (Kerstin Kessel)
 +
*[[Modules:Models-Documentation-3.4| Models Module]] (Alex Yarmarkovich)
 +
*[[Modules:Fiducials-Documentation-3.4| Fiducials Module]]  (Nicole Aucoin)
 +
*[[Modules:Data-Documentation-3.4| Data Module]] (Alex Yarmarkovich)
 +
*[[Modules:Slices-Documentation-3.4|Slices Module]] (Jim Miller)
 +
*[[Modules:Color-Documentation-3.4| Color Module]] (Nicole Aucoin)
 +
*[[Modules:Editor-Documentation-3.4| Interactive Editor]] (Steve Pieper)
 +
*[[Modules:ROIModule-Documentation-3.4|ROI Module]] (Alex Yarmarkovich)
 +
*[[Modules:VolumeRendering-Documentation-3.5| Volume Rendering Module]] (Yanling Liu, Alex Yarmarkovich)
 +
 
 +
==Specialized Modules==
 +
 
 +
Please adhere to the naming scheme for the module documentation:
 +
*[ [Modules:MyModuleNameNoSpaces-Documentation-3.5|My Module Name With Spaces] ] (First Last Name)
 +
 
 +
===Wizards===
 +
*[[Modules:ChangeTracker-Documentation-3.4|ChangeTracker]] (Andriy Fedorov)
 +
*[[Modules:IA_FEMesh-Documentation-3.4|IA FE Meshing Module]] (Vince Magnotta)
 +
===Informatics Modules===
 +
*[[Modules:FetchMI-Documentation-3.4| Fetch Medical Informatics Module]] (Wendy Plesniak)
 +
*[[Modules:QDECModule-Documentation-3.4| QDEC Module]] (Nicole Aucoin)
 +
*[[Modules:QueryAtlas-Documentation-3.4|Query Atlas Module]] (Wendy Plesniak)
 +
===Registration===
 +
*[[Slicer3:Registration|Overview of all Registration Modules ]]
 +
**[[Modules:RegisterImages-Documentation-3.5|Register Images (''Upgraded Version'')]] (Casey Goodlett, Stephen Aylward)
 +
**[[Modules:RegisterImagesMultires-Documentation-3.5|Register Images Multires]] (Casey Goodlett, Stephen Aylward)
 +
**[[Modules:FiducialRegistration-Documentation-3.5|Fiducial-Based Registration]] (Casey Goodlett)
 +
**[[Modules:Transforms-Documentation-3.4| Transforms Module]] (Alex Yarmarkovich)
 +
**[[Modules:LinearRegistration-Documentation-3.4|Linear Registration]] (Daniel Blezek)
 +
**[[Modules:AffineRegistration-Documentation-3.4|Affine Registration]]  (Daniel Blezek)
 +
**[[Modules:DeformableB-SplineRegistration-Documentation-3.4|Deformable B-Spline Registration]] (Bill Lorensen)
 +
**[[Modules:DemonsRegistration-Documentation-3.5|Demons Registration]] (Tom Vercauteren, Kilian Pohl)
 +
**[[Modules:RealignVolume-Documentation-3.4|ACPC Transform]] (Nicole Aucoin)
 +
 
 +
===Segmentation===
 +
*[[Modules:EMSegment|EM Segment]] (Sylvain Jaume, Nicolas Rannou)
 +
*[[Modules:EMSegment-Command-Line|EM Segment Command-Line]] (Brad Davis, Will Schroeder)
 +
*[[Modules:EMSegment-Simple|EM Segment Simple]] (Brad Davis, Will Schroeder)
 +
*[[Modules:EMSegment-TemplateBuilder|EM Segment Template Builder]] (Brad Davis, Will Schroeder)
 +
*[[Modules:Simple Region Growing-Documentation-3.4|Simple Region Growing]] (Jim Miller)
 +
*[[Modules:OtsuThreshold-Documentation-3.4|Otsu Threshold]] (Bill Lorensen)
 +
 
 +
===Statistics===
 +
*[[Modules:LabelStatistics-Documentation-3.4|Label Statistics]] (Steve Pieper)
 +
 
 +
===Diffusion===
 +
====DWI====
 +
*Estimation
 +
**[[Modules:DiffusionTensorEstimation-Documentation-3.4|Diffusion Tensor Estimation]] (Raul San Jose Estepar)
 +
*[[Modules:PythonExtractBaseline-Documentation-3.4|Python Extract Baseline DWI Volume]] (Julien de Siebenthal)
 +
*Filter
 +
**[[Modules:JointRicianLMMSEImageFilter-Documentation-3.4|Joint Rician LMMSE Image Filter]] (Antonio Tristán Vega, Santiago Aja Fernandez)
 +
**[[Modules:RicianLMMSEImageFilter-Documentation-3.4|Rician LMMSE Image Filter]] (Antonio Tristán Vega, Santiago Aja Fernandez, Marc Niethammer)
 +
**[[Modules:UnbiasedNonLocalMeans-Documentation-3.4|Unbiased Non Local Means filter for DWI]]  (Antonio Tristán Vega, Santiago Aja Fernandez)
 +
*[[Modules:ShiftDWIValues-Documentation-3.4|Python Shift DWI Values]] (Julien de Siebenthal)
 +
*[[Modules:RecenterScalar2DWI-Documentation-3.4|Python Recenter Scalar to DWI Volume]] (Julien de Siebenthal)
 +
 
 +
====DTI====
 +
*[[Modules:ResampleDTIVolume-Documentation-3.4|Resample DTI Volume]] (Francois Budin)
 +
*[[Modules:DiffusionTensorScalarMeasurements-Documentation-3.4 | Diffusion Tensor Scalar Measurements]] (Raul San Jose Estepar)
 +
*Analysis
 +
 
 +
===Tractography===
 +
*[[Modules:ROISeeding-Documentation-3.4 | Label Seeding]] (Raul San Jose Estepar)
 +
*[[Modules:FiducialSeeding-Documentation-3.4|Fiducial Seeding]] (Alex Yarmakovich, Steve Pieper)
 +
*[[Modules:DTIDisplay-Documentation-3.4|FiberBundles]] (Alex Yarmakovich)
 +
*[[Modules:StochasticTractography-Documentation-3.4|Python Stochastic Tractography]] (Julien de Siebenthal)
 +
*[[Modules:ROISelect-Documentation-3.5|ROI Select]] (Lauren O'Donnell)
 +
 
 +
===IGT===
 +
*[[Modules:OpenIGTLinkIF-Documentation-3.4| OpenIGTLinkIF Module]] (Junichi Tokuda)
 +
*[[Modules:NeuroNav-Documentation-3.4| NeuroNav Module]] (Haiying Liu)
 +
*[[Modules:ProstateNav-Documentation-3.4| ProstateNav Module]] (Junichi Tokuda)
 +
===Filtering===
 +
*[[Modules:CheckerboardFilter-Documentation-3.4|Checkerboard Filter]] (Bill Lorensen)
 +
*[[Modules:HistogramMatching-Documentation-3.4|Histogram Matching]] (Bill Lorensen)
 +
*[[Modules:ImageLabelCombine-3.4|Image Label Combine]] (Alex Yarmarkovich)
 +
*[[Modules:ResampleVolume-Documentation-3.4|Resample Volume]] (Bill Lorensen)
 +
*[[Modules:ResampleVolume2-Documentation-3.4|Resample Volume2]] (Francois Budin)
 +
*[[Modules:ThresholdImage-Documentation-3.4|Threshold Image]] (Nicole Aucoin)
 +
*Arithmetic
 +
**[[Modules:AddImages-Documentation-3.4|Add Images]] (Bill Lorensen)
 +
**[[Modules:SubtractImages-Documentation-3.4|Subtract Images]] (Bill Lorensen)
 +
** [[Modules:CastImage-Documentation-3.4|Cast Image]] (Nicole Aucoin)
 +
** [[Modules:MaskImage-Documentation-3.4|Mask Image]] ( )
 +
*Denoising
 +
**[[Modules:GradientAnisotropicFilter-Documentation-3.4| Gradient Anisotropic Filter]]  (Bill Lorensen checked this in)
 +
**[[Modules:CurvatureAnisotropicDiffusion-Documentation-3.4|Curvature Anisotropic Diffusion]] (Bill Lorensen)
 +
**[[Modules:GaussianBlur-Documentation-3.4|Gaussian Blur]] (Julien Jomier, Stephen Aylward)
 +
**[[Modules:MedianFilter-Documentation-3.4|Median Filter]] (Bill Lorensen)
 +
*Morphology
 +
**[[Modules:VotingBinaryHoleFilling-Documentation-3.4|Voting Binary Hole Filling]] (Bill Lorensen)
 +
**[[Modules:GrayscaleFillHole-Documentation-3.4|Grayscale Fill Hole]] (Bill Lorensen)
 +
**[[Modules:GrayscaleGrindPeak-Documentation-3.4|Grayscale Grind Peak]] (Bill Lorensen)
 +
 
 +
===Surface Models===
 +
*[[Modules:Model_Maker-Documentation-3.4| Modelmaker]] (Nicole Aucoin)
 +
*Grayscale Model Maker (Bill Lorensen)
 +
 
 +
*Freesurfer Surface Section Extraction (Katharina Quintus)
 +
*[[Modules:PythonSurfaceConnectivity-Documentation-3.4| Python Surface Connectivity]] (Luca Antiga, Daniel Blezek)
 +
*[[Modules:PythonSurfaceICPRegistration-Documentation-3.4| Python Surface ICP Registration]] (Luca Antiga, Daniel Blezek)
 +
*[[Modules:PythonSurfaceToolbox-Documentation-3.4| Python Surface Toolbox]] (Luca Antiga, Daniel Blezek)
 +
*[[Modules:ClipModel-Documentation-3.4| Clip Model]] (Alex Yarmarkovich)
 +
*[[Slicer3:Model_Into_Label_Volume_Documentation-3.4| Model into Label Volume]] (Nicole Aucoin)
 +
 
 +
===Batch processing===
 +
*[[Modules:EMSegmentBatch-Documentation-3.4|EM Segmenter batch]] (Julien Jomier, Brad Davis)
 +
*[[Modules:GaussianBlurBatch-Documentation-3.4|Gaussian Blur batch]] (Julien Jomier, Stephen Aylward)
 +
*[[Modules:RegisterImagesBatch-Documentation-3.4|Register Images batch]] (Julien Finet, Stephen Aylward)
 +
*[[Modules:ResampleVolumeBatch-Documentation-3.4|Resample Volume batch]] (Julien Finet)
 +
 
 +
===Converters===
 +
*[[Modules:CreateaDicomSeries-Documentation-3.4|Create a Dicom Series]] (Bill Lorensen)
 +
*[[Modules:DicomToNRRD-3.4|Dicom to NRRD]] (Xiaodong Tao)
 +
*[[Modules:OrientImages-Documentation-3.4|Orient Images]] (Bill Lorensen)
 +
*[[Modules:PythonExplodeVolumeTransform-Documentation-3.4| Python Explode Volume Transform]] (Luca Antiga, Daniel Blezek)
 +
*[[Modules:ExtractSubvolume-Documentation-3.4| Extract Subvolume]] (Steve Pieper)
 +
 
 +
=Slicer Extensions=
 +
 
 +
==Extensions for Downloading==
 +
===Introduction===
 +
[[Image:SlicerOnNITRC2009.png|thumb|right|Slicer on NITRC]]
 +
* Slicer Extensions are a mechanism for third parties to provide modules which extend the functionality of 3d Slicer.
 +
* Some of the extensions do not use the Slicer license. Please review carefully.
 +
* For a subset of extensions, you can use the extension wizard in Slicer to find their webpages and to install/uninstall individual extensions. In case of problems with those modules, please talk directly to the developers of the extensions.
 +
* The version that is available through the extension manager is chosen by the developer of that extension 
 +
 
 +
We are using NITRC as the primary repository for contributed extensions. As a general rule, we do not test the extensions ourselves. Use them at your own risk.
 +
Click [http://www.nitrc.org/search/?type_of_search=site&q=slicer3&sa.x=30&sa.y=10&sa=Search  here] to see a listing of Slicer 3 extensions on NITRC.
 +
 
 +
[[Image:Slicer-3.4.1-extension-manager-2009-10-02.png|thumb|right|Extension manager dialog box]]
 +
To add extension modules to an installed binary of slicer:
 +
* Use the View->Extension Manager menu option
 +
* The dialog will be initialized with the URL to the extensions that have been compiled to match your binary of slicer.
 +
** '''Note''' installing extensions from a different repository URL is likely to be unstable due to platform and software version differences.
 +
** You can select a local install directory for your downloaded extensions (be sure to choose a directory with enough free space).
 +
* Select the extensions you wish to install and click to download them.  Installed extensions will be available when you restart slicer.
 +
* To turn modules on or off, you can use the Module Settings page of the View->Application Settings dialog.
 +
 
 +
 
 +
*Extensions are compiled as part of the nightly build. In order to have your extension compiled nightly and made available to end users, please contact the Slicer team. For explanations for developers see [[Slicer3:Extensions| here]]
 +
 
 +
'''Installation'''
 +
*Click on the icon to start the extensions wizard
 +
[[image:ExtensionsWizard.png|Extensions Wizard]]
 +
 
 +
===Listing of available plug-ins===
 +
* VMTK (Daniel Haehn)
 +
**You need to install the [[Modules:VMTKSlicerModule|VmtkSlicerModule]] to run any of the other three.
 +
**[[Modules:VMTKEasyLevelSetSegmentation|VMTKEasyLevelSetSegmentation]] - providing level-set segmentation of vessels, aneurysms and tubular structures using an easy interface
 +
**[[Modules:VMTKLevelSetSegmentation|VMTKLevelSetSegmentation]] - providing level-set segmentation of vessels, aneurysms and tubular structures using different algorithms
 +
**[[Modules:VMTKVesselEnhancement|VMTKVesselEnhancement]] - providing vessel enhancement filters to highlight vasculature or tubular structures
 +
 
 +
* [[Modules:EMDTIClustering-Documentation-3.5|EM DTI Clustering]] (Mahnaz Maddah)
 +
 
 +
* [[Modules:LabelDiameterEstimation-Documentation-3.5|Label Diameter Estimation]] (Andriy Fedorov)
 +
 
 +
* [[Modules:ABC-Documentation-3.5|ABC]] (Marcel Prastawa)
 +
* [[Modules:HAMMER]] (GuorongWu, XiaodongTao, JimMiller, DinggangShen)
 +
 
 +
===Extensions Contact List===
 +
This is a first pass list of extension authors; more to come!
 +
 
 +
{|
 +
|ABC                    ||      Marcel Prastawa || prastawa@sci.utah.edu
 +
|-
 +
|EMFiberClusteringModule|| Mahnaz Maddah  || maddah @nospam@ ge.com
 +
|-
 +
|BRAINSROIAuto || Greg Harris || gregory-harris @nospam@ uiowa.edu
 +
|-
 +
|Bubble Maker || Carlos Mendoza || carlos.sanchez.medoza @nospam@ gmail.com
 +
|-
 +
|Hammer Registration || Dinggang Shen || dgshen @nospam@ med.unc.edu
 +
|-
 +
|Lupus Lesion || Mark Scully    || mscully @nospam@ mrn.org
 +
|-
 +
|VmtkSlicerModule ||      Daniel Haehn    || haehn @nospam@ bwh.harvard.edu
 +
|-
 +
|Vmtkin3DSlicer ||      Daniel Haehn    || haehn @nospam@ bwh.harvard.edu
 +
|-
 +
|BRAINSFit || Eun Young Kim  || eunyoung-kim @nospam@ uiowa.edu
 +
|-
 +
|ARCTIC || Cedric Mathieu  || ced.mathieu @nospam@ gmail.com
 +
|}

Latest revision as of 07:30, 14 June 2013

Home < Documentation < 3.5


For the latest Slicer documentation, visit the read-the-docs.


Nightly 4.10 4.8 4.6 4.5 4.4 4.3 4.2 4.1 4.0 3.6 3.5 3.4 3.2 ALL VERSIONS

Main GUI

Main GUI

Modules

  • Please copy the template linked below, paste it into your page and customize it with your module's information.

Slicer3:Module_Documentation-3.5_Template

  • See below for info to be put into the Help and Acknowledgment Tabs
  • To put your lab's logo into a module, see here

Please adhere to the naming scheme for the module documentation:

  • [ [Modules:MyModuleNameNoSpaces-Documentation-3.5|My Module Name With Spaces] ] (First Last Name)

Requirements for Modules

  • The module is feature complete, it does everything that it advertises it can do
  • The module has a test. See here for more information.
  • Module has documentation on the Slicer wiki. Please use the template provided here to structure your page. Please keep in mind that our users are not computer scientists with a background in computer vision.
  • Please add a pointer to the documentation on the Slicer wiki to the the Help tab of the module. See the Editor module in Slicer for an example.
  • The contributor (and their manager/advisor), the lab (with labs/institution logo) and the funding source (with grant number, logo optional) are listed in the Acknowledgment tab of the module. Please see the Models module for an example. The people listed in the acknowledgement will be the primary people for support and maintenance relative of the module. See here for more information.
    • Style Guide: All acknowledgment icons should be 100x100 pixels, preferably in png format.
    • Accessing logos: Icons for BIRN, NAC, NA-MIC and IGT are included in Slicer3/Base/GUI//vtkSlicerBaseAcknowledgementLogoIcons.cxx/h and resources for them are in Slicer3/Base/GUI/Resources/vtkSlicerBaseAcknowledgementLogos_ImageData.h. The API for vtkSlicerModuleGUI provides access to these icons.
    • Adding logos: Please add additional image resources and logo icons to these files as required in order to promote shared use (and to prevent duplication in the code.)
  • Many modules are better suited to be downloadable extensions. The same module creation guidelines apply, but the actual implementation is done outside of the slicer source code repository.
  • Follow "Rons rules for tools"
 Examples for the Help and

Acknowledgment Panels

SlicerHelpExample.png
SlicerAcknowledgementExample.png

List of Modules new to 3.5

List of pre-existing Modules

Core

Specialized Modules

Please adhere to the naming scheme for the module documentation:

  • [ [Modules:MyModuleNameNoSpaces-Documentation-3.5|My Module Name With Spaces] ] (First Last Name)

Wizards

Informatics Modules

Registration

Segmentation

Statistics

Diffusion

DWI

DTI

Tractography

IGT

Filtering

Surface Models

  • Modelmaker (Nicole Aucoin)
  • Grayscale Model Maker (Bill Lorensen)

Batch processing

Converters

Slicer Extensions

Extensions for Downloading

Introduction

Slicer on NITRC
  • Slicer Extensions are a mechanism for third parties to provide modules which extend the functionality of 3d Slicer.
  • Some of the extensions do not use the Slicer license. Please review carefully.
  • For a subset of extensions, you can use the extension wizard in Slicer to find their webpages and to install/uninstall individual extensions. In case of problems with those modules, please talk directly to the developers of the extensions.
  • The version that is available through the extension manager is chosen by the developer of that extension

We are using NITRC as the primary repository for contributed extensions. As a general rule, we do not test the extensions ourselves. Use them at your own risk. Click here to see a listing of Slicer 3 extensions on NITRC.

Extension manager dialog box

To add extension modules to an installed binary of slicer:

  • Use the View->Extension Manager menu option
  • The dialog will be initialized with the URL to the extensions that have been compiled to match your binary of slicer.
    • Note installing extensions from a different repository URL is likely to be unstable due to platform and software version differences.
    • You can select a local install directory for your downloaded extensions (be sure to choose a directory with enough free space).
  • Select the extensions you wish to install and click to download them. Installed extensions will be available when you restart slicer.
  • To turn modules on or off, you can use the Module Settings page of the View->Application Settings dialog.


  • Extensions are compiled as part of the nightly build. In order to have your extension compiled nightly and made available to end users, please contact the Slicer team. For explanations for developers see here

Installation

  • Click on the icon to start the extensions wizard

Extensions Wizard

Listing of available plug-ins

  • VMTK (Daniel Haehn)
  • ABC (Marcel Prastawa)
  • Modules:HAMMER (GuorongWu, XiaodongTao, JimMiller, DinggangShen)

Extensions Contact List

This is a first pass list of extension authors; more to come!

ABC Marcel Prastawa prastawa@sci.utah.edu
EMFiberClusteringModule Mahnaz Maddah maddah @nospam@ ge.com
BRAINSROIAuto Greg Harris gregory-harris @nospam@ uiowa.edu
Bubble Maker Carlos Mendoza carlos.sanchez.medoza @nospam@ gmail.com
Hammer Registration Dinggang Shen dgshen @nospam@ med.unc.edu
Lupus Lesion Mark Scully mscully @nospam@ mrn.org
VmtkSlicerModule Daniel Haehn haehn @nospam@ bwh.harvard.edu
Vmtkin3DSlicer Daniel Haehn haehn @nospam@ bwh.harvard.edu
BRAINSFit Eun Young Kim eunyoung-kim @nospam@ uiowa.edu
ARCTIC Cedric Mathieu ced.mathieu @nospam@ gmail.com
Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/3.5&oldid=32447"