Difference between revisions of "Documentation/3.6"
m (Text replacement - "slicerWiki/index.php" to "wiki") |
|||
(286 intermediate revisions by 36 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <noinclude>{{documentation/versioncheck}}</noinclude> | |
+ | [[image:Slicer3-6Announcement-v2.png| right |3.6 Icon]] | ||
− | = | + | {{documentation/versionlist}} |
+ | |||
+ | =Introduction= | ||
+ | |||
+ | 3D Slicer is a flexible platform that can be easily extended to enable development of both interactive and batch processing tools for a variety of applications. | ||
+ | |||
+ | 3D Slicer provides image registration, processing of DTI (diffusion tractography), an interface to external devices for image guidance support, and GPU-enabled volume rendering, among other capabilities. 3D Slicer has a modular organization that allows the easy addition of new functionality and provides a number of generic features not available in competing tools. Finally, 3D Slicer is distributed under a non-restrictive BSD license. | ||
+ | |||
+ | The interactive visualization capabilities of 3D Slicer include the ability to display arbitrarily oriented image slices, build surface models from image labels, and high performance volume rendering. 3D Slicer also supports a rich set of annotation features (fiducials and measurement widgets, customized colormaps). To the best of our knowledge, no individual segmentation tool provides such powerful visualization capabilities for the user as 3D Slicer. (These paragraphs were provided by A. Fedorov and C. Lisle) | ||
− | + | The 3.6 release of 3D Slicer contains significant changes both to the organization of the software and to the functionality. Please check the [[Announcements:Slicer3.6 |3.6 Announcement page]] for a list of those changes. The community contributing to Slicer 3.6 is [[Announcments-3.6-Team|acknowledged here]]. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | *For information on how to use Slicer 3.6 please go to the [[Training|training]] pages. | |
− | * | + | *For information on how to obtain Slicer 3.6 please go to the [http://www.slicer.org/pages/Special:SlicerDownloads Download Pages]. |
− | [[ | + | *For sample data see [[SampleData|here]] |
− | * | + | *For documentation on other versions of Slicer see [[Documentation|here]] |
− | + | *For a [[Slicer-3-6-FAQ|FAQ]] see here | |
+ | *[[Slicer3:Build_Instructions|Slicer version 3 build instructions]] for developers | ||
+ | *<big>For an overview on how to load your data, see [[Slicer-3.6-Load-Overview|here]]</big> | ||
− | + | =Main GUI= | |
− | |||
− | + | *[[Modules:MainApplicationGUI-Documentation-3.6| Main Application GUI]] (Wendy Plesniak) | |
− | + | *[[Modules:EventBindings-3.6| "Hot-keys" and Keyboard Shortcuts]] (Wendy Plesniak) | |
− | + | *[[Modules:Loading-Data-3.6| Loading Data]] (scenes, DICOM, volumes, models, fiducials, transforms, etc.) (Wendy Plesniak) | |
− | + | *[[Modules:Saving-Documentation-3.6| Saving Data]] (scenes, volumes, models, fiducials, transforms, etc.) (Wendy Plesniak) | |
− | * | + | *[[Modules:SceneSnapshots-3.6| Creating and Restoring Scene Snapshots]] (Wendy Plesniak) |
− | + | *[[Modules:StereoViewing-3.6 | Setting up and using stereoscopic viewing ]] (Curt Lisle, Wendy Plesniak) | |
− | * | + | *[[Modules:ExtensionsManagementWizard-Documentation-3.6| Extensions Management Wizard]] (Wendy Plesniak) |
− | |||
− | |||
− | |||
− | |||
− | |||
− | * | ||
− | * | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | = | + | =Modules= |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
==Core== | ==Core== | ||
− | + | *[[Modules:Welcome-Documentation-3.6| Welcome Module]] (Wendy Plesniak, Steve Pieper, Sonia Pujol, Ron Kikinis) | |
− | *[[Modules:Welcome-Documentation-3. | + | *[[Modules:Data-Documentation-3.6| Data Module]] (Alex Yarmarkovich) |
*[[Modules:Volumes-Documentation-3.6| Volumes Module]] (Alex Yarmarkovich, Steve Pieper) | *[[Modules:Volumes-Documentation-3.6| Volumes Module]] (Alex Yarmarkovich, Steve Pieper) | ||
**[[Modules:Volumes:Diffusion Editor-Documentation-3.6| Diffusion Editor]] (Kerstin Kessel) | **[[Modules:Volumes:Diffusion Editor-Documentation-3.6| Diffusion Editor]] (Kerstin Kessel) | ||
+ | *[[Modules:Slices-Documentation-3.6|Slices Module]] (Jim Miller) | ||
+ | *[[Modules:VolumeRendering-Documentation-3.6| Volume Rendering Module]] (Yanling Liu, Alex Yarmarkovich) | ||
+ | *[[Modules:Editor-Documentation-3.6|Editor]] (Steve Pieper) | ||
*[[Modules:Models-Documentation-3.6| Models Module]] (Alex Yarmarkovich) | *[[Modules:Models-Documentation-3.6| Models Module]] (Alex Yarmarkovich) | ||
*[[Modules:Fiducials-Documentation-3.6| Fiducials Module]] (Nicole Aucoin) | *[[Modules:Fiducials-Documentation-3.6| Fiducials Module]] (Nicole Aucoin) | ||
*[[Modules:Measurements-Documentation-3.6 | Measurements (rulers and angles) ]] (Nicole Aucoin) | *[[Modules:Measurements-Documentation-3.6 | Measurements (rulers and angles) ]] (Nicole Aucoin) | ||
− | + | *[[Modules:ROIModule-Documentation-3.6|ROI Module]] (Alex Yarmarkovich) | |
− | + | *[[Modules:Transforms-Documentation-3.6| Transforms Module]] (Alex Yarmarkovich) | |
− | + | *[[Modules:Colors-Documentation-3.6| Color Module]] (Nicole Aucoin) | |
− | |||
− | *[[Modules:ROIModule-Documentation-3.6|ROI Module]] (Alex Yarmarkovich) | ||
− | *[[Modules: | ||
− | |||
− | |||
− | |||
− | |||
− | *[[Modules: | ||
− | + | ==Wizards== | |
*[[Modules:ChangeTracker-Documentation-3.6|ChangeTracker]] (Andriy Fedorov) | *[[Modules:ChangeTracker-Documentation-3.6|ChangeTracker]] (Andriy Fedorov) | ||
− | *[[Modules:IA_FEMesh-Documentation-3.6|IA FE Meshing Module]] (Vincent Magnotta) | + | *[[Modules:IA_FEMesh-Documentation-3.6|IA FE Meshing Module]] (Vincent Magnotta, Curt Lisle) |
− | + | ==Informatics Modules== | |
*[[Modules:FetchMI-Documentation-3.6| Fetch Medical Informatics Module]] (Wendy Plesniak, Dan Marcus) | *[[Modules:FetchMI-Documentation-3.6| Fetch Medical Informatics Module]] (Wendy Plesniak, Dan Marcus) | ||
− | |||
*[[Modules:QueryAtlas-Documentation-3.6|Query Atlas Module]] (Wendy Plesniak) | *[[Modules:QueryAtlas-Documentation-3.6|Query Atlas Module]] (Wendy Plesniak) | ||
− | + | ==Registration== | |
− | *[[Slicer3:Registration|'''Overview of all Registration Modules''' ]]: | + | *[[Slicer3:Registration|'''Overview of all Registration Modules''' ]]: This page provides guidance for selecting the module that is optimal for your task. |
− | *Fast | + | *[http://www.slicer.org/wiki/Slicer-3-6-FAQ '''Registration FAQ'''] |
− | **[[Modules:Transforms-Documentation-3.6|Transforms | + | *Fast Registration |
− | **[[Modules:AffineRegistration-Documentation-3. | + | **[[Modules:Transforms-Documentation-3.6|Transforms]]: manual & interactive rigid registration , (Alex Yarmarkovich) |
− | **[[Modules:DeformableB-SplineRegistration-Documentation-3.6|Fast | + | **[[Modules:AffineRegistration-Documentation-3.6|Fast Affine Registration]]: automated fast affine registration , (Jim Miller) |
− | *Robust | + | **[[Modules:RigidRegistration-Documentation-3.6|Fast Rigid Registration]]: automated fast rigid (6 DOF) registration , (Jim Miller) |
− | **[[Modules:RegisterImages-Documentation-3.6| | + | **[[Modules:DeformableB-SplineRegistration-Documentation-3.6|Fast Nonrigid BSpline Registration]]: fast non-rigid registration , (Bill Lorensen) |
− | **[[Modules:RegisterImagesMultiRes-Documentation-3.6|Robust Multiresolution Affine | + | *Robust Registration |
− | *Brain Only | + | **[[Modules:RegisterImages-Documentation-3.6|Expert Automated Registration]]: automated registration (rigid to affine to nonrigid) with extensive parameter options, robust initialization, variable DOF and masking options, (Casey Goodlett) |
− | **[[Modules:ACPCTransform-Documentation-3.6|ACPC Transform | + | **[[Modules:RegisterImagesMultiRes-Documentation-3.6|Robust Multiresolution Affine Registration]]: affine registration in multi-resolution scheme, robust to large differences in initial position or image content , (Casey Goodlett) |
− | *Non-Raster-Image Data | + | ** [[Modules:BRAINSDemonWarp|BRAINSDemonWarp]] Hans Johnson (hans-johnson@uiowa.edu). |
− | **[[Modules:TransformFromFiducials-Documentation-3.6|Fiducial Registration | + | ** [[Modules:BRAINSFit|BRAINSFit]] Hans Johnson (hans-johnson@uiowa.edu). |
− | **[[Modules:PythonSurfaceICPRegistration-Documentation-3. | + | ** [[Modules:BRAINSResample|BRAINSResample]] Hans Johnson (hans-johnson@uiowa.edu). |
− | + | *Brain Only Registration | |
− | + | **[[Modules:ACPCTransform-Documentation-3.6|ACPC Transform]]: calculate a transformation to align a single brain along the AC-PC line (Nicole Aucoin) | |
− | + | *Non-Raster-Image Data Registration | |
+ | **[[Modules:TransformFromFiducials-Documentation-3.6|Fiducial Registration]]: align two sets of fiducials (translation, rigid or similarity) (Casey Goodlett) | ||
+ | **[[Modules:PythonSurfaceICPRegistration-Documentation-3.6|Surface Registration]]: automated surface-to-surface (model) registration (Luca Antiga, Daniel Blezek) | ||
+ | * [[Modules:AtlasCreator|Atlas Creator]]: create a statistical atlas (Daniel Haehn, Kilian Pohl) | ||
− | + | ==Segmentation== | |
*[[Modules:SegmentationOverview3.6|Overview]] | *[[Modules:SegmentationOverview3.6|Overview]] | ||
− | **[[Modules: | + | **[[Modules:EMSegmenter-3.6|EM Segmenter]] (Kilian Pohl) |
− | **[[Modules: | + | **[[Modules:FastMarchingSegmentation-Documentation-3.6|Fast Marching Segmentation]] (Andriy Fedorov) |
− | **[[Modules: | + | **[[Modules:OtsuThresholdSegmentation-Documentation-3.6|Otsu Threshold Segmentation]] (Bill Lorensen) |
− | **[[Modules: | + | **[[Modules:Simple Region Growing-Documentation-3.6|Simple Region Growing]] (Jim Miller, Harini Veeraraghavan) |
− | **[[Modules: | + | **[[Modules:RobustStatisticsSeg-Documentation-3.6|Robust Statistics Segmentation]] Yi Gao (yigao@gatech.edu). |
− | **[[Modules: | + | **[[Modules:BRAINSROIAuto-Documentation-3.6|BRAINSROIAuto]] Hans Johnson (hans-johnson@uiowa.edu). |
− | **[[Modules: | + | **[[Modules:GrowCutSegmentation-Documentation-3.6|Grow Cut Segmentation]] (Harini Veeraraghavan) |
− | == | + | ==Quantification== |
*[[Modules:LabelStatistics-Documentation-3.6|Label Statistics]] (Steve Pieper) | *[[Modules:LabelStatistics-Documentation-3.6|Label Statistics]] (Steve Pieper) | ||
+ | *[[Modules:PETCTFusion-Documentation-3.6 | PET/CT Fusion Module]] (Wendy Plesniak) | ||
− | + | ==Diffusion MRI== | |
− | *Diffusion MRI | + | * [[Modules:DiffusionMRIWelcome-Documentation-3.6|Diffusion MRI Welcome Module]] |
− | + | * DWI Denoising | |
− | + | **[[Modules:JointRicianLMMSEImageFilter-Documentation-3.6|Joint Rician LMMSE Image Filter]] (Antonio Tristán Vega, Santiago Aja-Fernandez) | |
− | + | **[[Modules:RicianLMMSEImageFilter-Documentation-3.6|Rician LMMSE Image Filter]] (Antonio Tristán Vega, Santiago Aja-Fernandez, Marc Niethammer, C-F Westin) | |
− | + | **[[Modules:UnbiasedNonLocalMeans-Documentation-3.6|Unbiased Non Local Means filter for DWI]] (Antonio Tristán Vega, Santiago Aja-Fernandez) | |
− | + | * Diffusion Tensor Utilities | |
− | + | **[[Modules:DiffusionTensorEstimation-Documentation-3.6|Diffusion Tensor Estimation]] (Raul San Jose Estepar) | |
− | + | **[[Modules:DiffusionTensorScalarMeasurements-Documentation-3.6 | Diffusion Tensor Scalar Measurements]] (Raul San Jose Estepar) | |
− | + | **[[Modules:ResampleDTIVolume-Documentation-3.6|Resample DTI Volume]] (Francois Budin) | |
− | + | * Tractography | |
− | + | **[[Modules:ROISeeding-Documentation-3.6 | Label Seeding]] (Raul San Jose Estepar) | |
− | + | **[[Modules:FiducialSeeding-Documentation-3.6|Fiducial Seeding]] (Alex Yarmarkovich, Steve Pieper) | |
− | + | **[[Modules:DTIDisplay-Documentation-3.6|FiberBundles]] (Alex Yarmarkovich) | |
− | + | **[[Modules:StochasticTractography-Documentation-3.6|Python Stochastic Tractography]] (Ryan Eckbo) | |
− | + | **[[Modules:ROISelect-Documentation-3.6|ROI Select]] (Lauren O'Donnell) | |
− | + | * Pipeline | |
+ | **[[GTRACT_V4 | GTRACT CLI tools]] (Vincent Magnotta) | ||
− | + | ==IGT== | |
*[[Modules:OpenIGTLinkIF-Documentation-3.6| OpenIGTLinkIF Module]] (Junichi Tokuda) | *[[Modules:OpenIGTLinkIF-Documentation-3.6| OpenIGTLinkIF Module]] (Junichi Tokuda) | ||
*[[Modules:NeuroNav-Documentation-3.6| NeuroNav Module]] (Haiying Liu) | *[[Modules:NeuroNav-Documentation-3.6| NeuroNav Module]] (Haiying Liu) | ||
Line 142: | Line 118: | ||
*[[Modules:IGTToolSelector-Documentation-3.6 | IGT Tool Selector ]] (Andrew Wiles) | *[[Modules:IGTToolSelector-Documentation-3.6 | IGT Tool Selector ]] (Andrew Wiles) | ||
− | + | ==Time Series== | |
* [[Modules:FourDImage-Documentation-3.6|4D Image (Viewer)]] (Junichi Tokuda) | * [[Modules:FourDImage-Documentation-3.6|4D Image (Viewer)]] (Junichi Tokuda) | ||
− | + | ==Filtering== | |
− | *[[Modules:MRIBiasFieldCorrection-Documentation-3. | + | *[[Modules:N4ITKBiasFieldCorrection-Documentation-3.6|N4 Bias Field Correction]] (Andriy Fedorov) |
− | *[[Modules:CheckerboardFilter-Documentation-3.6|Checkerboard Filter]] (Bill Lorensen) | + | *[[Modules:MRIBiasFieldCorrection-Documentation-3.6|MRI Bias Field Correction]] (Sylvain Jaume) |
− | *[[Modules:HistogramMatching-Documentation-3. | + | *[[Modules:CheckerboardFilter-Documentation-3.6|Checkerboard Filter]] (Bill Lorensen, Jim Miller) |
+ | *[[Modules:HistogramMatching-Documentation-3.6|Histogram Matching]] (Bill Lorensen, Xiaodong Tao) | ||
*[[Modules:ImageLabelCombine-3.6|Image Label Combine]] (Alex Yarmarkovich) | *[[Modules:ImageLabelCombine-3.6|Image Label Combine]] (Alex Yarmarkovich) | ||
− | *[[Modules:ResampleVolume-Documentation-3.6|Resample Volume]] (Bill Lorensen) | + | *[[Modules:ThresholdImage-Documentation-3.6|Threshold Image]] (Nicole Aucoin) |
− | *[[Modules:ResampleScalarVectorDWIVolume-Documentation-3.6|Resample Scalar/Vector/DWI Volume]] (Francois Budin) | + | *[[Modules:OtsuThreshold-Documentation-3.6|Otsu Threshold]] (Bill Lorensen) |
− | *[[Modules: | + | *[[Registration:Resampling|'''Resampling Tools''']]: available resampling methods, including tools to resample in place (e.g. change resolution or voxel anisotropy etc.) |
+ | **[[Modules:ResampleVolume-Documentation-3.6|Resample Volume]] (Bill Lorensen) | ||
+ | **[[Modules:ResampleScalarVectorDWIVolume-Documentation-3.6|Resample Scalar/Vector/DWI Volume]] (Francois Budin) | ||
+ | **[[Modules:ModelTransform-Documentation-3.6|Model Transform]]: "Resample triangulated surface models" (Alex Yarmarkovich) | ||
*Arithmetic | *Arithmetic | ||
− | **[[Modules:AddImages-Documentation-3.6|Add Images]] ( | + | **[[Modules:AddImages-Documentation-3.6|Add Images]] (Harini Veeraraghavan) |
− | **[[Modules:SubtractImages-Documentation-3.6|Subtract Images]] ( | + | **[[Modules:SubtractImages-Documentation-3.6|Subtract Images]] (Harini Veeraraghavan) |
** [[Modules:CastImage-Documentation-3.6|Cast Image]] (Nicole Aucoin) | ** [[Modules:CastImage-Documentation-3.6|Cast Image]] (Nicole Aucoin) | ||
− | ** [[Modules:MaskImage-Documentation-3.6|Mask Image]] (Nicole Aucoin) | + | ** [[Modules:MaskImage-Documentation-3.6|Mask Image]] (Nicole Aucoin) Can be used to apply a mask such as a brain mask to a grey scale image |
+ | **[[Modules:MultiplyImages-Documentation-3.6|Multiply Images]] (Harini Veeraraghavan) | ||
*Denoising | *Denoising | ||
− | **[[Modules:GradientAnisotropicFilter-Documentation-3. | + | **[[Modules:GradientAnisotropicFilter-Documentation-3.6| Gradient Anisotropic Filter]] (Bill Lorensen) |
− | **[[Modules:CurvatureAnisotropicDiffusion-Documentation-3. | + | **[[Modules:CurvatureAnisotropicDiffusion-Documentation-3.6|Curvature Anisotropic Diffusion]] (Bill Lorensen) |
− | **[[Modules:GaussianBlur-Documentation-3. | + | **[[Modules:GaussianBlur-Documentation-3.6|Gaussian Blur]] (Julien Jomier, Stephen Aylward) |
− | **[[Modules:MedianFilter-Documentation-3. | + | **[[Modules:MedianFilter-Documentation-3.6|Median Filter]] (Xiaodong Tao) |
*Morphology | *Morphology | ||
− | **[[Modules:VotingBinaryHoleFilling-Documentation-3. | + | **[[Modules:VotingBinaryHoleFilling-Documentation-3.6|Voting Binary Hole Filling]] (Jim Miller) |
**[[Modules:GrayscaleFillHole-Documentation-3.6|Grayscale Fill Hole]] (Bill Lorensen) | **[[Modules:GrayscaleFillHole-Documentation-3.6|Grayscale Fill Hole]] (Bill Lorensen) | ||
**[[Modules:GrayscaleGrindPeak-Documentation-3.6|Grayscale Grind Peak]] (Bill Lorensen) | **[[Modules:GrayscaleGrindPeak-Documentation-3.6|Grayscale Grind Peak]] (Bill Lorensen) | ||
− | + | ==Surface Models== | |
*[[Modules:ModelMaker-Documentation-3.6| ModelMaker]] (Nicole Aucoin) | *[[Modules:ModelMaker-Documentation-3.6| ModelMaker]] (Nicole Aucoin) | ||
− | *[[Modules:GrayscaleModelMaker-Documentation-3.6|Grayscale Model Maker]] (Bill Lorensen) | + | *[[Modules:GrayscaleModelMaker-Documentation-3.6|Grayscale Model Maker]] (Bill Lorensen) |
*[[Modules:MeshContourSegmentation-Documentation-3.6|Mesh Contour Segmentation]] (Peter Karasev) | *[[Modules:MeshContourSegmentation-Documentation-3.6|Mesh Contour Segmentation]] (Peter Karasev) | ||
− | *[[Modules:PythonSurfaceConnectivity-Documentation-3. | + | *[[Modules:PythonSurfaceConnectivity-Documentation-3.6| Surface Connectivity]] (Luca Antiga, Daniel Blezek) |
− | *[[Modules: | + | *[[Modules:PythonSurfaceToolbox-Documentation-3.6| Surface Toolbox]] (Luca Antiga, Daniel Blezek) |
− | |||
*[[Modules:ClipModel-Documentation-3.6| Clip Model]] (Alex Yarmarkovich) | *[[Modules:ClipModel-Documentation-3.6| Clip Model]] (Alex Yarmarkovich) | ||
*[[Modules:Model_Into_Label_Volume_Documentation-3.6| Model into Label Volume]] (Nicole Aucoin) | *[[Modules:Model_Into_Label_Volume_Documentation-3.6| Model into Label Volume]] (Nicole Aucoin) | ||
+ | *[[Modules:MergeModels-Documentation-3.6| Merge Models]] (Nicole Aucoin) | ||
+ | *[[Modules:ModelMirror-Documentation-3.6| Model Mirror]] (Wendy Plesniak) | ||
+ | *[[Modules:PolyDatToLabelmap-Documentation-3.6| PolyDataToLabelmap]] (Xiaodong Tao, Nicole Aucoin) | ||
− | + | ==Converters== | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
*[[Modules:CropVolume-Documentation-3.6|Crop Volume]] (previously ExtractSubvolumeROI) (Andriy Fedorov) | *[[Modules:CropVolume-Documentation-3.6|Crop Volume]] (previously ExtractSubvolumeROI) (Andriy Fedorov) | ||
+ | *[[Modules:CreateaDicomSeries-Documentation-3.6|Create a Dicom Series]] (Xiaodong Tao) | ||
+ | *[[Modules:DicomToNRRD-3.6|Dicom to NRRD]] (Xiaodong Tao) | ||
+ | *[[Modules:OrientImages-Documentation-3.6|Orient Images]] (Xiaodong Tao) | ||
+ | *[[Modules:PythonExplodeVolumeTransform-Documentation-3.6| Explode Volume Transform]] (Luca Antiga, Daniel Blezek) | ||
− | = | + | ==Endoscopy== |
+ | * [[Modules:Endoscopy-Documentation-3.6|Virtual Endoscopy]] (Steve Pieper) | ||
− | ==Extensions | + | ==Slicer Extensions== |
− | == | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | '''Introduction''' | ||
− | *Extensions are | + | * 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. |
+ | *'''While the Slicer license is suggested, it is not required for extensions. 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. | ||
+ | * The version that is available through the extension manager is chosen by the developer of that extension | ||
+ | * Not all extensions are available on all platforms. See here for the [[Documentation-3.6:ExtensionStatus|extension status]]. | ||
+ | * In case of problems with extensions, please talk directly to the developers of the extensions. | ||
+ | * Information for developers can be found [[Slicer3:Extensions|here]]. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
'''Available Extensions''' | '''Available Extensions''' | ||
− | * [[Modules:ABC-Documentation-3.5|ABC]] Marcel Prastawa (prastawa@sci.utah.edu) (a.k.a. Atlas Based Classification) '''Not yet 3.6'''. | + | * Import/Export |
− | + | ** [[Modules:PlastimatchDICOMRT|Plastimatch > DICOM-RT Import]] Greg Sharp (gcsharp@partners.org). | |
− | * [[Modules: | + | * Segmentation |
− | + | ** [[Modules:ABC-Documentation-3.5|ABC]] Marcel Prastawa (prastawa@sci.utah.edu) (a.k.a. Atlas Based Classification) '''Not yet 3.6'''. | |
− | * [[Modules: | + | ** [[Modules:FuzzySegmentationModule|FuzzySegmentationModule]] Xiaodong Tao (taox at research.ge.com) . |
− | + | ** [[Modules:SpineSegmentation-Documentation-3.6|SpineSegmentation]] Sylvain Jaume (sylvain@csail.mit.edu). | |
− | * [[Modules: | + | ** [[Modules:SkullStripperModule|SkullStripperModule]] '''(in progress)''' Xiaodong Tao (taox AT research.ge.com). |
− | + | ** [[Modules:SPECTRE-Documentation-3.6|SPECTRE]] '''(in progress)''' Nicole Aucoin (nicole@bwh.harvard.edu), Min Chen (mchen55@jhu.edu) | |
− | * [[Modules: | + | * Registration |
− | + | **Robust | |
− | * [[Modules:CMTK|CMTK]] | + | *** [[Modules:CMTK|CMTK]] Torsten Rohlfing (torsten@synapse.sri.com) (a.k.a. Computational Morphometry Toolkit) |
− | + | *** [[Modules:HammerRegistration|HammerRegistration]] GuorongWu, XiaodongTao, JimMiller, DinggangShen (dgshen@med.unc.edu). | |
− | * [[Modules: | + | ** [[Modules:Plastimatch|Plastimatch > B-spline deformable registration]] Greg Sharp (gcsharp@partners.org). |
− | + | ** [[Modules:PlastimatchLANDWARP|Plastimatch > Landmark-based registration]] Nadya Shusharina (nshusharina@partners.org). | |
− | * [[Modules: | + | ** [[Modules:PlastimatchXFORMWARP|Plastimatch > Warping with transform]] Nadya Shusharina, Greg Sharp (gcsharp@partners.org) |
− | + | * Wizards | |
− | * [[Modules: | + | ** [[Modules:ARCTIC-Documentation-3.6|ARCTIC]] Cedric Mathieu and Clement Vachet (cvachet@email.unc.edu) (a.k.a Automatic Regional Cortical ThICkness) . |
− | + | ** [[Modules:LesionSegmentationApplications-Documentation-3.6|LesionSegmentationApplications]] Mark Scully (mark-scully[at]uiowa[dot]edu) (a.k.a. 3DSlicerLupusLesionModule) . | |
− | * [[Modules: | + | * Tractography |
− | + | ** [[Modules:EMDTIClustering-Documentation-3.6|EMFiberClusteringModule]] Mahnaz Maddah (mmaddah@alum.mit.edu) (a.k.a. Quantitative Diffusion Tools). | |
− | * [[Modules: | + | * DWI |
− | + | ** [[Modules:RicianNoiseFilter|RicianNoiseFilter]] Ross Whitaker (whitaker@cs.utah.edu) . | |
− | * [[Modules:LesionSegmentationApplications-Documentation-3.6|LesionSegmentationApplications]] Mark Scully ( | + | * Time Series |
− | + | ** [[Modules:FourDAnalysis-Documentation-3.6|4D Analysis (Time-series plotting and analysis including kinetic analysis of DCE MRI)]] Junichi Tokuda (tokuda@bwh.harvard.edu) | |
− | * [[Modules: | + | * Quantification |
− | + | ** [[Modules:LabelDiameterEstimation-Documentation-3.6|LabelDiameterEstimation]] Andriy Fedorov (fedorov@bwh.harvard.edu) . | |
− | * [[Modules:RicianNoiseFilter|RicianNoiseFilter]] Ross Whitaker (whitaker@cs.utah.edu) | + | * [[Image:Slicervmtk_logo.png|right|150px]] The Vascular Modeling Toolkit in 3D Slicer, Daniel Haehn (haehn@bwh.harvard.edu) |
− | |||
− | * [[Modules: | ||
− | |||
− | * [[Modules: | ||
− | |||
− | * [[Image:Slicervmtk_logo.png|150px]] The Vascular Modeling Toolkit in 3D Slicer, Daniel Haehn (haehn@bwh.harvard.edu) | ||
:*[[Modules:VMTKSlicerModule|VmtkSlicerModule]] prerequisite install for all VMTK plug-ins | :*[[Modules:VMTKSlicerModule|VmtkSlicerModule]] prerequisite install for all VMTK plug-ins | ||
Line 268: | Line 225: | ||
:*[[Modules:VMTKVesselEnhancement|VMTKVesselEnhancement]] providing vessel enhancement filters to highlight vascular or tubular structures | :*[[Modules:VMTKVesselEnhancement|VMTKVesselEnhancement]] providing vessel enhancement filters to highlight vascular or tubular structures | ||
+ | '''Installation Instructions''' | ||
+ | *Click on the cogwheel icon to start the extensions wizard (highlighted in red) | ||
+ | [[image:Slicertoolbar.png|Extensions Wizard]] | ||
− | |||
− | + | [[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. | ||
− | |||
− | |||
− | + | '''Info for Developers''' | |
+ | For explanations for developers see [[Slicer3:Extensions| here]] | ||
− | + | =Other information= | |
+ | '''Developer Tools''' | ||
+ | *[[Modules:Cameras-Documentation-3.6| Camera Module]] (Sebastian Barre) | ||
+ | *Note: most developer tools are not documented for end users, but contain comments in the source code | ||
+ | *[[Modules:GaussianBlurBatch-Documentation-3.6|Gaussian Blur batch]] (Julien Jomier, Stephen Aylward) | ||
+ | *[[Modules:RegisterImagesBatch-Documentation-3.6|Register Images batch]] (Julien Finet, Stephen Aylward) | ||
+ | *[[Modules:ResampleVolumeBatch-Documentation-3.6|Resample Volume batch]] (Julien Finet) | ||
'''Non-SPL Supported Compatibility Packages''' | '''Non-SPL Supported Compatibility Packages''' | ||
+ | * [[Modules:BioImageSuite|BioImageSuite]] Xenios Papademtrios '''Not yet 3.6''' | ||
− | |||
− | + | '''QA Table''' | |
+ | |||
[[Slicer-3.6-QA|Slicer 3.6 QA table]] | [[Slicer-3.6-QA|Slicer 3.6 QA table]] |
Latest revision as of 17:05, 21 November 2019
Home < Documentation < 3.6
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
Contents
Introduction
3D Slicer is a flexible platform that can be easily extended to enable development of both interactive and batch processing tools for a variety of applications.
3D Slicer provides image registration, processing of DTI (diffusion tractography), an interface to external devices for image guidance support, and GPU-enabled volume rendering, among other capabilities. 3D Slicer has a modular organization that allows the easy addition of new functionality and provides a number of generic features not available in competing tools. Finally, 3D Slicer is distributed under a non-restrictive BSD license.
The interactive visualization capabilities of 3D Slicer include the ability to display arbitrarily oriented image slices, build surface models from image labels, and high performance volume rendering. 3D Slicer also supports a rich set of annotation features (fiducials and measurement widgets, customized colormaps). To the best of our knowledge, no individual segmentation tool provides such powerful visualization capabilities for the user as 3D Slicer. (These paragraphs were provided by A. Fedorov and C. Lisle)
The 3.6 release of 3D Slicer contains significant changes both to the organization of the software and to the functionality. Please check the 3.6 Announcement page for a list of those changes. The community contributing to Slicer 3.6 is acknowledged here.
- For information on how to use Slicer 3.6 please go to the training pages.
- For information on how to obtain Slicer 3.6 please go to the Download Pages.
- For sample data see here
- For documentation on other versions of Slicer see here
- For a FAQ see here
- Slicer version 3 build instructions for developers
- For an overview on how to load your data, see here
Main GUI
- Main Application GUI (Wendy Plesniak)
- "Hot-keys" and Keyboard Shortcuts (Wendy Plesniak)
- Loading Data (scenes, DICOM, volumes, models, fiducials, transforms, etc.) (Wendy Plesniak)
- Saving Data (scenes, volumes, models, fiducials, transforms, etc.) (Wendy Plesniak)
- Creating and Restoring Scene Snapshots (Wendy Plesniak)
- Setting up and using stereoscopic viewing (Curt Lisle, Wendy Plesniak)
- Extensions Management Wizard (Wendy Plesniak)
Modules
Core
- Welcome Module (Wendy Plesniak, Steve Pieper, Sonia Pujol, Ron Kikinis)
- Data Module (Alex Yarmarkovich)
- Volumes Module (Alex Yarmarkovich, Steve Pieper)
- Diffusion Editor (Kerstin Kessel)
- Slices Module (Jim Miller)
- Volume Rendering Module (Yanling Liu, Alex Yarmarkovich)
- Editor (Steve Pieper)
- Models Module (Alex Yarmarkovich)
- Fiducials Module (Nicole Aucoin)
- Measurements (rulers and angles) (Nicole Aucoin)
- ROI Module (Alex Yarmarkovich)
- Transforms Module (Alex Yarmarkovich)
- Color Module (Nicole Aucoin)
Wizards
- ChangeTracker (Andriy Fedorov)
- IA FE Meshing Module (Vincent Magnotta, Curt Lisle)
Informatics Modules
- Fetch Medical Informatics Module (Wendy Plesniak, Dan Marcus)
- Query Atlas Module (Wendy Plesniak)
Registration
- Overview of all Registration Modules : This page provides guidance for selecting the module that is optimal for your task.
- Registration FAQ
- Fast Registration
- Transforms: manual & interactive rigid registration , (Alex Yarmarkovich)
- Fast Affine Registration: automated fast affine registration , (Jim Miller)
- Fast Rigid Registration: automated fast rigid (6 DOF) registration , (Jim Miller)
- Fast Nonrigid BSpline Registration: fast non-rigid registration , (Bill Lorensen)
- Robust Registration
- Expert Automated Registration: automated registration (rigid to affine to nonrigid) with extensive parameter options, robust initialization, variable DOF and masking options, (Casey Goodlett)
- Robust Multiresolution Affine Registration: affine registration in multi-resolution scheme, robust to large differences in initial position or image content , (Casey Goodlett)
- BRAINSDemonWarp Hans Johnson (hans-johnson@uiowa.edu).
- BRAINSFit Hans Johnson (hans-johnson@uiowa.edu).
- BRAINSResample Hans Johnson (hans-johnson@uiowa.edu).
- Brain Only Registration
- ACPC Transform: calculate a transformation to align a single brain along the AC-PC line (Nicole Aucoin)
- Non-Raster-Image Data Registration
- Fiducial Registration: align two sets of fiducials (translation, rigid or similarity) (Casey Goodlett)
- Surface Registration: automated surface-to-surface (model) registration (Luca Antiga, Daniel Blezek)
- Atlas Creator: create a statistical atlas (Daniel Haehn, Kilian Pohl)
Segmentation
- Overview
- EM Segmenter (Kilian Pohl)
- Fast Marching Segmentation (Andriy Fedorov)
- Otsu Threshold Segmentation (Bill Lorensen)
- Simple Region Growing (Jim Miller, Harini Veeraraghavan)
- Robust Statistics Segmentation Yi Gao (yigao@gatech.edu).
- BRAINSROIAuto Hans Johnson (hans-johnson@uiowa.edu).
- Grow Cut Segmentation (Harini Veeraraghavan)
Quantification
- Label Statistics (Steve Pieper)
- PET/CT Fusion Module (Wendy Plesniak)
Diffusion MRI
- Diffusion MRI Welcome Module
- DWI Denoising
- Joint Rician LMMSE Image Filter (Antonio Tristán Vega, Santiago Aja-Fernandez)
- Rician LMMSE Image Filter (Antonio Tristán Vega, Santiago Aja-Fernandez, Marc Niethammer, C-F Westin)
- Unbiased Non Local Means filter for DWI (Antonio Tristán Vega, Santiago Aja-Fernandez)
- Diffusion Tensor Utilities
- Diffusion Tensor Estimation (Raul San Jose Estepar)
- Diffusion Tensor Scalar Measurements (Raul San Jose Estepar)
- Resample DTI Volume (Francois Budin)
- Tractography
- Label Seeding (Raul San Jose Estepar)
- Fiducial Seeding (Alex Yarmarkovich, Steve Pieper)
- FiberBundles (Alex Yarmarkovich)
- Python Stochastic Tractography (Ryan Eckbo)
- ROI Select (Lauren O'Donnell)
- Pipeline
- GTRACT CLI tools (Vincent Magnotta)
IGT
- OpenIGTLinkIF Module (Junichi Tokuda)
- NeuroNav Module (Haiying Liu)
- ProstateNav Module (Junichi Tokuda, Andras Lasso)
- Collect Patient Fiducials (Andrew Wiles)
- IGT Tool Selector (Andrew Wiles)
Time Series
- 4D Image (Viewer) (Junichi Tokuda)
Filtering
- N4 Bias Field Correction (Andriy Fedorov)
- MRI Bias Field Correction (Sylvain Jaume)
- Checkerboard Filter (Bill Lorensen, Jim Miller)
- Histogram Matching (Bill Lorensen, Xiaodong Tao)
- Image Label Combine (Alex Yarmarkovich)
- Threshold Image (Nicole Aucoin)
- Otsu Threshold (Bill Lorensen)
- Resampling Tools: available resampling methods, including tools to resample in place (e.g. change resolution or voxel anisotropy etc.)
- Resample Volume (Bill Lorensen)
- Resample Scalar/Vector/DWI Volume (Francois Budin)
- Model Transform: "Resample triangulated surface models" (Alex Yarmarkovich)
- Arithmetic
- Add Images (Harini Veeraraghavan)
- Subtract Images (Harini Veeraraghavan)
- Cast Image (Nicole Aucoin)
- Mask Image (Nicole Aucoin) Can be used to apply a mask such as a brain mask to a grey scale image
- Multiply Images (Harini Veeraraghavan)
- Denoising
- Gradient Anisotropic Filter (Bill Lorensen)
- Curvature Anisotropic Diffusion (Bill Lorensen)
- Gaussian Blur (Julien Jomier, Stephen Aylward)
- Median Filter (Xiaodong Tao)
- Morphology
- Voting Binary Hole Filling (Jim Miller)
- Grayscale Fill Hole (Bill Lorensen)
- Grayscale Grind Peak (Bill Lorensen)
Surface Models
- ModelMaker (Nicole Aucoin)
- Grayscale Model Maker (Bill Lorensen)
- Mesh Contour Segmentation (Peter Karasev)
- Surface Connectivity (Luca Antiga, Daniel Blezek)
- Surface Toolbox (Luca Antiga, Daniel Blezek)
- Clip Model (Alex Yarmarkovich)
- Model into Label Volume (Nicole Aucoin)
- Merge Models (Nicole Aucoin)
- Model Mirror (Wendy Plesniak)
- PolyDataToLabelmap (Xiaodong Tao, Nicole Aucoin)
Converters
- Crop Volume (previously ExtractSubvolumeROI) (Andriy Fedorov)
- Create a Dicom Series (Xiaodong Tao)
- Dicom to NRRD (Xiaodong Tao)
- Orient Images (Xiaodong Tao)
- Explode Volume Transform (Luca Antiga, Daniel Blezek)
Endoscopy
- Virtual Endoscopy (Steve Pieper)
Slicer Extensions
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.
- While the Slicer license is suggested, it is not required for extensions. 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.
- The version that is available through the extension manager is chosen by the developer of that extension
- Not all extensions are available on all platforms. See here for the extension status.
- In case of problems with extensions, please talk directly to the developers of the extensions.
- Information for developers can be found here.
Available Extensions
- Import/Export
- Plastimatch > DICOM-RT Import Greg Sharp (gcsharp@partners.org).
- Segmentation
- ABC Marcel Prastawa (prastawa@sci.utah.edu) (a.k.a. Atlas Based Classification) Not yet 3.6.
- FuzzySegmentationModule Xiaodong Tao (taox at research.ge.com) .
- SpineSegmentation Sylvain Jaume (sylvain@csail.mit.edu).
- SkullStripperModule (in progress) Xiaodong Tao (taox AT research.ge.com).
- SPECTRE (in progress) Nicole Aucoin (nicole@bwh.harvard.edu), Min Chen (mchen55@jhu.edu)
- Registration
- Robust
- CMTK Torsten Rohlfing (torsten@synapse.sri.com) (a.k.a. Computational Morphometry Toolkit)
- HammerRegistration GuorongWu, XiaodongTao, JimMiller, DinggangShen (dgshen@med.unc.edu).
- Plastimatch > B-spline deformable registration Greg Sharp (gcsharp@partners.org).
- Plastimatch > Landmark-based registration Nadya Shusharina (nshusharina@partners.org).
- Plastimatch > Warping with transform Nadya Shusharina, Greg Sharp (gcsharp@partners.org)
- Robust
- Wizards
- ARCTIC Cedric Mathieu and Clement Vachet (cvachet@email.unc.edu) (a.k.a Automatic Regional Cortical ThICkness) .
- LesionSegmentationApplications Mark Scully (mark-scully[at]uiowa[dot]edu) (a.k.a. 3DSlicerLupusLesionModule) .
- Tractography
- EMFiberClusteringModule Mahnaz Maddah (mmaddah@alum.mit.edu) (a.k.a. Quantitative Diffusion Tools).
- DWI
- RicianNoiseFilter Ross Whitaker (whitaker@cs.utah.edu) .
- Time Series
- 4D Analysis (Time-series plotting and analysis including kinetic analysis of DCE MRI) Junichi Tokuda (tokuda@bwh.harvard.edu)
- Quantification
- LabelDiameterEstimation Andriy Fedorov (fedorov@bwh.harvard.edu) .
- The Vascular Modeling Toolkit in 3D Slicer, Daniel Haehn (haehn@bwh.harvard.edu)
- VmtkSlicerModule prerequisite install for all VMTK plug-ins
- VMTKCenterlines providing centerline computation of surface models
- VMTKEasyLevelSetSegmentation providing level-set segmentation of vessels, aneurysms and tubular structures using an easy interface
- VMTKLevelSetSegmentation providing level-set segmentation of vessels, aneurysms and tubular structures using different algorithms for initialization and evolution
- VMTKVesselEnhancement providing vessel enhancement filters to highlight vascular or tubular structures
Installation Instructions
- Click on the cogwheel icon to start the extensions wizard (highlighted in red)
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.
Info for Developers
For explanations for developers see here
Other information
Developer Tools
- Camera Module (Sebastian Barre)
- Note: most developer tools are not documented for end users, but contain comments in the source code
- Gaussian Blur batch (Julien Jomier, Stephen Aylward)
- Register Images batch (Julien Finet, Stephen Aylward)
- Resample Volume batch (Julien Finet)
Non-SPL Supported Compatibility Packages
- BioImageSuite Xenios Papademtrios Not yet 3.6
QA Table