Difference between revisions of "Documentation/3.4"

From Slicer Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
 
Note: This page is currently under construction
 
Note: This page is currently under construction
  
Line 31: Line 32:
 
*To put your lab's logo into a module, see [[Slicer3:Execution_Model_Documentation#Adding_Module_Logos_to_Slicer3|here]]
 
*To put your lab's logo into a module, see [[Slicer3:Execution_Model_Documentation#Adding_Module_Logos_to_Slicer3|here]]
 
===Core===
 
===Core===
 +
 
*[[Modules:Welcome-Documentation-3.4| Welcome Module]] (Wendy Plesniak, Steve Pieper, Sonia Pujol, Ron Kikinis)
 
*[[Modules:Welcome-Documentation-3.4| Welcome Module]] (Wendy Plesniak, Steve Pieper, Sonia Pujol, Ron Kikinis)
 
 
  
 
*[[Modules:Volumes-Documentation-3.4| Volumes Module]] (Alex Yarmarkovich, Steve Pieper)
 
*[[Modules:Volumes-Documentation-3.4| Volumes Module]] (Alex Yarmarkovich, Steve Pieper)
 
**[[Modules:Volumes:Diffusion Editor-Documentation-3.4| Diffusion Editor]] (Kerstin Kessel)
 
**[[Modules:Volumes:Diffusion Editor-Documentation-3.4| Diffusion Editor]] (Kerstin Kessel)
 
*[[Modules:Models-Documentation-3.4| Models Module]] (Alex Yarmarkovich)
 
*[[Modules:Models-Documentation-3.4| Models Module]] (Alex Yarmarkovich)
 
 
 
*[[Modules:Fiducials-Documentation-3.4| Fiducials Module]]  (Nicole Aucoin)
 
*[[Modules:Fiducials-Documentation-3.4| Fiducials Module]]  (Nicole Aucoin)
 
*[[Modules:Data-Documentation-3.4| Data Module]] (Alex Yarmarkovich)
 
*[[Modules:Data-Documentation-3.4| Data Module]] (Alex Yarmarkovich)
 
*[[Modules:Slices-Documentation-3.4|Slices Module]] (Jim Miller)
 
*[[Modules:Slices-Documentation-3.4|Slices Module]] (Jim Miller)
 
*[[Modules:Color-Documentation-3.4| Color Module]] (Nicole Aucoin)
 
*[[Modules:Color-Documentation-3.4| Color Module]] (Nicole Aucoin)
 
 
 
*[[Modules:Editor-Documentation-3.4| Interactive Editor]] (Steve Pieper)
 
*[[Modules:Editor-Documentation-3.4| Interactive Editor]] (Steve Pieper)
 
*[[Modules:ROIModule-Documentation-3.4|ROI Module]] (Alex Yarmarkovich)
 
*[[Modules:ROIModule-Documentation-3.4|ROI Module]] (Alex Yarmarkovich)
 
*[[Modules:VolumeRendering-Documentation-3.4| Volume Rendering Module]] (Alex Yarmarkovich)
 
*[[Modules:VolumeRendering-Documentation-3.4| Volume Rendering Module]] (Alex Yarmarkovich)
  
==Other Modules==
+
Additional modules may appear in this section of the menu if they are not otherwise categorized by the developer.
 +
 
 +
==Specialized Modules==
  
 
Please adhere to the naming scheme for the module documentation:
 
Please adhere to the naming scheme for the module documentation:
 
*[ [Modules:MyModuleNameNoSpaces-Documentation-3.4|My Module Name With Spaces] ] (First Last Name)
 
*[ [Modules:MyModuleNameNoSpaces-Documentation-3.4|My Module Name With Spaces] ] (First Last Name)
 +
 
===Wizards===
 
===Wizards===
 
*[[Modules:ChangeTracker-Documentation-3.4|ChangeTracker]] (Andriy Fedorov)
 
*[[Modules:ChangeTracker-Documentation-3.4|ChangeTracker]] (Andriy Fedorov)
Line 104: Line 103:
 
