Difference between revisions of "Documentation/3.4"

From Slicer Wiki
Jump to: navigation, search
Line 35: Line 35:
 
*[[Modules:ChangeTracker-Documentation-3.4|ChangeTracker]] (Andriy Fedorov)
 
*[[Modules:ChangeTracker-Documentation-3.4|ChangeTracker]] (Andriy Fedorov)
 
*[[Modules:Color-Documentation-3.4| Color Module]] (Nicole Aucoin)
 
*[[Modules:Color-Documentation-3.4| Color Module]] (Nicole Aucoin)
*[[Modules:Data-Documentation-3.4| Data Module]] (Alex Yarmakovic)
+
*[[Modules:Data-Documentation-3.4| Data Module]] (Alex Yarmarkovich)
 
*[[Modules:Editor-Documentation-3.4| Interactive Editor]] (Steve Pieper)
 
*[[Modules:Editor-Documentation-3.4| Interactive Editor]] (Steve Pieper)
 
*[[Modules:Fiducials-Documentation-3.4| Fiducials Module]]  (Nicole Aucoin)
 
*[[Modules:Fiducials-Documentation-3.4| Fiducials Module]]  (Nicole Aucoin)
 
*[[Modules:FetchMI-Documentation-3.4| Fetch Medical Informatics Module]] (Wendy Plesniak)
 
*[[Modules:FetchMI-Documentation-3.4| Fetch Medical Informatics Module]] (Wendy Plesniak)
*[[Modules:GradientAnisotropicFilter-Documentation-3.4| Gradient Anisotropic Filter]]  (Nicole Aucoin)
+
*[[Modules:GradientAnisotropicFilter-Documentation-3.4| Gradient Anisotropic Filter]]  (Bill Lorensen checked this in)
 
*[[Modules:IA_FEMesh-Documentation-3.4|IA FE Meshing Module]] (Vince Magnotta)
 
*[[Modules:IA_FEMesh-Documentation-3.4|IA FE Meshing Module]] (Vince Magnotta)
*[[Modules:Models-Documentation-3.4| Models Module]] (Alex Yarmakovic)
+
*[[Modules:Models-Documentation-3.4| Models Module]] (Alex Yarmarkovich)
 
*[[Modules:NeuroNav-Documentation-3.4| NeuroNav Module]] (Noby Hata)
 
*[[Modules:NeuroNav-Documentation-3.4| NeuroNav Module]] (Noby Hata)
 
*[[Modules:QDECModule-Documentation-3.4| QDEC Module]] (Nicole Aucoin)
 
*[[Modules:QDECModule-Documentation-3.4| QDEC Module]] (Nicole Aucoin)
 
*[[Modules:QueryAtlas-Documentation-3.4|Query Atlas Module]] (Wendy Plesniak)
 
*[[Modules:QueryAtlas-Documentation-3.4|Query Atlas Module]] (Wendy Plesniak)
*[[Modules:ROIModule-Documentation-3.4|ROI Module]] (Alex Yarmakovic)
+
*[[Modules:ROIModule-Documentation-3.4|ROI Module]] (Alex Yarmarkovich)
 
*[[Modules:Slices-Documentation-3.4|Slices Module]] (Jim Miller)
 
*[[Modules:Slices-Documentation-3.4|Slices Module]] (Jim Miller)
*[[Modules:Transforms-Documentation-3.4| Transforms Module]] (Nicole Aucoin)
+
*[[Modules:Transforms-Documentation-3.4| Transforms Module]] (Alex Yarmarkovich)
*[[Modules:VolumeRendering-Documentation-3.4| Volume Rendering Module]] (Alex Yarmakovic)
+
*[[Modules:VolumeRendering-Documentation-3.4| Volume Rendering Module]] (Alex Yarmarkovich)
 
*[[Modules:Volumes-Documentation-3.4| Volumes Module]] (Steve Pieper)
 
*[[Modules:Volumes-Documentation-3.4| Volumes Module]] (Steve Pieper)
**[[Modules:Volumes:Diffusion Editor-Documentation-3.4| Diffusion Editor]] (Kerstin Kessel)
+
*[[Modules:Volumes:Diffusion Editor-Documentation-3.4| Diffusion Editor]] (Kerstin Kessel)
  
 
==CLI Modules==
 
==CLI Modules==

Revision as of 21:03, 5 February 2009

Home < Documentation < 3.4

Note: This page is currently under construction

