Difference between revisions of "Documentation/Nightly/2016-User-Manual-Discussion"

From Slicer Wiki
Jump to: navigation, search
 
(82 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude>{{documentation/versioncheck}}</noinclude>
+
<noinclude><!--{{documentation/versioncheck}}--></noinclude>
 
__NOTOC__
 
__NOTOC__
=3D Slicer is:=
+
<!--{{documentation/versionlist}}-->
* A software platform for the analysis (including registration and interactive segmentation) and visualization (including volume rendering) of medical images and for research in image guided therapy.
 
* A free, open source software available on multiple operating systems: Linux, MacOSX and Windows
 
* Extensible, with powerful plug-in capabilities for adding algorithms and applications.
 
==Features include:==
 
* Multi organ: from head to toe.
 
* Support for multi-modality imaging including, MRI, CT, US, nuclear medicine, and microscopy.
 
* Bidirectional interface for devices.
 
 
 
There is no restriction on use, but 3D Slicer is not approved for clinical use and is intended for research. Permissions and compliance with applicable rules are the responsibility of the user. For details on the license see [[ insert link to license| license link]]here
 
  
 +
3D Slicer
 +
{| border="0" align="center" width="100%" valign="top" cellspacing="7" cellpadding="2"
 +
|-
 +
! width="50%"|
 +
! |
 +
! width="50%"|
 +
|-
 +
|valign="top"|
 +
----
 +
<span style="color: #555555; font-size: 18px; font-weight: bold;"> </span>
 +
----
 +
* Analysis and visualization of medical images
 +
* Image guided therapy research, device interfaces.
 +
* Extensible, free, open source. See [https://www.slicer.org/pages/LicenseText here] for the license
  
 +
|bgcolor="#CCCCCC"|
 +
|valign="top"|
 +
----
 +
<span style="color: #555555; font-size: 18px; font-weight: bold;"> </span>
 +
----
 +
* Designed for biomedical research
 +
* Multi organ capability: from head to toe.
 +
* Multi-modality imaging: MRI, CT, US, nuclear medicine, and microscopy.
 +
|}
 
{| border="0" align="center" width="100%" valign="top" cellspacing="7" cellpadding="2"
 
{| border="0" align="center" width="100%" valign="top" cellspacing="7" cellpadding="2"
 
|-
 
|-
! width="33%"|
+
! width="50%"|
 
! |
 
! |
! width="33%"|
+
! width="50%"|
! |
 
! width="33%"|
 
 
|-  
 
|-  
 
|valign="top"|
 
|valign="top"|
Line 25: Line 37:
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Where to start ?</span>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Where to start ?</span>
 
----
 
----
* [[ link to Training pages|Information on how to use 3D Slicer]]
+
* [[ New_users|Getting started]]
* [[link to FAQ|Frequently asked questions]]
+
* [[ Documentation/{{documentation/version}}/Training|Self-Training: Tutorials and sample data]]
* [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-users Mailing list for users of 3D Slicer] / [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-users Sign-up] <br> [http://slicer-users.65878.n3.nabble.com/ Search the mailing list archives]
+
* [[FAQ|Frequently asked questions]]
* [[Link to report a problem page|Report a problem or request a feature (edit that page accordingly, aimed at end users, not developers)]]
+
* [http://slicer-users.65878.n3.nabble.com/ Search users mailing list] / [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-users Sign-up]
 +
* How to [[CitingSlicer|cite 3D Slicer and individual 3D Slicer Modules]]  
 
----
 
----
 
----
 
----
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">The Basics</span>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">The Basics</span>
 
----
 
----
* A [[tour through the main window of 3D Slicer]]
+
* [[Documentation/{{documentation/version}}/SlicerApplication/Installation|Installation]]
* [[Mouse Buttons, "Hot-keys" and Keyboard Shortcuts]]
+
* A [[Documentation/{{documentation/version}}/SlicerApplication/MainApplicationGUI|tour through the main window of 3D Slicer]]
* Where to modify [[settings]] and where they are [[stored]] (refers to the Edit/Appplication Settings pop up panel)
+
* [[Documentation/{{documentation/version}}/SlicerApplication/MainApplicationGUI#Layouts|Layouts]], [[Documentation/{{documentation/version}}/SlicerApplication/MainApplicationGUI#3D_Viewer|3D Viewers]], and [[Documentation/{{documentation/version}}/SlicerApplication/MainApplicationGUI#Slice_Viewers|Slice Viewers]]
* [[Hardware requirements]]
+
* [[Documentation/{{documentation/version}}/SlicerApplication/MouseandKeyboardShortcuts|Mouse Buttons, "Hot-keys" and Keyboard Shortcuts]]
* [[Loading]], [[Saving data]] and [[listing of supported data formats]].
+
* Where to modify [[Documentation/{{documentation/version}}/SlicerApplication/ApplicationSettings#Overview|settings]]
 
+
* [[Documentation/{{documentation/version}}/SlicerApplication/HardwareConfiguration|Hardware requirements]]
    Slicer Lookup Tables
+
*[[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]].
 
+
<!-- : scenes, DICOM, volumes, models, fiducials, transforms, etc. -->
    Setting up and using stereoscopic viewing
 
 
 
    QtTesting - Easy way to record and play macros
 
 
 
  
 +
----
 +
<span style="color: #555555; font-size: 18px; font-weight: bold;">Advanced Topics</span>
 +
----
 +
* [http://slicerdmri.github.io/  Interactive tractography using diffusion MRI data]
 +
* [[Documentation/{{documentation/version}}/Extensions/SlicerIGT | Slicer IGT]]
 +
* [[Documentation/{{documentation/version}}/Extensions/SlicerRT | Slicer RT]]
  
  
 
|bgcolor="#CCCCCC"|
 
|bgcolor="#CCCCCC"|
 
|valign="top"|
 
|valign="top"|
 +
 
----
 
----
<span style="color: #555555; font-size: 18px; font-weight: bold;">Module Categories</span>
+
<span style="color: #555555; font-size: 18px; font-weight: bold;">Core Functions</span>
 
----
 
----
* [[#Core Modules|Core Modules]]
+
{| class="wikitable"
* [[#Wizards|Wizards]]
+
| [[image:Load-2016-08-11.png|100px|link=Documentation/Nightly/SlicerApplication/LoadingData| To add data, just drag and drop]]
* [[#Informatics|Informatics]]
+
| [[image:Save-Icon-2016-08-11.png|100px|link=Documentation/Nightly/SlicerApplication/SavingData| To save data, select the save icon]]
* [[#Registration|Registration]]
+
|-
* [[#Segmentation|Segmentation]]
+
| [[Image:2016-07-03-Interactive-Editor-Icon.png|100 px| link=Link to Editor module |Interactive segmentation]]  
* [[#Quantification|Quantification]]
+
| [[image:Editor-panel.png|100px|link=https://www.youtube.com/watch?v=MKLWzD0PiIc| Interactive Segmentation (at 14 minutes)]]
* [[#Diffusion|Diffusion]]
+
|-
* [[#IGT|IGT]]
+
| [[Image:2016-07-03-Transforms-Module-Icon.png|100 px|link=Documentation/Nightly/Modules/Transforms|Interactive registration]]
* [[#Filtering|Filtering]]
+
| [[Image:Grid3dVolume.png|100px|link=https://www.youtube.com/watch?v=kZUAfR0mqqI| Demo of the transforms display feature]]
* [[#Surface Models|Surface Models]]
+
|-
* [[#Converters|Converters]]
+
| [[Image:SlicerRegistrationLibrary_Ad.png|100px|link=Documentation/Nightly/Registration/RegistrationLibrary|Registration library]]
* [[#Endoscopy|Endoscopy]]
+
| [[Image:VolumeRendering-CTA-2011.png|100 px|link=Documentation/Nightly/Modules/VolumeRendering | Volume rendering]]
* [[#Work in Progress| Work in Progress]]
+
|-
* [[#Developer Tools|Developer Tools]]
+
| [[Image:Fiducial-2016-08-11.png|100px|link=Documentation/Nightly/Modules/Markups| Fiducials]]  
* [[#Legacy|Legacy]]
+
| [[Image:Ruler-2016-08-11.png|100px|link=Documentation/Nightly/Modules/Annotations| Linear Measurements]]
----
+
|}
<span style="color: #555555; font-size: 18px; font-weight: bold;">Extension Categories</span> {{new}}
+
 
----
+
|}
{{note}} What are these categories ? See [[Documentation/{{documentation/version}}/Extensions/CatalogPolicies|here]]
 
  
* [[#Cat_1|Category 1]]
+
* [[search box right here|Search for a module in this version of Slicer (including extensions)]]
* [[#Cat_2|Category 2]]
+
* Listing in two columns:
* [[#Cat_3|Category 3]]
+
** Alphabetic list of modules
 +
** Alphabetic list of extensions
  
|bgcolor="#CCCCCC"|
+
{| border="0" align="center" width="100%" valign="top" cellspacing="7" cellpadding="2"
 +
|-
 +
! width="50%"|
 +
! |
 +
! width="50%"|
 +
|-
 
|valign="top"|
 
|valign="top"|
  
----
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Developers Corner</span>
 
----
 
* [[Documentation/Nightly/Developers | Information for Software Developers]]{{updated}}
 
: Source code, contribute patch, develop modules
 
 
* [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel Developers mailing list] / [http://slicer-devel.65872.n3.nabble.com/ Browse archives]
 
: Intended for discussion of programming related questions
 
 
----
 
----
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Miscellaneous</span>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Miscellaneous</span>
 
----
 
----
<!-- * [[Documentation/{{documentation/version}}/ImageGallery|Image gallery]] -->
+
* [[Documentation/Nightly/Developers | Information for Software Developers]]
 
+
* [[Slicer4:VisualBlog|Visual blog: A set of screenshots showing Slicer in action.]]
* [[Documentation/{{documentation/version}}/HowTo|Documentation guidelines]]
+
* [[Documentation/{{documentation/version}}/ReleaseNotes|Release Notes: Platform specific issues and considerations]]
: Slicer user documentation principle and guidelines
+
* [[Documentation/{{documentation/version}}/Announcements|Announcements]] & [http://www.slicer.org/pages/Acknowledgments#Acknowledgments_Slicer_4 Acknowledgments]
 
+
* [[Documentation/{{documentation/version}}/SlicerApplication/LookupTables | Slicer Lookup Tables]]
* [[Slicer4:VisualBlog|Visual blog]]
+
* [[Documentation/{{documentation/version}}/SlicerApplication/StereoViewing | Setting up and using stereoscopic viewing]]
: Set of screenshots showing Slicer in action.
+
* [[Documentation/{{documentation/version}}/SlicerApplication/QtTesting |  QtTesting - Easy way to record and play macros]]
 
 
* [[Documentation/{{documentation/version}}/ReleaseNotes|Release Notes]]
 
: Platform specific issues and considerations
 
  
* [[Documentation/{{documentation/version}}/Announcements|Announcements]] & [http://www.slicer.org/pages/Acknowledgments#Acknowledgments_Slicer_4 Acknowledgments]
 
  
* [http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.3/Registration/RegistrationLibrary Slicer Registration Library]
 
: Real-life example cases of using the Slicer registration tools,  incl. datasets and step-by-step instructions to follow and try yourself.
 
  
 
----
 
----
<span style="color: #555555; font-size: 18px; font-weight: bold;">Documentación en Español</span> {{new}}
+
<span style="color: #555555; font-size: 18px; font-weight: bold;">Documentation in other languages </span>
 
----
 
----
* [http://robustiana.com/156-intro-a-3d-slicer Introducción a 3D Slicer en Español]
+
{{:Documentation/{{documentation/version}}/Lang/ES}}
: Breve descripción de proyecto y un breve viaje por sus principales herramientas y funcionalidades.
 
 
 
* [http://robustiana.com/157-recon-volumetricas Reconstrucciones volumétricas con 3D Slicer]
 
: Guía de uso para la herramienta de creación de reconstrucciones volumétricas de 3D Slicer. 
 
 
 
* [http://robustiana.com/158-contornos-3d-slicer Crear modelos/contornos de órganos con 3D Slicer]
 
: Guía rápida introductoria para la creación de contornos de órganos para generar vistas volumétricas.
 
 
 
* [http://robustiana.com/159-endoscopias-3d-slicer Endoscopías virtuales con 3D Slicer]
 
: Manual de uso de la herramienta para 3D Slicer desarrollada por Steve Pieper para realizar endoscopías virtuales.
 
 
 
* [http://robustiana.com/163-rt-slicer-3d Creando curvas de isodosis con SlicerRT de 3D Slicer]
 
: Introducción a la extensión SlicerRT para 3D Slicer enfocada en investigación en radioterapia.
 
 
 
 
|}
 
|}
 
{{:{{FULLPAGENAME}}/Modules}}
 
 
{{:{{FULLPAGENAME}}/Extensions}}
 

Latest revision as of 14:20, 11 August 2016

Home < Documentation < Nightly < 2016-User-Manual-Discussion


3D Slicer



  • Analysis and visualization of medical images
  • Image guided therapy research, device interfaces.
  • Extensible, free, open source. See here for the license


  • Designed for biomedical research
  • Multi organ capability: from head to toe.
  • Multi-modality imaging: MRI, CT, US, nuclear medicine, and microscopy.

Where to start ?




The Basics



Advanced Topics




Core Functions


To add data, just drag and drop To save data, select the save icon
Interactive segmentation Interactive Segmentation (at 14 minutes)
Interactive registration Demo of the transforms display feature
Registration library Volume rendering
Fiducials Linear Measurements

Miscellaneous




Documentation in other languages