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

From Slicer Wiki
Jump to: navigation, search
Line 27: Line 27:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
Most frequently used for these scenarios:
+
Most frequently used to:
  
* Use Case 1: This can be used to set up a series of predefined starting points for looking at portions of your data in detail. For example, you may have one overview scene which shows an external view of the body along with interior views with the skin surface turned off and slice planes visible to highlight a tumor location.  
+
*Set up a series of predefined starting points for looking at portions of your data in detail.  
* Use Case 2: To compare the output of algorithms.
+
**For example, you may have one overview scene which shows an external view of the body along with interior views with the skin surface turned off and slice planes visible to highlight a tumor location.  
 +
* Compare the output of algorithms.
  
{|
+
<!-- ---------------------------- -->
|[[image:Slicer44-SceneViews-2014-11-17.jpeg|thumb|200px|Scene views]]
+
{{documentation/{{documentation/version}}/module-section|How to Use}}
|-
+
 
| [[File:Slicer44-ScreenSnapshot.jpeg|thumb|200px|Screen snapshot]]
+
<gallery widths=300px heights=250px class="center">
| Click on the camera to create a new scene view. It pops up a screen capture window that allows you to associate an image with the scene view.
+
File:Slicer44-SceneViews-2014-11-17.jpeg
You can choose to save an image of the full layout, just the 3D view or just one of the slice views. You can also add a description and change the name.
+
File:Slicer44-ScreenSnapshot.jpeg |Click on the camera to create a new scene view. It pops up a screen capture window that allows you to associate an image with the scene view. You can choose to save an image of the full layout, just the 3D view or just one of the slice views. You can also add a description and change the name.
|-
+
File:Slicer44-SceneViewGUI.jpeg| As scene views are saved, they appear in the Create and Edit box and the count is incremented next to the camera. Click on the image thumbnail or the description to edit the image, name, description. You can delete a scene view by pressing the garbage can button.  
|[[File:Slicer44-SceneViewGUI.jpeg|thumb|200px|Scene views]]
+
File:Slicer4CaptureToolbar.png | You can also save and restore scene views and screen snapshots from the Capture toolbar.
| As scene views are saved, they appear in the Create and Edit box and the count is incremented next to the camera. Click on the image thumbnail or the description to edit the image, name, description.
+
</gallery>
You can delete a scene view by pressing the garbage can button.  
 
To restore a scene view, taking the program back to the state it was in when you saved that scene view, click on the green arrow restore button.
 
|-
 
|[[File:Slicer4CaptureToolbar.png|thumb|200px|Capture Toolbar]]
 
|You can also save and restore scene views and screen snapshots from the Capture toolbar.
 
|}
 
  
 
The scene views are saved in the MRML file, via the File->Save menu.
 
The scene views are saved in the MRML file, via the File->Save menu.
Line 62: Line 57:
 
-->
 
-->
  
{|
+
[[File:Slicer44-SceneViewGUI.jpeg|thumb|200px|right|Scene views module]]
|-
+
'''Create and Edit Panel'''
|[[File:Slicer44-SceneViewGUI.jpeg|thumb|200px|Scene views module]]
 
|'''Create and Edit Panel'''
 
 
*Create a 3D Slicer Scene View
 
*Create a 3D Slicer Scene View
 
**Click on the camera to create a new scene view
 
**Click on the camera to create a new scene view
Line 78: Line 71:
 
**Description
 
**Description
 
***Some descriptive text about this scene view. Double click to edit it.
 
***Some descriptive text about this scene view. Double click to edit it.
|}
 
  
{|
+
 
|-
+
 
| [[File:Slicer5-SceneViews-PETCT-New.jpeg|thumb|200px|New scene view]]
+
[[File:Slicer5-SceneViews-PETCT-New.jpeg|thumb|200px|right|New scene view]]
|'''3D Slicer SceneView New Dialog'''
+
'''3D Slicer SceneView New Dialog'''
 
*Name
 
*Name
 
**Edit the name of the scene view here
 
**Edit the name of the scene view here
Line 94: Line 86:
 
* Description
 
* Description
 
**Edit the description of the scene view
 
**Edit the description of the scene view
|}
 
  
{|
+
 
|-
+
 
| [[File:Slicer4-SceneViews-PETCT.jpeg|thumb|200px|Edit scene view]]
+
[[File:Slicer4-SceneViews-PETCT.jpeg|right|thumb|200px|Edit scene view]]
|'''3D Slicer SceneView Edit Dialog'''
+
'''3D Slicer SceneView Edit Dialog'''
 
*Name
 
*Name
 
**Edit the name of the scene view here
 
**Edit the name of the scene view here
Line 105: Line 96:
 
**Edit the description of the scene view
 
**Edit the description of the scene view
 
* Thumbnail and layout type are not editable
 
* Thumbnail and layout type are not editable
|}
+
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 14:27, 29 June 2016

