Documentation/4.0

Introduction

Slicer4 is moving towards release. This page contains both the guidelines and the documentation for Slicer 4.0.

Requirements for Modules

• The module is feature complete, i.e. it does everything that it advertises
• The module has a test. See here for more information.
• The module is fully documented. See here for the end-user documentation template.
• The module complies with Rons rules for tool and the style guide lines, including color palette.

Main GUI

• Main Application GUI (xx)
• "Hot-keys" and Keyboard Shortcuts (xx)
• Loading Data (scenes, DICOM, volumes, models, fiducials, transforms, etc.) (xx)
• Saving Data (scenes, volumes, models, fiducials, transforms, etc.) (xx)
• Creating and Restoring Scene Snapshots (xx)
• Setting up and using stereoscopic viewing (Curt Lisle, xx)
• Extensions Management Wizard (xx)

Modules by Category

Core

• Annotations (???)
• Colors (???)
• Data (???)
• DICOM (Steve Pieper)
• Editor (Steve Pieper)
• Models (Nicole Aucoin)
• SceneViews (Nicole Aucoin)
• Slicer Welcome (Wendy Plesniak)
• Transforms (???)
• View Controllers (Jim Miller)
• Volumes (???)
• Volume Rendering (???)

Filtering

• Denoising
  • Gradient Anisotropic Diffusion (Jim Miller)
• N4ITK Bias Field Correction (Andrey Fedorov)

Converters

• Create a Dicom Series (Bill Lorensen)

Endoscopy

• Endoscopy (Steve Pieper)

Quantification

• Label Statistics (Steve Pieper)

Developer Tools

• Cameras (???)
• EventBroker (Julien Finet)

Extensions

Introduction

• Slicer Extensions are the "on-ramp" to the Slicer "highway". What they provide is a mechanism for anybody, including third parties, to provide modules which extend the functionality of 3d Slicer.
• While the Slicer license is suggested for extensions, it is not required. 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.
• In case of problems with extensions, please talk directly to the developers of the extensions.
• Information for developers can be found here. See here for the end-user documentation template.
• In Slicer 4, all new modules will begin as "Immature Extensions". They will progress to the status of "Mature Extensions", when they meet all the criteria listed below. In order to become part of the main Slicer distribution a discussion with the Slicer core team will have to be initiated after reaching the mature extension status.

Collections

Collections are groups of extensions that can be downloaded in a single operation. You can think of them as the equivalent to a playlist.

id	Thumbnail	Name	Short Description	Maturity	Slicer License	Search terms	Contact Information
1		MyCollection	This is a collection of extensions that will do something miraculous with your images			segmentation, level set	my-email at mit.edu

Table Of Extensions

id	Thumbnail	Name	Short Description	Maturity	Slicer License	Search terms	Contact Information
1		MyExtension	This is an extension that will do something wonderful with your data			filter, anisotropic	my-email at gmail.com
2		MyExtension	This is an extension that will do something miraculous with your images			segmentation, level set	my-email at mit.edu

Caption for the table of extensions

• 

  Distributed under the Slicer License

• 

  Distributed under a Non Slicer License

• 

  
  *Work in progress
  *Use with care
  *Might not work all the time
  *Might not be available for all platforms

• 

  
  *Full documentation
  *Works as advertised
  * Compiles on all platforms for the stable release
  * Email support works