Difference between revisions of "Documentation/Nightly/Modules/IGTWizard"

From Slicer Wiki
Jump to: navigation, search
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
#REDIRECT [[Documentation/Nightly/Extensions/IGTWizard]]
<!-- ---------------------------- -->
<!-- ---------------------------- -->
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
This work is supported by NA-MIC, NCIGT, Slicer Community, Surgical Panning Lab in the Department of Radiology at Brigham and Women's Hospital (BWH) and Biomedical Innovation Center at Shiga University of Medical Science (SUMS) in Japan.
<!-- This work is part of the National Alliance for Medical Image Computing (NA-MIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on NA-MIC can be obtained from the [http://www.na-mic.org/ NA-MIC website].<br> -->
Authors: Junichi Tokuda (BWH) and Atsushi Yamada (SUMS)<br>
Contributors: Tohru Tani (SUMS)<br>
Contact: Junichi Tokuda, <email>tokuda@bwh.harvard.edu</email>, Atsushi Yamada, <email>ayamada@belle.shiga-med.ac.jp</email><br>
License: [http://www.slicer.org/pages/LicenseText Slicer License]
|Image:SumsLogo2014.jpg|Shiga University of Medical Science in Japan
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Module Description}}
The idea behind this module is to rapidly prototype a module for a specific clinical workflow. Since Slicer 2.x there have been several efforts to create modules that provides all functionalities required for a given clinical application with an integrated GUI. The issue of such approach is that there are many duplicated codes among the modules; the developers have to copy the entire module and modify just a few parts of it even if the new clinical applications share the large part of workflow with the existing modules.
Instead of implementing all features in a module, this module only binds the existing modules that are required for given clinical applications, and allows the users to go through those modules by simply clicking the navigation buttons. This module can create the navigation buttons, save the button format as a XML format file and reuse the button format by loading it.
Here comes a description what the module is good for. Explain briefly how it works and point to the [[documentation/{{documentation/version}}/Modules/{{documentation/modulename}}#References|references]] giving more details on the algorithm.
If you are documenting a CLI, the description should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-description}}
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Use Cases}} 
The IGTWizard module is an effective tool to use existing modules and extensions without complicated mouse operations for managing clinical workflow. The module can create the wizard panel that has buttons to jump to the modules you listed, as well as "back" and "next" button to switch to the previous/next module in the clinical workflow.
<!-- ---------------------------- -->
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
* Setup panel
** Item List:
*** "Load" button can read the button format you created before.
*** "Save" button can save the button format you created. 
** Operation:
*** "+" button adds an item column in Item List.
*** "-" button removes an item column in Item List.
** Wizard Panel:
*** "Apply" button reflects the Wizard Title and the Item List you created to the wizard panel.
*** "Reset" button resets the wizard panel.
* Title panel
**Wizard Title:
*** You can edit the title for the wizard panel.
* Item List
** You can select existing modules and extensions for the wizard panel.
* Wizard Panel
** The wizard panel has the "Title" and "Item List" you applied.
*Saved button format file
<title>Function list we developed</title>
# module name and label name
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
<!-- ---------------------------- -->
[1] [http://www.na-mic.org/Wiki/index.php/2013_Project_Week:AbdominalNavigationModule Abdominal Navigation Module in 2013 Winter Project Week]<br>
[2] [https://github.com/tokjun/IGTWizard Github source code repository (https://github.com/tokjun/IGTWizard)]<br>
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
<!-- ---------------------------- -->
<!-- ---------------------------- -->

Latest revision as of 19:16, 15 January 2015

Home < Documentation < Nightly < Modules < IGTWizard