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

From Slicer Wiki
Jump to: navigation, search
(Created page with '<!-- ---------------------------- --> {{documentation/{{documentation/version}}/module-header}} <!-- ---------------------------- --> <!-- ---------------------------- --> {{doc…')
 
m (Text replacement - "slicerWiki/index.php" to "wiki")
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-header}}
 
{{documentation/{{documentation/version}}/module-header}}
Line 10: Line 11:
 
Author: Wendy Plesniak, SPL<br>
 
Author: Wendy Plesniak, SPL<br>
 
Contributor1: Ron Kikinis, SPL <br>
 
Contributor1: Ron Kikinis, SPL <br>
−
Contributor2: Steve Pieper, Isomics <br>
+
Contributor2: Steve Pieper, Isomics, Inc. <br>
 
Contributor3: Sonia Pujol, SPL <br>
 
Contributor3: Sonia Pujol, SPL <br>
−
Contact: Wendy Plesniak, wjp@bwh.harvard.edu<br>
+
Contact: Wendy Plesniak, <email>wjp@bwh.harvard.edu</email><br>
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
 
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
−
|Image:Logo-splnew.jpg|Surgical Planning Laboratory
+
|{{collaborator|logo|spl}}|{{collaborator|longname|spl}}
−
|Image:Logo-isomics.png|Isomics, Inc.
+
|{{collaborator|logo|isomics}}|{{collaborator|longname|isomics}}
 +
|{{collaborator|logo|namic}}|{{collaborator|longname|namic}}
 +
|{{collaborator|logo|nac}}|{{collaborator|longname|nac}}
 
}}
 
}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
  