Home < Documentation < Nightly < Modules < SceneViews

For the stable Slicer documentation, visit the 4.10 page.

Introduction and Acknowledgements

Title: Scene Views
Author(s)/Contributor(s): Nicole Aucoin (SPL, BWH), Wendy Plesniak (SPL, BWH), Daniel Haehn (UPenn), Kilian Pohl (UPenn)
License: slicer4
Acknowledgements: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.


Contact: Nicole Aucoin, <email>nicole@bwh.harvard.edu</email>
Surgical Planning Laboratory (SPL)  
National Alliance for Medical Image Computing (NA-MIC)  
Neuroimage Analysis Center (NAC)  
University of Pennsylvania (UPenn)  

Module Description

Scene views are a convenience tool for organizing multiple 'live views' of the data in your scene.

You can create any number of views and control parameters such as the 3D view, model visibility, window layout, and other parameters.

This can be used to set up a series of predefined starting points for looking at portions of your data in detail.

For example, you may have one overview scene which shows an external view of the body along with interior views with the skin surface turned off and slice planes visible to highlight a tumor location.


WARNING: The scene views are designed to be different views of the same set of data. Adding or removing data (volumes, models etc) so that different scene views have different sets of data (MRML nodes) in them will result in unexpected behaviour. The recommended way of working with scene views is to load all of your data first, then to create scene views by hiding or showing the different elements. You can easily toggle the visibility of all of the models in the scene using the Models module, so you can use that to turn them all off and then selectively show the ones relevant to your scene view.

Use Cases

Most frequently used to:

  • Set up a series of predefined starting points for looking at portions of your data in detail.
    • For example, you may have one overview scene which shows an external view of the body along with interior views with the skin surface turned off and slice planes visible to highlight a tumor location.
  • Compare the output of algorithms.

How to Use

The scene views are saved in the MRML file, via the File->Save menu.

Tutorials

N/A

Panels and their use

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


Scene views module

Create and Edit Panel

  • Create a 3D Slicer Scene View
    • Click on the camera to create a new scene view
  • Delete selected view
    • Click on the garbage can button to delete the scene view
  • Edit view
    • Click on the thumbnail of the scene view to edit it (change the name, description)
    • Restore
      • Click on the green arrow button to restore this scene view, making it the currently active scene
    • Name
      • The short name given to this scene view.
    • Description
      • Some descriptive text about this scene view. Double click to edit it.


New scene view

3D Slicer SceneView New Dialog

  • Name
    • Edit the name of the scene view here
  • Thumbnail and layout type: click on a radio button to update the screen shot image
    • Full Layout: captures the 3D window and all slice views
    • 3D View: captures just the 3D view
    • Red Slice View: captures just the red 2D slice
    • Yellow Slice View: captures just the yellow 2D slice
    • Green Slice View: captures just the green 2D slice
  • Description
    • Edit the description of the scene view


Edit scene view

3D Slicer SceneView Edit Dialog

  • Name
    • Edit the name of the scene view here
  • Description
    • Edit the description of the scene view
  • Thumbnail and layout type are not editable


Similar Modules

  • The Capture tool bar has similar functionality.

References

N/A

Information for Developers