*[[Modules:ROISeeding-Documentation-3.4 | ROI Seeding]] (Raul San Jose Estepar)
 
*[[Modules:ROISeeding-Documentation-3.4 | ROI Seeding]] (Raul San Jose Estepar)
 
*[[Modules:FiducialSeeding-Documentation-3.4|Fiducial Seeding]] (Alex Yarmakovich, Steve Pieper)
 
*[[Modules:FiducialSeeding-Documentation-3.4|Fiducial Seeding]] (Alex Yarmakovich, Steve Pieper)
*[[Modules:DTIDisplay-Documentation-3.4|Tractography]] (Alex Yarmakovich)
+
*[[Modules:DTIDisplay-Documentation-3.4|DisplayLoadSave]] (Alex Yarmakovich)
 
*[[Modules:StochasticTractography-Documentation-3.4|Python Stochastic Tractography]] (Julien von Siebenthal)
 
*[[Modules:StochasticTractography-Documentation-3.4|Python Stochastic Tractography]] (Julien von Siebenthal)
  
Line 152: Line 151:
  
 
===Work in Progress===
 
===Work in Progress===
 
+
Various tools in development will appear here depending on the version of slicer you are using.
 
===Developer Tools===
 
===Developer Tools===
 
*[[Modules:PythonScript-Documentation-3.4| Python Script]] (Luca Antiga, Daniel Blezek)
 
*[[Modules:PythonScript-Documentation-3.4| Python Script]] (Luca Antiga, Daniel Blezek)

Revision as of 17:06, 19 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

Overview

  • The documentation on this page 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.
    • A new database using XNAT desktop. 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

Additional modules may appear in this section of the menu if they are not otherwise categorized by the developer.

Specialized 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

  • Overview:
    • The Register Images module is an integrated solution to all your registration needs, if you want to have a resampled volume as output. It provides access to rigid, affine and b-spline itk technologies.
    • The Transforms Module allows to manually align two volumes. This can be used for initial alignment.
    • Linear, affine and Deformable B-Spline modules can be used stand-alone or one after the other. They can accept transformation matrices as the start pose and produce either transforms or resampled volumes as output.
    • Transformation matrices derived from these modules can be used as input for resampling other volumes (including DTI) using the Resample Volume 2 module.
  • Register Images (Stephen Aylward, Ron Kikinis)
  • Transforms Module (Alex Yarmarkovich)
  • Linear Registration (Daniel Blezek)
  • Affine Registration (Daniel Blezek)
  • Deformable B-Spline Registration (Bill Lorensen)
  • Realign Volume (Nicole Aucoin)

Segmentation

Statistics

Diffusion

DWI

DTI

Tractography

IGT

Filtering

Surface Models

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

Batch processing

Converters

Work in Progress

Various tools in development will appear here depending on the version of slicer you are using.

Developer Tools

Modules for Downloading

Slicer on NITRC

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

  • This will allow contributors and software developers to post their own Slicer plug-ins and have them compiled against the "official" versions of Slicer.
  • Users can browse these contributed plug-ins and install them on their own versions of Slicer.


We are currently 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.

XNAT Desktop and FetchMI

  • Work is underway to use XNAT desktop (xnd) as a local database for Slicer. This database will exist in parallel with the other load and save mechanisms and will allow to download/upload individual files or entire scenes with all their dependent files.
  • Users of Slicer will have to install xnd on their computer. Once set up, the FetchMI interface will allow users to upload and download mrml scenes with all the dependent files, or individual volumes, models, other components of slicer scenes.
  • See here for a link to the download site for xnd. See here for documentation on how to install XNAT desktop on your computer.
  • On Macs and Linux you currently have to change permissions of the executable after installation.
  • In the future (summer 2009) xnd will be able to upload and download mrml scenes to xnat enterprise.
  • FetchMI is the current interface inside slicer for exploring information stored in xnd and down and upload such data.
  • See here for more information about FETCHMI

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