Difference between revisions of "Documentation"

From Slicer Wiki
Jump to: navigation, search
Tag: 2017 source edit
 
(83 intermediate revisions by 9 users not shown)
Line 1: Line 1:
−
=Introduction=
+
<noinclude>{{documentation/versioncheck}}</noinclude>
−
[[Image:Base-Features-and-Modules.png|thumb|right|overview]]
+
__NOTOC__
−
This page is a portal for documentation about Slicer 3.
 
−
For information for software developers, please go to the Developers page (see link in navigation box to the left).
 
  
−
*With the distribution of slicer3 there will be a set of bundled modules to get people started.  The exact composition of the bundled modules hasn't been finalized, but it will be similar to the current set of modules that are built in.  There may be different application-specific bundles that can optionally be loaded.  E.g. a registration bundle, an IGT bundle, a diffusion bundle, etc.
+
{{Infobox
 +
|name        = 3D Slicer {{documentation/version}}
 +
|above        = 3D Slicer
 +
|abovestyle  =
  
−
=How-To Tutorials=
+
|image        = [[File:3DSlicer41Logo-H-218X144.png|218px|alt=3D Slicer {{documentation/version}}]]
−
[http://wiki.na-mic.org/Wiki/index.php/Slicer3:Training Slicer3 tutorial page]
+
|imagestyle  =
 +
|headerstyle  = background:#E7DCC3;
 +
|labelstyle  =
 +
|datastyle    =
  
−
=Main GUI=
+
|header1 = Description
−
*[[Modules:MainApplicationGUI-Documentation| Main Application GUI]]
+
|label1  =
−
*[[Slicer3:EventBindings| List of Hotkeys and Keyboard Shortcuts]]
+
|data1  =
−
*[[Modules:Loading-Data| How to load data]]
+
|header2 =
−
*[[Modules:Saving-Documentation| Save Scene and Data Module]]
+
|label2  =
 +
|data2  = Research platform for the analysis and visualization of medical images, including image guided therapy.
 +
|header3 =
 +
|label3  =
 +
|data3  = Free and extensible open source package.
 +
|header4 =
 +
|label4  = Multi-platform
 +
|data4  = Linux, MacOSX, Windows
 +
|header5 =
 +
|label5  = Version
 +
|data5  = {{documentation/currentversion}}
 +
|header6 =
 +
|label6  = License
 +
|data6  = [http://www.slicer.org/pages/LicenseText Contribution and Software License Agreement]
 +
}}
  
−
=Modules=
+
==Slicer 4==
−
Please copy the template linked below, paste it into your page and customize it with your module's information.
 
−
[[Slicer3:Module_Documentation_Template|Slicer3:Module_Documentation_Template]]
 
−
==Core and Loadable Modules==
 
−
*[[Modules:Data-Documentation| Data Module]]
 
−
*[[Modules:Volumes-Documentation| Volumes Module]]
 
−
*[[Modules:DTMRI-Documentation| DTMRI Infrastructure]]
 
−
*[[Modules:Volumes:Diffusion Editor-Documentation| Diffusion Editor]]
 
−
*[[Modules:Models-Documentation| Models Module]]
 
−
*[[Modules:Modelmaker-Documentation| Modelmaker]]
 
−
*[[Modules:Transforms-Documentation| Transforms Module]]
 
−
*[[Modules:Fiducials-Documentation| Fiducials Module]]
 
−
*[[Modules:VolumeRendering-Documentation| Volume Rendering Module]]
 
−
*[[Modules:Editor-Documentation| Interactive Editor]]
 
−
*[[Slicer3:Module:QueryAtlas|Query Atlas]]
 
−
*[[Modules:EM-Segmenter-Documentation|EM Segementer]]
 
−
*[[Modules:ChangeTracker-Documentation|ChangeTracker]]
 
  
−
==CLI Modules==
+
*[[Documentation/Nightly|Nightly]]
−
*Registration: the top two have been somewhat tested by Ron on T1 weighted MR images and work pretty fast
+
<!-- NEXT RELEASE -->
−
*[[Modules:AffineRegistration-Documentation|Affine Registration]]
+
*[[Documentation/4.10|4.10]] / [[Documentation/4.10/ReleaseNotes|Release notes]] / [[Documentation/4.10/Announcements | Announcement]] / [[Documentation/4.10/Acknowledgments | Acknowledgments]]
−
*[[Slicer3:Module:Deformable_BSpline_registration|Deformable BSpline Registration]]
+
*[[Documentation/4.8|4.8]] / [[Documentation/4.8/ReleaseNotes|Release notes]] / [[Documentation/4.8/Announcements | Announcement]] / [[Documentation/4.8/Acknowledgments | Acknowledgments]]
−
*The following are somewhat undocumented and or experimental
+
*[[Documentation/4.6|4.6]] / [[Documentation/4.6/ReleaseNotes|Release notes]] / [[Documentation/4.6/Announcements | Announcement]] / [[Documentation/4.6/Acknowledgments | Acknowledgments]]
−
**[[Modules:OtsuThresholding-Documentation|Otsu Thresholding]]
+
*[[Documentation/4.5|4.5]] / [[Documentation/4.5/ReleaseNotes|Release notes]] / [[Documentation/4.5/Announcements | Announcement]] / [[Documentation/4.5/Acknowledgments | Acknowledgments]]
−
**[[Modules:ResampleVolume2-Documentation|Resample Volume 2]]
+
*[[Documentation/4.4|4.4]] / [[Documentation/4.4/ReleaseNotes|Release notes]] / [[Documentation/4.4/Announcements | Announcement]] / [http://www.slicer.org/pages/Acknowledgments#Acknowledgments_Slicer_4 Acknowledgments]
−
**[[Modules:StochasticTractography-Documentation|Stochastic Tractography]]
+
*[[Documentation/4.3|4.3]] / [[Documentation/4.3/ReleaseNotes|Release notes]] / [[Documentation/4.3/Announcements | Announcement]] / [http://www.slicer.org/pages/Acknowledgments#Acknowledgments_Slicer_4 Acknowledgments]
−
**[[Modules:LinearRegistration-Documentation|Linear Registration (aka rigid registration)]]
+
*[[Documentation/4.2|4.2]] / [[Documentation/4.2/ReleaseNotes|Release notes]] / [[Documentation/4.2/Announcements | Announcement]] / [http://www.slicer.org/pages/Acknowledgments#Acknowledgments_Slicer_4 Acknowledgments]
−
**[[Slicer3:Module:VotingBinaryHoleFilling|Voting Binary Hole Filling]]
+
*[[Documentation/4.1|4.1]] / [[Documentation/4.1/ReleaseNotes|Release notes]] / [[Documentation/4.1/Announcements | Announcement]] / [http://www.slicer.org/pages/Acknowledgments#Acknowledgments_Slicer_4 Acknowledgments]
−
**[[Slicer3:Module:(UTAH)Deformable_BSpline_registration|(UTAH)Deformable BSpline Registration]]
+
*[[Documentation/4.0|4.0]] / [[Documentation/4.0/ReleaseNotes|Release notes]] / [[Documentation/4.0/Announcements | Announcement]] / [http://www.slicer.org/pages/Acknowledgments#Acknowledgments_Slicer_4 Acknowledgments]
−
**[[Slicer3:Module:Level-Set Segmentation Framework-Documentation |Level-Set Segmentation Framework]]
 
−
***[[Slicer3:Module:Region Selector-Documentation |Region Selector]]
 
−
***[[Slicer3:Module:Target Preprocessing-Documentation |Target Preprocessing]]
 
−
***[[Slicer3:Module:Bubble Maker-Documentation |Bubble Maker]]
 
−
***[[Slicer3:Module:Level-Set Label Map Evolver-Documentation |Level-Set Label Map Evolver]]
 
−
**[[Slicer3:Module:Binary Morphological Operations-Documentation |Binary Morphological Operations]]
 
−
***[[Slicer3:Module:BinaryThresholding-Documentation |BinaryThresholding]]
 
−
***[[Slicer3:Module:LabelBinaryImages-Documentation |LabelBinaryImages]]
 
−
***[[Slicer3:Module:BinaryErodeOperations-Documentation |BinaryErodeOperations]]
 
−
***[[Slicer3:Module:BinaryDilateOperations-Documentation |BinaryDilateOperations]]
 
−
**[[Slicer3:Module:Fuzzy Surface Creation-Documentation |Fuzzy Surface Creation]]
 
  
−
==Modules on NITRC==
+
<font color="#669"><small>Acknowledgments are now reported separately for each version.</small></font>
−
[[Image:SlicerOnNITRC2009.png|thumb|right|Slicer on NITRC]]
+
<!--
−
We are using NITRC as a repository for contributed modules. As a general rule, we do not test them ourselves, it is the downloaders job to ensure that they do what they want them to do.
+
<font color="#669"><small>The community contributing to Slicer 4 is acknowledged [http://www.slicer.org/pages/Acknowledgments#Acknowledgments_Slicer_4 here]</small></font>
 +
-->
  
−
Click [http://www.nitrc.org/search/?type_of_search=soft&words=slicer3&Search.x=0&Search.y=0&Search=Search  here] to see a listing of Slicer 3 modules on NITRC.
+
==Slicer 3==
  
−
For NITRC modules the work is still in-progress. Active work (05/2008):
+
*[[Documentation/3.6|3.6]] / [[Documentation/3.6/ReleaseNotes|Release notes]] / [[Announcements:Slicer3.6 | Announcement]]
−
*Sebastien is working on being able to build modules based on a configuration file.
+
*[[Documentation/3.5|3.5]]
−
*Terry Lorber has created GenerateLM to be used to add Loadable Module support to modules. This allows modules to be detected and loaded at run-time.
+
*[[Documentation/3.4|3.4]] / [[Documentation/3.4/ReleaseNotes|Release notes]] / [[Announcements:Slicer3.4 | Announcement]]
−
* Terry will continue to convert Modules/* projects to use this functionality [[Slicer3:Loadable_Modules:Current]]
+
*[[Documentation/3.2|3.2]] / [[Documentation/3.2/ReleaseNotes|Release notes]]
−
*Once these are done Terry will look at how to download and install new modules from places like NITRC.
 
  
−
Update (10/2008):
+
<font color="#669"><small>The community contributing to Slicer 3 is acknowledged [http://www.slicer.org/pages/Acknowledgments#Acknowledgments_Slicer3 here]</small></font>
  
−
Terry is completing a prototype of the download tool that will work in conjunction with binaries hosted by NITRC.
+
==Slicer 2==
  
−
==Problems and Feature Request==
+
*[[Slicer:Slicer2.7_Getting_Started|2.7]] / [[Slicer:Slicer2.7_Release_Notes|Release notes]]
−
We have an issues [http://www.na-mic.org/Bug/my_view_page.php tracker] for Slicer 3. You need to create an account for filing reports. We keep track of both feature requests and bug reports. Make sure to use the pull-down in the upper right to select Slicer 3.
+
*[[Slicer:Slicer2.6_Getting_Started|2.6]] / [[Slicer:Slicer2.6_Release_Notes|Release notes]]
 +
*[[Slicer:Slicer2.5_Getting_Started|2.5]] / [[Slicer:Slicer2.5_Release_Notes|Release notes]]
 +
*[[Slicer:Slicer2.4_Getting_Started|2.4]] / [[Slicer:Slicer2.4_Release_Notes|Release notes]]
  
−
==List of Modules==
+
<font color="#669"><small>The community contributing to Slicer 2 is acknowledged [http://www.slicer.org/pages/Acknowledgments#Slicer2:_Individual.2FGroup_Contributors here]</small></font>
−
*[[Modules:ChangeTracker-Documentation|ChangeTracker]]
+
 
−
*CommandLineModule
+
==Slicer 1==
−
*DistanceMapFiducials
+
 
−
*DistanceTransformModel
+
*[https://web.archive.org/web/20130205161603/https://www.slicer.org/archives/download/index.html 1.3] / [http://massmail.spl.harvard.edu/public-archives/slicer-users/2002/000145.html Announcement]
−
*EMSegment
+
 
−
*Editor
+
 
−
*FetchMI
+
<hr />
−
*GradientAnisotropicDiffusionFilter
+
<center>[[Image:Slicer4Announcement-HiRes.png|350px]]</center>
−
*MRAblation
+
<!--
−
*Meshing (BoundingBox, VoxelMesh)
+
[[Image:AppGUIMap.png|400px]]
−
*NeuroNav
+
-->
−
*[[Modules:OpenIGTLinkIF|OpenIGTLink IF]]
 
−
*QdecModule
 
−
*QueryAtlas
 
−
*RealTimeImaging
 
−
*ScriptedModule
 
−
*ScriptedModuleExample
 
−
*Statistics
 
−
*Tractography (ROI, Fiducial)
 
−
*VolumeRendering
 
−
*Volumes
 
−
*WFEngineModule
 

Latest revision as of 21:15, 19 January 2022

Home < Documentation


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



3D Slicer
3D Slicer
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.10
License Contribution and Software License Agreement
v · d · e

Slicer 4

Acknowledgments are now reported separately for each version.

Slicer 3

The community contributing to Slicer 3 is acknowledged here

Slicer 2

The community contributing to Slicer 2 is acknowledged here

Slicer 1


Slicer4Announcement-HiRes.png
Retrieved from "https://www.slicer.org/w/index.php?title=Documentation&oldid=63931"