Difference between revisions of "Documentation/3.4"

From Slicer Wiki
Jump to: navigation, search
Line 31: Line 31:
 
| style="background: #ebeced"|[[Image:SlicerHelpExample.png|center|200px]][[Image:SlicerAcknowledgementExample.png|center|200px]]  
 
| style="background: #ebeced"|[[Image:SlicerHelpExample.png|center|200px]][[Image:SlicerAcknowledgementExample.png|center|200px]]  
 
|}
 
|}
 +
 +
==Overview==
 +
*The documentation below has been created for Slicer 3.4 and discusses the features and capabilities of menu items and panels. It is intended to be used as a live reference manual. This is a wiki. You are welcome to add to the content and improve it.
 +
*In addition to the hundereds of smaller changes and improvements to Slicer in general, there are two substantial new addtions to Slicer 3.4:
 +
**a new infrastructure to find and add plug-ins from a repository. See [[Documentation-3.4#Modules_for_Downloading|here]] for more information.
 +
  
 
==Main GUI==
 
==Main GUI==

Revision as of 12:20, 12 March 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 Acknowledgment 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.
    • Style Guide: All acknowledgment icons should be 100x100 pixels, preferably in png format.
    • Accessing logos: Icons for BIRN, NAC, NA-MIC and IGT are included in Slicer3/Base/GUI//vtkSlicerBaseAcknowledgementLogoIcons.cxx/h and resources for them are in Slicer3/Base/GUI/Resources/vtkSlicerBaseAcknowledgementLogos_ImageData.h. The API for vtkSlicerModuleGUI provides access to these icons.
    • Adding logos: Please add additional image resources and logo icons to these files as required in order to promote shared use (and to prevent duplication in the code.)
  • If your module has documentation in Slicer 3.2, please copy/paste/update into the 3.4 version
Examples for the Help and

Acknowledgment Panels

SlicerHelpExample.png
SlicerAcknowledgementExample.png

Overview

  • The documentation below has been created for Slicer 3.4 and discusses the features and capabilities of menu items and panels. It is intended to be used as a live reference manual. This is a wiki. You are welcome to add to the content and improve it.
  • In addition to the hundereds of smaller changes and improvements to Slicer in general, there are two substantial new addtions to Slicer 3.4:
    • a new infrastructure to find and add plug-ins from a repository. See here for more information.


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 Acknowledgment Tabs
  • To put your lab's logo into a module, see here

Core




Other Modules

Please adhere to the naming scheme for the module documentation:

  • [ [Modules:MyModuleNameNoSpaces-Documentation-3.4|My Module Name With Spaces] ] (First Last Name)

Wizards

Informatics Modules

Registration

Segmentation

  • EM Segment Command-Line (Brad Davis, Will Schroeder)
  • EM Segment Simple (Brad Davis, Will Schroeder)
  • EMSegmentTemplateBuilder (Brad Davis, Will Schroeder)
  • Simple Region Growing (Jim Miller)
  • Otsu Threshold (Bill Lorensen)

Statistics

DWI and Tractography

DWI

DTI

IGT

Filtering

Surface Models

  • Modelmaker (Nicole Aucoin)
  • Grayscale Model Maker (Bill Lorensen)

Batch processing

Converters

Work in Progress

Developer Tools

Documented Modules

(please do not touch this section for now. Ron)

Main GUI

Modules

Core and Loadable Modules

CLI Modules

Modules for Downloading

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.

Work is in progress to create infrastructure for searching an loading modules. See here for more information.