−
<!-- ----------------------------------------------------------------- -->
+
<!-- ---------------------------- -->
−
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
+
{{documentation/{{documentation/version}}/module-section|Module Description}}
−
<!-- ----------------------------------------------------------------- -->
+
Slicer's '''Welcome Module''' is provided to introduce new users to Slicer's basic functionality, and to provide pointers to additional useful resources.
−
{{note}}The section above is generated using the following wiki code:
 
−
<pre>
 
−
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
 
−
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
 
−
{{documentation/{{documentation/version}}/module-introduction-row}}
 
−
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>
 
−
Author: FIRSTNAME LASTNAME, AFFILIATION<br>
 
−
Contributor1: FIRSTNAME LASTNAME, AFFILIATION<br>
 
−
Contributor2: FIRSTNAME LASTNAME, AFFILIATION<br>
 
−
Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email><br>
 
−
{{documentation/{{documentation/version}}/module-introduction-row}}
 
−
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
 
−
|Image:Logo-isomics.png|Isomics, Inc. <- Replace this logo with yours
 
−
|Image:Logo-splnew.jpg|Surgical Planning Laboratory  <-Replace this logo with yours
 
−
}}
 
−
{{documentation/{{documentation/version}}/module-introduction-end}}
 
−
</pre>
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
  
 +
[[image:Slicer4WelcomeModule.jpg | center]]
  
 +
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 +
 +
Please visit the [http://www.slicer.org/wiki/Slicer_4.0:Training Slicer4 training page] for more detailed training using Slicer4.
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{documentation/{{documentation/version}}/module-section|Module Description}}
+
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
−
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.
 
  
−
<!-- ----------------------------------------------------------------- -->
+
== Load Panel ==
−
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
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|xmlurl=http://path/to/YOURMODULE.xml }}</pre>
 
  
−
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
+
This panel, which is always open, contains quick access to interfaces to:
−
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
+
* Load DICOM datasets
 +
* Load individual scalar volume datasets
 +
* Load datasets of other types (such as polygonal models), and
 +
* Download sample datasets from the internet.
  
−
Using this later template, the final syntax would be:
+
[[image:Slicer4WelcomeLoadPanel.png | left]]
−
<pre>{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
  
 +
== About Panel==
  
−
<!-- ---------------------------- -->
+
This panel contains information about 3D Slicer, including license information.
−
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
−
Most frequently used for these scenarios:
 
  
−
* Use Case 1:
+
== The Main Window Panel ==
−
* Use Case 2:
 
  
−
<!-- ---------------------------- -->
+
In this panel, a broad overview of Slicer's Application Interface is provided. Below, an image of part of this panel's information is provided.
−
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 
−
Links to tutorials that use this module
 
  
−
<!-- ---------------------------- -->
+
[[image:Slicer4WelcomeMainWindow.png | left]]
−
{{documentation/{{documentation/version}}/module-section|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:
+
== Loading and Saving Panel ==
  
−
{|style="width: 100%"
+
The Load & Save panel describes the MRML format, and various options for loading and saving scenes and individual datasets. Below is a vignette of the Load & Save panel.
−
|
 
−
* Input panel1:
 
−
** 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 1]]
 
−
|-
 
−
|
 
−
* 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]]
 
−
|}
 
  
−
<!-- ---------------------------- -->
+
[[image:Slicer4WelcomeLoadSave.png | left]]
−
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 
−
* Point to other modules that have similar functionality
 
  
−
<!-- ---------------------------- -->
+
== Display Panel ==
−
{{documentation/{{documentation/version}}/module-section|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
 
  
−
<!-- ---------------------------- -->
+
This panel contains information about the adjusting display of scenes and data, configuring application layout, and saving screen snapshots and scene configurations of interest. Below is a vignette of the Display panel.
−
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
−
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Core}}
 
  
 +
[[image:Slicer4WelcomeDisplay.png | left ]]
  
−
<!-- ----------------------------------------------------------------- -->
+
== Mouse & Keyboard Panel ==
−
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
{{note}}The section above is generated using the following wiki code:
 
−
<pre>
 
−
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
−
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
 
−
</pre>
 
  
−
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:<pre>{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}</pre>
+
The Mouse & Keyboard panel describes the use of mouse and keyboard to perform basic interactive operations in Slicer including adjusting the display of data and manipulating the 3D scene on Windows, Mac and Linux using a one- two- and three-button mouse.
  
−
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
+
[[image:Slicer4WelcomeMouse.png | left ]]
−
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
 
  
−
Using this later template, the final syntax would be:
+
== Documentation & Tutorials Panel ==
−
<pre>{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
  
 +
This panel provides links to additional information of interest.
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{documentation/{{documentation/version}}/module-footer|category=Example}}
+
{{documentation/{{documentation/version}}/module-footer}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Latest revision as of 17:04, 21 November 2019

Home < Documentation < 4.0 < Modules < SlicerWelcome


For the latest Slicer documentation, visit the read-the-docs.



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: Wendy Plesniak, SPL
Contributor1: Ron Kikinis, SPL
Contributor2: Steve Pieper, Isomics, Inc.
Contributor3: Sonia Pujol, SPL
Contact: Wendy Plesniak, <email>wjp@bwh.harvard.edu</email>

Surgical Planning Laboratory (SPL)  
Isomics, Inc.  
National Alliance for Medical Image Computing (NA-MIC)  
Neuroimage Analysis Center (NAC)  

Module Description

Slicer's Welcome Module is provided to introduce new users to Slicer's basic functionality, and to provide pointers to additional useful resources.

Slicer4WelcomeModule.jpg

Tutorials

Please visit the Slicer4 training page for more detailed training using Slicer4.

Panels and their use

Load Panel

This panel, which is always open, contains quick access to interfaces to:

  • Load DICOM datasets
  • Load individual scalar volume datasets
  • Load datasets of other types (such as polygonal models), and
  • Download sample datasets from the internet.
Slicer4WelcomeLoadPanel.png

About Panel

This panel contains information about 3D Slicer, including license information.

The Main Window Panel

In this panel, a broad overview of Slicer's Application Interface is provided. Below, an image of part of this panel's information is provided.

Slicer4WelcomeMainWindow.png

Loading and Saving Panel

The Load & Save panel describes the MRML format, and various options for loading and saving scenes and individual datasets. Below is a vignette of the Load & Save panel.

Slicer4WelcomeLoadSave.png

Display Panel

This panel contains information about the adjusting display of scenes and data, configuring application layout, and saving screen snapshots and scene configurations of interest. Below is a vignette of the Display panel.

Slicer4WelcomeDisplay.png

Mouse & Keyboard Panel

The Mouse & Keyboard panel describes the use of mouse and keyboard to perform basic interactive operations in Slicer including adjusting the display of data and manipulating the 3D scene on Windows, Mac and Linux using a one- two- and three-button mouse.

Slicer4WelcomeMouse.png

Documentation & Tutorials Panel

This panel provides links to additional information of interest.


Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/4.0/Modules/SlicerWelcome&oldid=61751"