Difference between revisions of "Documentation/4.0"

From Slicer Wiki
Jump to: navigation, search
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(317 intermediate revisions by 20 users not shown)
Line 1: Line 1:
−
=Introduction=
+
<noinclude>{{documentation/versioncheck}}</noinclude>
 +
__NOTOC__
 +
{{documentation/versionlist}}
  
−
Slicer4 is moving towards release. This page contains both the guidelines and the dcoumentation for Slicer 4.0.
+
=Table of Content=
 +
{| border="0" align="center" width="100%" valign="top" cellspacing="7" cellpadding="2"
 +
|-
 +
! width="33%"|
 +
! |
 +
! width="33%"|
 +
! |
 +
! width="33%"|
 +
|-
 +
|valign="top"|
 +
 
 +
===Slicer Application===
 +
----
 +
*[[Documentation/{{documentation/version}}/SlicerApplication/MainApplicationGUI| Main Application GUI]]
 +
 
 +
*[[Documentation/{{documentation/version}}/SlicerApplication/MouseandKeyboardShortcuts | Mouse Buttons, "Hot-keys" and Keyboard Shortcuts]]
  
−
=Requirements for Modules=
+
*[[Documentation/{{documentation/version}}/SlicerApplication/HardwareConfiguration | '''Computer Configurations''']]
−
* The module is '''feature complete''', i.e. it does everything that it advertises
+
*[[Documentation/{{documentation/version}}/SlicerApplication/LoadingData | Loading]] or [[Documentation/{{documentation/version}}/SlicerApplication/SavingData | Saving]] data and listing of [[Documentation/{{documentation/version}}/SlicerApplication/SupportedDataFormat | supported data formats]]. (Julien Finet)
−
* The module has a '''test'''. See [http://wiki.na-mic.org/Wiki/index.php/Slicer3:Execution_Model_Testing '''here'''] for more information.
+
<!-- : scenes, DICOM, volumes, models, fiducials, transforms, etc. -->
−
* The module is fully documented. See [[Module:EndUserDocumentationTemplate-4.0|here]] for the end-user documentation template.
+
*[[Documentation/{{documentation/version}}/SlicerApplication/LookupTables | Slicer Lookup Tables]]
−
* The module complies with [[Documentation-Rons-Rules-For-Tools|Rons rules for tool]] and the style guide lines, including [[Slicer3:Human_Interface_and_Style_Guide_for_Developers#Colors:_application_palettes|color palette]].
+
*[[Documentation/{{documentation/version}}/SlicerApplication/StereoViewing | Setting up and using stereoscopic viewing]]
  
−
=Main GUI=
+
===Mailing Lists===
 +
----
 +
* [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-users Mailing list for users]
 +
:[http://slicer-users.65878.n3.nabble.com/ Search] in archives on nabble.com
 +
* [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel Mailing list for developers]
 +
:[http://slicer-devel.65872.n3.nabble.com/ Search] in archives on nabble.com
  
−
*[[Modules:MainApplicationGUI-Documentation-4.0| Main Application GUI]] (xx)
+
<!--
−
*[[Modules:EventBindings-4.0| "Hot-keys" and Keyboard Shortcuts]] (xx)
 
−
*[[Modules:Loading-Data-4.0| Loading Data]] (scenes, DICOM, volumes, models, fiducials, transforms, etc.)  (xx)
 
−
*[[Modules:Saving-Documentation-4.0| Saving Data]] (scenes, volumes, models, fiducials, transforms, etc.)  (xx)
 
−
*[[Modules:SceneSnapshots-4.0| Creating and Restoring Scene Snapshots]] (xx)
 
−
*[[Modules:StereoViewing-4.0| Setting up and using stereoscopic viewing ]] (Curt Lisle, xx)
 
 
*[[Modules:ExtensionsManagementWizard-Documentation-4.0| Extensions Management Wizard]] (xx)
 
*[[Modules:ExtensionsManagementWizard-Documentation-4.0| Extensions Management Wizard]] (xx)
 +
-->
 +
 +
|bgcolor="#CCCCCC"|
 +
|valign="top"|
 +
 +
===Module Categories ===
 +
----
 +
* [[#Core Modules|Core Modules]]
 +
* [[#Wizards|Wizards]]
 +
* [[#Informatics|Informatics]]
 +
* [[#Registration|Registration]]
 +
* [[#Segmentation|Segmentation]]
 +
* [[#Quantification|Quantification]]
 +
* [[#Diffusion|Diffusion]]
 +
* [[#IGT|IGT]]
 +
* [[#Filtering|Filtering]]
 +
* [[#Surface Models|Surface Models]]
 +
* [[#Converters|Converters]]
 +
* [[#Endoscopy|Endoscopy]]
 +
* [[#Developer Tools|Developer Tools]]
 +
* [[#Legacy|Legacy]]
 +
|bgcolor="#CCCCCC"|
 +
|valign="top"|
 +
 +
===Miscellaneous===
 +
----
 +
<!-- * [[Documentation/{{documentation/version}}/ImageGallery|Image gallery]] -->
 +
 +
* [[Slicer4:VisualBlog|Visual blog]]
 +
: Set of screenshots showing Slicer in action.
 +
 +
<!--
 +
* [[Documents and links]]
 +
: Set of presentations made on Slicer and document talking about it.
 +
 +
-->
 +
* [[Documentation/4.0/Training|Training pages]]
 +
: Information on how to use Slicer {{documentation/version}}
 +
 +
* [[Documentation/{{documentation/version}}/FAQ|FAQ]]
 +
: Set of common questions/answers
 +
 +
* [[Documentation/{{documentation/version}}/ReleaseNotes|Release Notes]]
 +
: Platform specific issues and considerations
 +
<!--
 +
* [[Documentation/{{documentation/version}}/Troubleshooting|Troubleshooting]]
 +
: Some general hints on troubleshooting,
 +
-->
 +
 +
===Developers Corner===
 +
----
 +
* [[Documentation/{{documentation/version}}/Developers | Information for Software Developers]]
 +
: Where to find the source code, how to compile ...
 +
|}
 +
 +
=General Information=
 +
{|width="100%"
 +
|rowspan="3"|
 +
{{Infobox
 +
|name        = 3D Slicer {{documentation/version}}
 +
|above        = 3D Slicer
 +
|abovestyle  =
 +
 +
|image        = [[File:3DSlicer4Logo-H-218X144.png|218px|alt=3D Slicer {{documentation/version}}]]
 +
|imagestyle  =
 +
|headerstyle  = background:#E7DCC3;
 +
|labelstyle  =
 +
|datastyle    =
  
−
=Core Modules=
+
|header1 = Description
−
*[[Modules:Annotations-Documentation-4.0| Annotations Module]] (xx)
+
|label1  =
−
*[[Modules:Colors-Documentation-4.0| Color Module]] (xx)
+
|data1  =
−
*[[Modules:Data-Documentation-4.0| Data Module]] (xx)
+
|header2 =
−
*[[Modules:Editor-Documentation-4.0|Interactive Editor]] (Steve Pieper) 
+
|label2  =  
−
*[[Modules:Sceneviews-Documentation-4.0| Sceneviews ]] (xx)
+
|data2  = Research platform for the analysis and visualization of medical images, including image guided therapy.
−
*[[Modules:SliceControls-Documentation-4.0|Slice Controls Module]] (x)
+
|header3 =
−
*[[Modules:Slicer-Welcome-Documentation-4.0| Slicer Welcome Module]] (xx)
+
|label3 =
−
*[[Modules:VolumeRendering-Documentation-4.0| Volume Rendering Module]] (xx)
+
|data3  = Free and extensible open source package.
−
*[[Modules:Volumes-Documentation-4.0| Volumes Module]] (xx)
+
|header4 =
−
*[[Modules:Transforms-Documentation-4.0| Transforms Module]] (xx)
+
|label4  = Multi-platform
 +
|data4  = Linux, MacOSX, Windows
 +
|header5 =
 +
|label5  = Version
 +
|data5  = {{documentation/version}}
 +
|header6 =
 +
|label6  = License
 +
|data6  = [http://www.slicer.org/pages/LicenseText Contribution and Software License Agreement]
 +
}}
 +
|align="center"|
 +
[[{{collaborator|logo|slicer4}}|x350px]]  
 +
|-
 +
|
 +
{{ombox
 +
|type=content
 +
|text=The {{documentation/version}} release of 3D Slicer contains significant changes both to the organization of the software and to the functionality. Please check the [[Documentation/{{documentation/version}}/Announcements | Announcement]] page for more details. The community contributing to Slicer {{documentation/version}} is acknowledged [http://www.slicer.org/pages/Acknowledgments here].
 +
}}
 +
|-
 +
<!--|
 +
{{ombox | text = For information on how to obtain Slicer {{documentation/version}} please go to the [[Snapshots|Download Pages]]. }}-->
 +
|}
  
 
=Modules by Category=
 
=Modules by Category=
−
==Filtering==
+
==Core Modules==
 +
*[[Documentation/{{documentation/version}}/Modules/Annotations|Annotations]] (Nicole Aucoin)
 +
*[[Documentation/{{documentation/version}}/Modules/Colors|Colors]] (Nicole Aucoin)
 +
*[[Documentation/{{documentation/version}}/Modules/Data|Data]] (Julien Finet)
 +
*[[Documentation/{{documentation/version}}/Modules/DICOM|DICOM]] (Steve Pieper)
 +
*[[Documentation/{{documentation/version}}/Modules/Editor|Editor]] (Steve Pieper)
 +
*[[Documentation/{{documentation/version}}/Modules/Models|Models]] (Nicole Aucoin)
 +
*[[Documentation/{{documentation/version}}/Modules/SceneViews|SceneViews]] (Nicole Aucoin)
 +
*[[Documentation/{{documentation/version}}/Modules/Transforms|Transforms]] (Alex Yarmarkovich)
 +
*[[Documentation/{{documentation/version}}/Modules/ViewControllers|View Controllers]] (Jim Miller)
 +
*[[Documentation/{{documentation/version}}/Modules/Volumes|Volumes]] (Steve Pieper)
 +
*[[Documentation/{{documentation/version}}/Modules/VolumeRendering|Volume Rendering]] (Julien Finet)
 +
*[[Documentation/{{documentation/version}}/Modules/SlicerWelcome|Welcome to Slicer]] (Wendy Plesniak)
 +
 
 +
==Wizards==
 +
*[[Documentation/{{documentation/version}}/Modules/ChangeTracker|ChangeTracker]] (Andrey Fedorov)
 +
 
 +
==Informatics==
 +
*[[Documentation/{{documentation/version}}/Modules/SampleData|Sample Data]] (Steve Pieper)
 +
 
 
==Registration==
 
==Registration==
 +
*[[Documentation/4.0/Modules/BRAINSFit|General Brainsfit Registration]] (Hans Johnson)
 +
*[[Documentation/4.0/Modules/BRAINSResample|Resample Image (BRAINS)]] (Hans Johnson)
 +
*Specialized
 +
**[[Documentation/4.0/Modules/ACPCTransform|ACPC Transform]] (Nicole Aucoin)
 +
**[[Documentation/4.0/Modules/BRAINSDemonWarp|Demon Registration (BRAINS)]] (Hans Johnson)
 +
**[[Documentation/4.0/Modules/FiducialRegistration|Fiducial Registration]] (Stephen Aylward)
 +
**Vector Demon Registration (Hans Johnson)
 +
**[[Documentation/4.0/Modules/Reformat|Reformat]] (Michael Jeulin-Lagarrigue)
 +
 
==Segmentation==
 
==Segmentation==
 +
*[[Documentation/4.0/Modules/EMSegment Easy|EMSegment Easy (no atlas)]] (Kilian Pohl)
 +
*[[Documentation/4.0/Modules/EMSegmenter|EMSegment (with atlas)]] (Kilian Pohl)
 +
*[[Documentation/4.0/Modules/SimpleRegionGrowingSegmentation|Simple Region Growing Segmentation]] (Jim Miller, Harini Veeraraghavan)
 +
*Specialized
 +
**[[Documentation/4.0/Modules/EMSegment Command-line | EMSegment Command-line]] (Kilian Pohl)
 +
**[[Documentation/4.0/Modules/ForegroundMasking|Foreground Masking (BRAINS)]] (Hans Johnson)
 +
**[[Documentation/4.0/Modules/MeshContourSegmentation|Mesh Contour Segmentation]] (Allen Tannenbaum) 
 +
**[[Documentation/4.0/Modules/RobustStatisticsSegmenter|Robust Statistics Segmenter]] (Yi Gao)
 +
 +
==Quantification==
 +
*[[Documentation/{{documentation/version}}/Modules/DataProbe|Data Probe]] (Steve Pieper)
 +
*[[Documentation/4.0/Modules/LabelStatistics|Label Statistics]] (Steve Pieper)
 +
*[[Documentation/4.0/Modules/PETStandardUptakeValueComputation|PET Standard Uptake Value Computation]] (Nicole Aucoin)
 +
* Change quantification
 +
** [[Documentation/4.0/Modules/IntensityDifferenceMetric|Intensity Difference Metric]] (Andrey Fedorov)
 +
 +
==Diffusion==
 +
*DWI to Full Brain Tractography (Demian Wasserman)
 +
*Denoising
 +
**[[Documentation/4.0/Modules/DWIJointRicianLMMSEFilter|DWI Joint Rician LMMSE Image Filter]] (Demian Wasserman)
 +
**[[Documentation/4.0/Modules/DWIRicianLMMSEFilter|DWI Rician LMMSE Filter]] (Demian Wasserman)
 +
*Tractography
 +
**[[Documentation/4.0/Modules/TractographyDisplay|Tractography Display]] (Demian Wasserman)
 +
**[[Documentation/4.0/Modules/TractographyFiducialSeeding|Tractography Fiducial Seeding]] (Demian Wasserman)
 +
**[[Documentation/4.0/Modules/TractographyLabelMapSeeding|Tractography Label Map Seeding]] (Demian Wasserman)
 +
*Utilities
 +
**[[Documentation/4.0/Modules/DWIToDTIEstimation|DWI To DTI Estimation]] (Demian Wasserman)
 +
**[[Documentation/4.0/Modules/DiffusionTensorScalarMeasurements|Diffusion Tensor Scalar Measurements]] (Demian Wasserman)
 +
**[[Documentation/4.0/Modules/DiffusionWeightedVolumeMasking|Diffusion Weighted Volume Masking]] (Demian Wasserman)
 +
**[[Documentation/4.0/Modules/ResampleDTIVolume|Resample DTI Volume]] (Demian Wasserman)
 +
 +
==IGT==
 +
*[[Documentation/4.0/Modules/OpenIGTLinkIF| OpenIGTLink IF]] (Junichi Tokuda)
 +
 +
==Filtering==
 +
*[[Documentation/4.0/Modules/N4ITKBiasFieldCorrection | N4ITK Bias Field Correction]] (Andrey Fedorov)
 +
*[[Documentation/4.0/Modules/CheckerBoardFilter|CheckerBoard Filter]] (Jim Miller)
 +
*[[Documentation/4.0/Modules/ExtractSkeleton|Extract Skeleton]] (Jim Miller)
 +
*[[Documentation/4.0/Modules/HistogramMatching|Histogram Matching]] (Jim Miller)
 +
*[[Documentation/4.0/Modules/ImageLabelCombine|Image Label Combine]] (Alex Yarmarkovich)
 +
*[[Documentation/4.0/Modules/ResampleScalarVectorDWIVolume|Resample Scalar/Vector/DWI Volume]] (Francois Budin)
 +
*[[Documentation/4.0/Modules/ThresholdScalarVolume|Threshold Scalar Volume]] (Nicole Aucoin)
 +
*[[Documentation/4.0/Modules/VotingBinaryHoleFillingImageFilter|Voting Binary Hole Filling Image Filter]] (Jim Miller)
 +
*Arithmetic
 +
**[[Documentation/4.0/Modules/AddScalarVolumes|Add Scalar Volumes]] (Jim Miller)
 +
**[[Documentation/4.0/Modules/CastScalarVolume| Cast Scalar Volume]] (Nicole Aucoin)
 +
**[[Documentation/4.0/Modules/MaskScalarVolume| Mask Scalar Volume]] (Nicole Aucoin)
 +
**[[Documentation/4.0/Modules/MultiplyScalarVolumes| Multiply Scalar Volumes]] (Jim Miller)
 +
**[[Documentation/4.0/Modules/SubtractScalarVolumes| Subtract Scalar Volumes]] (Jim Miller)
 +
*Denoising
 +
**[[Documentation/4.0/Modules/GradientAnisotropicDiffusion |Gradient Anisotropic Diffusion]] (Jim Miller) 
 +
**[[Documentation/4.0/Modules/CurvatureAnisotropicDiffusion|Curvature Anisotropic Diffusion]] (Jim Miller)
 +
**[[Documentation/4.0/Modules/GaussianBlurImageFilter|Gaussian Blur Image Filter]] (Stephen Aylward)
 +
**[[Documentation/4.0/Modules/MedianImageFilter|Median Image Filter]] (Jim Miller)
 +
*Morphology
 +
**[[Documentation/4.0/Modules/GrayscaleFillHoleImageFilter|Grayscale Fill Hole Image Filter]] (Jim Miller)
 +
**[[Documentation/4.0/Modules/GrayscaleGrindPeakImageFilter|GGrayscale Grind Peak Image Filter]] (Jim Miller)
 +
 +
==Surface Models==
 +
*[[Documentation/4.0/Modules/GrayscaleModelMaker| Grayscale Model Maker]] (Jim Miller)
 +
*[[Documentation/4.0/Modules/LabelMapSmoothing|Label Map Smoothing]]
 +
*[[Documentation/4.0/Modules/MergeModels| Merge Models]] (Nicole Aucoin)
 +
*[[Documentation/4.0/Modules/ModelMaker| Model Maker]] (Nicole Aucoin)
 +
*[[Documentation/4.0/Modules/ModelToLabelMap| Model To LabelMap]] (Nicole Aucoin)
 +
*[[Documentation/4.0/Modules/ProbeVolumeWithModel| Probe Volume With Model]] (Lauren O'Donnell)
 +
 
==Converters==
 
==Converters==
 +
*[[Documentation/4.0/Modules/CreateDICOMSeries|Create DICOM Series]] (Jim Miller)
 +
*[[Documentation/4.0/Modules/Crop Volume|Crop Volume]] (Andrey Fedorov)
 +
*[[Documentation/4.0/Modules/DicomToNrrdConverter|Dicom to Nrrd Converter]] (Jim Miller)
 +
*[[Documentation/4.0/Modules/OrientScalarVolume| Orient Scalar Volume]] (Jim Miller)
 +
 +
==Endoscopy==
 +
*[[Documentation/4.0/Modules/Endoscopy|Endoscopy]] (Steve Pieper)
 +
 +
==Developer Tools==
 +
*[[Documentation/4.0/Modules/Cameras|Cameras]] (Julien Finet)
 +
*[[Documentation/4.0/Modules/EventBroker|Event Broker]] (Julien Finet)
 +
*[[Documentation/4.0/Modules/ExecutionModelTour |Execution Model Tour]] (JC Fillion-Robin) 
 +
*[[Documentation/4.0/Modules/YOURMODULENAME|Module Template]] (JC Fillion-Robin)
 +
*Performance Tests
 +
*Tractography
 +
 +
==Legacy==
 +
*Converters
 +
**[[Documentation/4.0/Modules/BSplineToDeformationField|BSpline To Deformation Field]]
 +
*Diffusion
 +
**Denoising
 +
***[[Documentation/4.0/Modules/DWIUnbiasedNonLocalMeansFilter|DWI Unbiased Non Local Means Filter]]
 +
*Filtering
 +
**[[Documentation/4.0/Modules/MRIBiasFieldCorrection|MRI Bias Field Correction]] (Sylvain Jaume)
 +
**[[Documentation/4.0/Modules/OtsuThresholdImageFilter|Otsu Threshold Image Filter]] (Bill Lorensen)
 +
**[[Documentation/4.0/Modules/ResampleScalarVolume|Resample Scalar Volume]] (Jim Miller)
 +
*Registration
 +
**[[Documentation/4.0/Modules/RigidRegistration|Rigid Registration]] (Jim Miller) 
 +
**[[Documentation/4.0/Modules/AffineRegistration|Affine Registration]] (Daniel Blezek)
 +
**[[Documentation/4.0/Modules/BSplineDeformableRegistration|BSpline Deformable Registration]]
 +
**[[Documentation/4.0/Modules/ExpertAutomatedRegistration|Expert Automated Registration]]
 +
**[[Documentation/4.0/Modules/LinearRegistration|Linear Registration]]
 +
**[[Documentation/4.0/Modules/MultiResolutionAffineRegistration|MultiResolution Affine Registration]]
 +
<!--
 +
**[[Documentation/4.0/Modules/TestGridTransformRegistration|Test Grid Transform Registration]]
 +
-->
 +
*Segmentation
 +
**[[Documentation/4.0/Modules/OtsuThresholdSegmentation|Otsu Threshold Segmentation]] (Bill Lorensen)
  
 
=Extensions=
 
=Extensions=
−
 
  
 
'''Introduction'''
 
'''Introduction'''
  
−
* Slicer Extensions are the "on-ramp" to the Slicer "highway". They provide are a mechanism for anybody, including third parties, to provide modules which extend the functionality of 3d Slicer.
+
* Slicer Extensions are the "on-ramp" to the Slicer "highway". slicer Extensions provide a voluntary mechanism for anybody, including third parties, to extend the functionality of 3d Slicer.
−
* Beginning with Slicer 4, the process for adding modules to slicer will begin with all modules as extensions. In order to become part of the main slicer distribution, extensions will have to be distributed under the slicer license, live up to the claims in the documentation, being stable on the supported platforms, well documented and supported.
+
* While the '''Slicer license''' is suggested for extensions, it is '''not required'''. Please review the documentation of the extension carefully as some extensions might have a "non-Slicer" license.
−
*'''While the Slicer license is suggested for extensions, it is '''not required'''. Please review the documentation of the extension carefully.'''
 
 
* For a subset of extensions, you can use the extension wizard in Slicer to find their webpages and to install/uninstall individual extensions.  
 
* 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 extensions, please talk directly to the developers of the extensions.
 
* In case of problems with extensions, please talk directly to the developers of the extensions.
−
* Information for developers can be found [[Slicer4:Extensions|here]].
+
* Information for developers can be found [[Slicer4:Extensions|here]]. See [[Module:EndUserDocumentationTemplate-4.0|here]] for the end-user documentation template.
 +
* In Slicer 4, all new modules will begin as "Immature Extensions". They will progress to the status of "Mature Extensions", when they meet all the criteria listed below. In order to become part of the main Slicer distribution a discussion with the Slicer core team will have to be initiated after reaching the mature extension status. While extensions can be made available under many licenses, the main Slicer distribution will contain ONLY code under the slicer license, with no known IP liabilities.
 +
 
 +
==Collections==
 +
Collections are groups of extensions that can be downloaded in a single operation. You can think of them as the equivalent to a playlist.
 +
 
 +
{| class="wikitable sortable labelpage labelpagetable" border="1"
 +
|-
 +
! id
 +
! Thumbnail
 +
! Name
 +
! Short Description
 +
! Maturity
 +
! Slicer License
 +
! Search terms
 +
! Contact Information
 +
|-
 +
| 1
 +
| [[Image:Slicervmtk logo.png|60px|lleft|Replace the image with your image, replace the generic documentation link with a link to your documentation|link=Module:EndUserDocumentationTemplate-4.0]]
 +
| MyCollection
 +
| This is a collection of extensions that will do something miraculous with your images
 +
| [[File:StableExtensionIcon.png|80px]]
 +
| [[File:SlicerLicenseIcon.png|80px]]
 +
| segmentation, level set
 +
| my-email at mit.edu
 +
|-
 +
|}
 +
 
 +
 
  
−
'''Defintion of Terms'''
 
−
<gallery heights="50px" perrow="4">
 
−
Image:SlicerLicenseIcon.png‎| Distributed under the Slicer License
 
−
Image:NoSlicerLicenseIcon.png| Distributed under a Non Slicer License
 
−
Image:ExperimentalExtensionIcon.png| Immature extension. Use with care, might not be available for all platforms
 
−
Image:StableExtensionIcon.png| Full documentation, compiles on all platforms for the latest stable release
 
−
</gallery>
 
  
−
'''Table'''
+
==Table Of Extensions==
 
{| class="wikitable sortable labelpage labelpagetable" border="1"
 
{| class="wikitable sortable labelpage labelpagetable" border="1"
 
|-
 
|-
Line 66: Line 322:
 
! Maturity
 
! Maturity
 
! Slicer License
 
! Slicer License
−
! URL
+
! Search terms
 
! Contact Information
 
! Contact Information
 
|-
 
|-
 
| 1
 
| 1
−
| [[Image:xxx.png|60px|lleft|Short description of the image here|link=Link to the documentation page]]  
+
| [[Image:SkullStripperSurface-3-6.png|60px|lleft|Replace the image with your image, replace the generic documentation linke with a link to your documentation|link=Module:EndUserDocumentationTemplate-4.0]]  
 
| MyExtension
 
| MyExtension
−
| This is an extension that will do something wonderful
+
| This is an extension that will do something wonderful with your data
 
| [[File:ExperimentalExtensionIcon.png|80px]]
 
| [[File:ExperimentalExtensionIcon.png|80px]]
 
| [[File:NoSlicerLicenseIcon.png|80px]]
 
| [[File:NoSlicerLicenseIcon.png|80px]]
−
| [[Module:EndUserDocumentationTemplate-4.0|This is the end-user documentaiton for this extension]]
+
| filter, anisotropic
 
| my-email at gmail.com
 
| my-email at gmail.com
 
|-
 
|-
 
| 2
 
| 2
−
| [[Image:xxx.png|60px|lleft|Short description of the image here|link=Link to the documentation page]]  
+
| [[Image:Slicervmtk logo.png|60px|lleft|Replace the image with your image, replace the generic documentation linke with a link to your documentation|link=Module:EndUserDocumentationTemplate-4.0]]  
 
| MyExtension
 
| MyExtension
−
| This is an extension that will do something wonderful
+
| This is an extension that will do something miraculous with your images
 
| [[File:StableExtensionIcon.png|80px]]
 
| [[File:StableExtensionIcon.png|80px]]
 
| [[File:SlicerLicenseIcon.png|80px]]
 
| [[File:SlicerLicenseIcon.png|80px]]
−
| [[Module:EndUserDocumentationTemplate-4.0|This is the end-user documentaiton for this extension]]
+
| segmentation, level set
 
| my-email at mit.edu
 
| my-email at mit.edu
 
|-
 
|-
 
|}
 
|}
 +
 +
 +
 +
'''Caption for the table of extensions'''
 +
<gallery heights="50px" perrow="4">
 +
Image:SlicerLicenseIcon.png‎| Distributed under the [http://www.slicer.org/pages/LicenseText Slicer License]
 +
Image:NoSlicerLicenseIcon.png| Distributed under a Non Slicer License
 +
Image:ExperimentalExtensionIcon.png|Work in progress (aka mess)<br>Use with care<br>Might not work all the time<br>Might not be available for all platforms
 +
Image:StableExtensionIcon.png|Stable <br>Full documentation <br>Works as advertised <br>Compiles on all supported platforms<br>Email support works
 +
</gallery>

Latest revision as of 07:36, 14 June 2013

Home < Documentation < 4.0


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

Table of Content

Slicer Application

Mailing Lists

Search in archives on nabble.com
Search in archives on nabble.com

Module Categories

Miscellaneous

Set of screenshots showing Slicer in action.
Information on how to use Slicer 4.0
Set of common questions/answers
Platform specific issues and considerations

Developers Corner

Where to find the source code, how to compile ...

General Information

3D Slicer
3D Slicer 4.0
Description
Research platform for the analysis and visualization of medical images, including image guided therapy.
Free and extensible open source package.
Multi-platform Linux, MacOSX, Windows
Version 4.0
License Contribution and Software License Agreement
v · d · e

Slicer4Announcement-HiRes.png

The 4.0 release of 3D Slicer contains significant changes both to the organization of the software and to the functionality. Please check the Announcement page for more details. The community contributing to Slicer 4.0 is acknowledged here.

Modules by Category

Core Modules

Wizards

Informatics

Registration

Segmentation

Quantification

Diffusion

IGT

Filtering

Surface Models

Converters

Endoscopy

Developer Tools

Legacy

Extensions

Introduction

  • Slicer Extensions are the "on-ramp" to the Slicer "highway". slicer Extensions provide a voluntary mechanism for anybody, including third parties, to extend the functionality of 3d Slicer.
  • While the Slicer license is suggested for extensions, it is not required. Please review the documentation of the extension carefully as some extensions might have a "non-Slicer" license.
  • 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 extensions, please talk directly to the developers of the extensions.
  • Information for developers can be found here. See here for the end-user documentation template.
  • In Slicer 4, all new modules will begin as "Immature Extensions". They will progress to the status of "Mature Extensions", when they meet all the criteria listed below. In order to become part of the main Slicer distribution a discussion with the Slicer core team will have to be initiated after reaching the mature extension status. While extensions can be made available under many licenses, the main Slicer distribution will contain ONLY code under the slicer license, with no known IP liabilities.

Collections

Collections are groups of extensions that can be downloaded in a single operation. You can think of them as the equivalent to a playlist.

id Thumbnail Name Short Description Maturity Slicer License Search terms Contact Information
1 Replace the image with your image, replace the generic documentation link with a link to your documentation MyCollection This is a collection of extensions that will do something miraculous with your images StableExtensionIcon.png SlicerLicenseIcon.png segmentation, level set my-email at mit.edu



Table Of Extensions

id Thumbnail Name Short Description Maturity Slicer License Search terms Contact Information
1 Replace the image with your image, replace the generic documentation linke with a link to your documentation MyExtension This is an extension that will do something wonderful with your data ExperimentalExtensionIcon.png NoSlicerLicenseIcon.png filter, anisotropic my-email at gmail.com
2 Replace the image with your image, replace the generic documentation linke with a link to your documentation MyExtension This is an extension that will do something miraculous with your images StableExtensionIcon.png SlicerLicenseIcon.png segmentation, level set my-email at mit.edu


Caption for the table of extensions

  • Distributed under the Slicer License

  • Distributed under a Non Slicer License

  • Work in progress (aka mess)
    Use with care
    Might not work all the time
    Might not be available for all platforms

  • Stable
    Full documentation
    Works as advertised
    Compiles on all supported platforms
    Email support works

Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/4.0&oldid=32583"