Introduction

This page is a portal for documentation about Slicer 3.4. For information for software developers, please go to the Developers page (see link in navigation box to the left).

How-To Tutorials

Slicer3 tutorial page

Feature Request and Problem Reports

We have an issues 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.

List of Modules in need of documentation

  • Requirements for modules to be added to the release:
    • The module is feature complete for the tasks advertised on 2-4-2009
    • The module has a test. See here for more information.
    • Module has documentation on the Slicer wiki. Please use the template provided here to structure your page.
    • Please add a pointer to the documentation on the Slicer wiki to the the Help tab of the module. See the Editor module in Slicer for an example.
    • The contributor (and their manager/advisor), the lab (with labs/institution logo) and the funding source (with grant number, logo optional) are listed in the Acknowledgement tab of the module. Please see the Models module for and example. The people listed in the acknowledgement will be the primary people for support and maintenance relative of the module.
  • If your module has documentation in Slicer 3.2, please copy/paste/update into the 3.4 version

Main GUI

Modules

  • Please copy the template linked below, paste it into your page and customize it with your module's information.

Slicer3:Module_Documentation-3.4_Template

  • See above for info to be put into the Help and Acknowledgement Tabs
  • To put your lab's logo into a module, see here

Core and Loadable Modules

CLI Modules

Please adhere to the naming scheme for the module documentation:

  • Batch processing
  • Converters
    • Create a Dicom Series
    • DICOM DWI loader
    • Dicom to NRRD
    • Orient Images
  • Demonstration
    • Execution Model Tour
    • Scripted Module Example
  • Diffusion Tensor
    • Resample DTI Volume
    • Estimation
      • Diffusion Tensor Estimation
    • Scalars
      • Diffusion Tensor Scalar Measurements
  • Filtering
    • Calculate Volume Statistics
    • Change Tracker Command-line
    • Checkerboard Filter
    • Extract Skeleton
    • Histogram Matching
    • Image Label Combine
    • Otsu Threshold
    • Resample Volume
    • Resample Volume2
    • Threshold Image
    • Voting Binary Hole Filling
    • Zero Crossing Based Edge Detection Filter
    • Arithmetic
      • Add Images
      • Subtract Images
    • DWI
      • Joint Rician LMMSE Image Filter
      • Rician LMMSE Image Filter
      • Unbiased Non Local Means filter for DWI
    • Denoising
      • Curvature Anisotropic Diffusion
      • Gaussian Blur
      • Gradient Anisotropic Diffusion
      • Median Filter
    • Morphology
      • Greyscale Fill Hole
      • Greyscale Grind Peak
  • Model Generation
    • Clip Model
    • Distance Transform Model
    • Grayscale Model Maker
    • Modelmaker
    • Model into Label Volume
    • Probe Volume with Model (Paint)
  • Python Modules
    • Python Diffusion Tensor Estimation
    • Python Explode Volume Transform
    • Python Extract Baseline DWI Volume
    • Python Gaussian Smoothing
    • Python Gradient Anisotropic Diffusion
    • Python Numpy Script
    • Python Recenter Scalar to DWI Volume
    • Python Resample Volume
    • Python Reslice as Volume
    • Python Script
    • Python Shift DWI Values
    • Python Stochastic Tractography
    • Python Surface Connectivity
    • Python Surface ICP Registration
    • Python Surface Toolbox
  • Registration
    • Affine Registration
    • Deformable B-Spline Registration
    • Diffeomorphic Demons Algorithm
    • Linear Registration
    • Realign Volume
    • Rigid Registration
    • Test Grid Transform Registration
    • (Utah) Deformable B-Spline Registration (Experimental)
  • Segmentation
    • EM Segment Command-Line
    • EM Segment Simple
    • EMSegmentTemplateBuilder
    • Freesurfer Surface Section Extraction
    • SFLS Sulci Seg
    • Simple Region Growing
  • Statistics
    • Label Statistics
  • Tractography
    • Display Load Save
    • Editor
      • ROI Select
    • Seeding
      • Fiducial Seeding
      • Seeding
    • Stochastic
      • Generate Connectivity Map
      • ROI Tract Filter
      • Stochastic Tractography Filter

Documented Modules

Main GUI

Modules

Core and Loadable Modules

CLI Modules

Modules on NITRC

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.

Click here to see a listing of Slicer 3 modules on NITRC.

This is how to get modules from NITRC into Slicer 3.4