Difference between revisions of "Documentation/4.0/Modules/ViewControllers"

From Slicer Wiki
Jump to: navigation, search
Line 20: Line 20:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
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.
+
The View Controllers module provides access to nodes controlling multiple views within a single panel. A view is a display of data packed within layout. Slice Views and 3D Views are two types of views that can appear in a layout and whose controls can also be accessed from the View Controllers module. Each type of view has a separate section of the View Controllers panel. For example, the Slice Controllers are grouped together, followed by the 3D Controllers. An extra panel allows an alternative control over a Slice View.
  
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
Line 41: Line 41:
 
Most frequently used for these scenarios:
 
Most frequently used for these scenarios:
  
* Use Case 1:
+
* Controlling Slice Views while maximizing the screen real estate for images with the view.
* Use Case 2:
+
* Controlling 3D Views without having to expand the controller within the view.
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 55: Line 55:
 
{|style="width: 100%"
 
{|style="width: 100%"
 
|
 
|
* Input panel1:
+
* Slice Controllers
** First input
+
* 3D Controllers
** Second input
+
* Slice Information
* Parameters panel:
 
** First parameter
 
** Second parameter
 
* Output panel:
 
** First output
 
** Second output
 
* Viewing panel:
 
 
| align="right" |
 
| align="right" |
[[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 1]]
+
[[Image:ViewControllers.png|thumb|280px|View Controllers]]
 
|-
 
|-
|
 
* Input panel2:
 
** First input
 
** Second input
 
* Parameters panel:
 
** First parameter
 
** Second parameter
 
* Output panel:
 
** First output
 
** Second output
 
* Viewing panel:
 
| align="right" |
 
[[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 2]]
 
 
|}
 
|}
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
* Point to other modules that have similar functionality
+
* Slice Controller on the Slice View
 +
* 3D Controller on the 3D View
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 15:25, 28 November 2011

Home < Documentation < 4.0 < Modules < ViewControllers


Introduction and Acknowledgements

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 NA-MIC website.
Author: Jim Miller, GE
Contact: Jim Miller, <email>millerjv@ge.com</email>

GE  
Itk  
NA-MIC  

Module Description

The View Controllers module provides access to nodes controlling multiple views within a single panel. A view is a display of data packed within layout. Slice Views and 3D Views are two types of views that can appear in a layout and whose controls can also be accessed from the View Controllers module. Each type of view has a separate section of the View Controllers panel. For example, the Slice Controllers are grouped together, followed by the 3D Controllers. An extra panel allows an alternative control over a Slice View.

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:

{{documentation/{{documentation/version}}/module-description|xmlurl=http://path/to/YOURMODULE.xml }}

If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:

{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}

Using this later template, the final syntax would be:

{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}


Use Cases

Most frequently used for these scenarios:

  • Controlling Slice Views while maximizing the screen real estate for images with the view.
  • Controlling 3D Views without having to expand the controller within the view.

Tutorials

Links to tutorials that use this module

Panels and their use

A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:

  • Slice Controllers
  • 3D Controllers
  • Slice Information
View Controllers

Similar Modules

  • Slice Controller on the Slice View
  • 3D Controller on the 3D View

References

Publications related to this module go here. Links to pdfs would be useful. For extensions: link to the source code repository and additional documentation

Information for Developers


Note The section above is generated using the following wiki code:

{{documentation/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}

If you are documenting a CLI, the category should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:

{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}

If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:

{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}

Using this later template, the final syntax would be:

{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}