Difference between revisions of "Documentation/4.1"

From Slicer Wiki
Jump to: navigation, search
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(49 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
__NOTOC__
 
__NOTOC__
 
{{documentation/versionlist}}
 
{{documentation/versionlist}}
  
=Table of Content=
 
 
{| border="0" align="center" width="100%" valign="top" cellspacing="7" cellpadding="2"
 
{| border="0" align="center" width="100%" valign="top" cellspacing="7" cellpadding="2"
 
|-
 
|-
Line 12: Line 12:
 
|-  
 
|-  
 
|valign="top"|
 
|valign="top"|
 +
----
 +
<span style="color: #555555; font-size: 18px; font-weight: bold;">Where to start ?</span>
 +
----
 +
* [[Documentation/{{documentation/version}}/Training|Training pages]]
 +
: Information on how to use Slicer {{documentation/version}}
  
===Slicer Application===
+
* [[Documentation/{{documentation/version}}/FAQ|FAQ]]
 +
: Set of common questions/answers
 +
* [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-users Users mailing list] / [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-users Sign-up] / [http://slicer-users.65878.n3.nabble.com/ Browse archives]
 +
----
 +
<span style="color: #555555; font-size: 18px; font-weight: bold;">How to</span>
 
----
 
----
*[[Documentation/{{documentation/version}}/SlicerApplication/MainApplicationGUI| Main Application GUI]]
+
* [[Documentation/{{documentation/version}}/Report a problem|Report a problem]]
 
 
*[[Documentation/{{documentation/version}}/SlicerApplication/MouseandKeyboardShortcuts | Mouse Buttons, "Hot-keys" and Keyboard Shortcuts]]
 
 
 
*[[Documentation/{{documentation/version}}/SlicerApplication/HardwareConfiguration | '''Computer Configurations''']]
 
*[[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)
 
<!-- : scenes, DICOM, volumes, models, fiducials, transforms, etc. -->
 
*[[Documentation/{{documentation/version}}/SlicerApplication/LookupTables | Slicer Lookup Tables]]
 
*[[Documentation/{{documentation/version}}/SlicerApplication/StereoViewing | Setting up and using stereoscopic viewing]]
 
 
 
===Mailing Lists===
 
 
----
 
----
* [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-users Mailing list for users]
+
{{:{{FULLPAGENAME}}/SlicerApplication}}
:[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:ExtensionsManagementWizard-Documentation-4.0| Extensions Management Wizard]] (xx)
 
-->
 
  
 
|bgcolor="#CCCCCC"|
 
|bgcolor="#CCCCCC"|
 
|valign="top"|
 
|valign="top"|
 
+
----
===Module Categories ===
+
<span style="color: #555555; font-size: 18px; font-weight: bold;">Module Categories</span>
 
----
 
----
 
* [[#Core Modules|Core Modules]]
 
* [[#Core Modules|Core Modules]]
Line 56: Line 48:
 
* [[#Developer Tools|Developer Tools]]
 
* [[#Developer Tools|Developer Tools]]
 
* [[#Legacy|Legacy]]
 
* [[#Legacy|Legacy]]
 +
 
|bgcolor="#CCCCCC"|
 
|bgcolor="#CCCCCC"|
 
|valign="top"|
 
|valign="top"|
 +
----
 +
<span style="color: #555555; font-size: 18px; font-weight: bold;">Developers Corner</span>
 +
----
 +
* [[Documentation/{{documentation/version}}/Developers | Information for Software Developers]]
 +
: Source code, contribute patch, develop modules
  
===Miscellaneous===
+
* [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>
 
----
 
----
 
<!-- * [[Documentation/{{documentation/version}}/ImageGallery|Image gallery]] -->
 
<!-- * [[Documentation/{{documentation/version}}/ImageGallery|Image gallery]] -->
 +
 +
* [[Documentation/4.1/HowTo|Documentation guidelines]]
 +
:  Slicer user documentation principle and guidelines
  
 
* [[Slicer4:VisualBlog|Visual blog]]
 
* [[Slicer4:VisualBlog|Visual blog]]
 
: Set of screenshots showing Slicer in action.
 
: 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]]
 
* [[Documentation/{{documentation/version}}/ReleaseNotes|Release Notes]]
 
: Platform specific issues and considerations
 
: Platform specific issues and considerations
  
* [[Documentation/{{documentation/version}}/Announcements|Announcements]]
+
* [[Documentation/{{documentation/version}}/Announcements|Announcements]] & [http://www.slicer.org/pages/Acknowledgments#Acknowledgments_Slicer_4 Acknowledgments]
: the announcement associated with Slicer {{documentation/version}}
 
 
 
===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:3DSlicer41Logo-H-218X144.png|218px|alt=3D Slicer {{documentation/version}}]]
+
* [http://na-mic.org/Wiki/index.php/Projects:RegistrationDocumentation:RegLibTable Slicer Registration Case Library]
|imagestyle  =
+
: Real-life example cases of using the Slicer registration tools, incl. datasets and step-by-step instructions to follow and try yourself.
|headerstyle = background:#E7DCC3;
 
|labelstyle  =
 
|datastyle    =
 
  
|header1 = Description
 
|label1  =
 
|data1  =
 
|header2 =
 
|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/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]]. }}-->
 
 
|}
 
|}
  
 
{{:{{FULLPAGENAME}}/Modules}}
 
{{:{{FULLPAGENAME}}/Modules}}
 
==Legacy==
 
*Converters
 
**[[Documentation/{{documentation/version}}/Modules/BSplineToDeformationField|BSpline To Deformation Field]]
 
*Diffusion
 
**Denoising
 
***[[Documentation/{{documentation/version}}/Modules/DWIUnbiasedNonLocalMeansFilter|DWI Unbiased Non Local Means Filter]]
 
*Filtering
 
**[[Documentation/{{documentation/version}}/Modules/MRIBiasFieldCorrection|MRI Bias Field Correction]] (Sylvain Jaume) [[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/OtsuThresholdImageFilter|Otsu Threshold Image Filter]] (Bill Lorensen) [[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/ResampleScalarVolume|Resample Scalar Volume]] (Jim Miller) [[image:UnderConstruction.png|tumb|10px]]
 
*Registration
 
**[[Documentation/{{documentation/version}}/Modules/RigidRegistration|Rigid Registration]] (Jim Miller)  [[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/AffineRegistration|Affine Registration]] (Daniel Blezek) [[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/BSplineDeformableRegistration|BSpline Deformable Registration]] [[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/ExpertAutomatedRegistration|Expert Automated Registration]] [[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/LinearRegistration|Linear Registration]] [[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/MultiResolutionAffineRegistration|MultiResolution Affine Registration]] (Casey Goodlett)[[image:UnderConstruction.png|tumb|10px]]
 
<!--
 
**[[Documentation/{{documentation/version}}/Modules/TestGridTransformRegistration|Test Grid Transform Registration]] [[image:UnderConstruction.png|tumb|10px]]
 
-->
 
*Segmentation
 
**[[Documentation/{{documentation/version}}/Modules/OtsuThresholdSegmentation|Otsu Threshold Segmentation]] (Bill Lorensen) [[image:UnderConstruction.png|tumb|10px]]
 
 
=Extensions=
 
==Introduction==
 
[[Documentation/4.1/Extensions|Extensions]] which can be added to the basic Slicer package in order to add functionality. The slicer community maintains a website to support finding, downloading and installing Extensions for 3D Slicer 4. Access to this website is integral to Slicer 4 and facilitated by the Extensions Manager functionality built into the distributed program. Please see [[Documentation/{{documentation/version}}/Developers/Tutorials/ExtensionWriting|here]] for information for software developers on how to add your extension to this website.
 
 
The download site is referred to as the '''Slicer Extensions Catalog'''. The Catalog classifies extensions into three levels of compliance:
 
*Category 1: Fully compliant Slicer Extensions: Slicer license, open source, maintained.
 
*Category 2: open source, contact exists.
 
*Category 3: all other extensions (work in progress, beta, closed source etc).
 
 
See [[Documentation/{{documentation/version}}/SlicerApplication/ExtensionCatalogPolicies|here]] for more information about extension types and policies.
 
 
==Cat 1==
 
 
==Cat 2==
 
* [[Documentation/{{documentation/version}}/Extensions/SkullStripper|SkullStripper]] (Xiaodong Tao)[[image:UnderConstruction.png|tumb|10px]]
 
* [[Documentation/{{documentation/version}}/Extensions/CARMA|CARMA]] (Alan Morris)[[image:UnderConstruction.png|tumb|10px]]
 
 
==Cat 3==
 
* [[Documentation/{{documentation/version}}/Extensions/Plastimatch|Plastimatch]] (Greg Sharp)[[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/PlmBSplineDeformableRegistration|Plastimatch Automatic deformable image registration]] (Greg Sharp)[[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/PlmDICOMRTImport|Plastimatch DICOM-RT import]] (Greg Sharp)[[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/PlmDICOMRTExport|Plastimatch DICOM-RT export]] (Greg Sharp)[[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/PlmDoseComparison|Plastimatch Dose Comparison]] (Greg Sharp)[[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/PlmDoseVolumeHistogram|Plastimatch Dose Volume Histogram]] (Greg Sharp)[[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/PlmLANDWARP|Plastimatch LANDWARP Landmark]] (Greg Sharp)[[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/PlmSyntheticImageGeneration|Plastimatch Synthetic Image Generation]] (Greg Sharp)[[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/PlmThreshBox|Plastimatch Threshold in a box]] (Greg Sharp)[[image:UnderConstruction.png|tumb|10px]]
 
**[[Documentation/{{documentation/version}}/Modules/PlmXFORMWARP|Plastimatch XFORMWARP]] (Greg Sharp)[[image:UnderConstruction.png|tumb|10px]]
 

Latest revision as of 07:27, 14 June 2013

Home < Documentation < 4.1


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


Where to start ?


Information on how to use Slicer 4.1
Set of common questions/answers

How to



Slicer Application




Module Categories



Developers Corner


Source code, contribute patch, develop modules
Intended for discussion of programming related questions

Miscellaneous


Slicer user documentation principle and guidelines
Set of screenshots showing Slicer in action.
Platform specific issues and considerations
Real-life example cases of using the Slicer registration tools, incl. datasets and step-by-step instructions to follow and try yourself.


Modules by Category

Core Modules

Wizards

Informatics

Registration

Segmentation

Quantification

Diffusion

IGT

Filtering

Surface Models

Converters

Endoscopy

tumb Work in Progress tumb

Developer Tools

Legacy