Difference between revisions of "Modules:FourDImage-Documentation-3.5"

From Slicer Wiki
Jump to: navigation, search
Line 35: Line 35:
 
== Usage ==
 
== Usage ==
 
===Quick Tour of Features and Use===
 
===Quick Tour of Features and Use===
List all the panels in your interface, their features, what they mean, and how to use them. For instance:
+
* '''Active 4D Bundle panel:''' This panel allows choosing the active time series bundle node from MRML scene. If you choose "Create New TimeSeriesBundle",
 
 
* '''Active 4D Bundle panel:'''
 
 
* '''Load / Save panel:'''
 
* '''Load / Save panel:'''
* '''Parameters panel:'''
+
* '''Control panel:'''
* '''Output panel:'''
+
* '''Editor panel:'''
* '''Viewing panel:'''
 
  
 
===Examples, Use Cases & Tutorials===
 
===Examples, Use Cases & Tutorials===

Revision as of 20:23, 30 June 2009

Home < Modules:FourDImage-Documentation-3.5

Return to Slicer 3.5 Documentation

Gallery of New Features


Module Name

4D Image Module

Caption 1
Caption 2
Caption 3

General Information

Module Type & Category

Type: Interactive

Category: 4D

Authors, Collaborators & Contact

Module Description

The 4D Image module is designed to handle a time-series of 3D volume images (4D image), e.g. fMRI, cardiac images, dynamic contrast-enhanced (DCE) images in 3D Slicer. You can do:

  • Load and save a series of 3D volume images from a directory, which contains multiple volume images.
  • Scroll through a time-series.
  • Edit (add, delete and insert) frames in a time series.

The core component of 4D Image module is time series bundle node, which is defined as a vtkMRMLScalarVolumeNode class. This special MRML node is designed to hold pointers to scalar volume nodes in the time series, and in addition, two scalar volume nodes for visualization. The two visualization scalar nodes contains byte arrays that are displayed in the 2D and 3D viewers; whenever the user scrolls the time-series, the module copies byte arrays from the scalar volume node at the current time point in the series to the nodes for visualization. This approach gives a flexibility to use the existing frame works of image processing for each scalar volume nodes in the time-series data. The reason why it holds two visualization scalar nodes is that one is used for background and the other is used for foreground for comparing two volumes at different time points.

Usage

Quick Tour of Features and Use

  • Active 4D Bundle panel: This panel allows choosing the active time series bundle node from MRML scene. If you choose "Create New TimeSeriesBundle",
  • Load / Save panel:
  • Control panel:
  • Editor panel:

Examples, Use Cases & Tutorials

  • Note use cases for which this module is especially appropriate, and/or link to examples.
  • Link to examples of the module's use
  • Link to any existing tutorials

Development

Dependencies

Other modules or packages that are required for this module's use.

Known bugs

Follow this link to the Slicer3 bug tracker.


Usability issues

Follow this link to the Slicer3 bug tracker. Please select the usability issue category when browsing or contributing.

Source code & documentation

Customize following links for your module.

Links to documentation generated by doxygen.


More Information

Acknowledgment

Include funding and other support here.

References

Publications related to this module go here. Links to pdfs would be useful.