Commit 05cef1de authored by Alexander Wiebel's avatar Alexander Wiebel

[DOC #42] some typos and formulations

parent e981296c
......@@ -23,13 +23,14 @@ assumes the standard configuration. Additionally, some described features may no
in every instance of OpenWalnut because they belong to special modules.
<h2><a name="FirstSteps" />First Steps</h2>
<a href="http://www.openwalnut.org/projects/openwalnut/wiki/FirstSteps">This</a> tutorial shows you the basic useage of OpenWalnut. You should consider reading this if you are a first time user.
<a href="http://www.openwalnut.org/projects/openwalnut/wiki/FirstSteps">This</a> tutorial shows you the basic usage of OpenWalnut. You should consider reading this if you are a first time user.
<h2><a name="MainWindow" />Main Window</h2>
This is the main window of OpenWalnut. It is divided in three parts. The navigation views, the main view and the data manipulation GUI.
This is the main window of OpenWalnut. It is divided into three parts. The navigation views, the main view and the data manipulation GUI.
<img src="images/2_overview.png"/>
<ul>
<li> 1,2, and 3 - The navigation windows. Use them for orientation and and current position.
<li> 1,2, and 3 - The navigation windows. Use them for orientation and
to select the <i>current</i> position.
<li> 4 - The main view. The main view allows interaction with the visualization and the camera in 3D.
<li> 5 - The module tree. This shows the current setup of your data flow. Use this to process data and to apply visualization.
<li> 6 - The control panel. This shows parameters and further information of the currently selected module. Use this to interact with your
......@@ -70,12 +71,12 @@ modules.
<tr><td>[Esc]</td><td>Resets main view</td></tr>
<tr><td>[F1]</td><td>Opens help window</td></tr>
</table>
<h3>ROI tree</h3>
<h3>ROI Tree</h3>
<table>
<tr><td><b><i>Key</i></b></td><td><b><i>Action</i></b></td></tr>
<tr><td>[Delete]</td><td>Removes <a href="#ROIs">ROI</a></td></tr>
</table>
<h3>Module tree</h3>
<h3>Module Tree</h3>
<table>
<tr><td><b><i>Key</i></b></td><td><b><i>Action</i></b></td></tr>
<tr><td>[Delete]</td><td>Removes module</td></tr>
......@@ -85,16 +86,20 @@ modules.
<table>
<tr><td><b>Icon&nbsp;</b></td><td><b>Name</b></td><td><b>Description</b></td></tr>
<tr><td><img src="icons/new.png" width="20"></td><td>New
Project</td><td>Removes all modules, including the data modules,
to provide a clean OpenWalnut session for a new project.
</td></tr>
<tr><td><img src="icons/fileopen.png" width="20"></td><td>Load
Dataset or Project</td><td>Loads data given in various formats or
project files. Data files can be fibers (.fib), NIfTI
images (.nii, .nii.gz) or EEG data (.cnt). Not all supported file formats
are available through this button and the dialog behind it. For some file
formats there are special modules for reading and/or writing them. Project
files (.owp) instantiate modules, sets their
files (.owp, .owproj) instantiate modules, set their
connections and orient the scene accordingly.</td></tr>
<tr><td><img src="icons/disc.png" width="20"></td><td>Save Project</td><td>Saves the current state (modules, connections, orientation of
the scene) of OpenWalnut to a project file (.owp).</td></tr>
the scene) of OpenWalnut to a project file (.owp, .owproj).</td></tr>
<tr><td><img src="icons/image.png"
width="20"></td><td>Screenshot</td><td>Stores a snapshot image of
the main view.</td></tr>
......@@ -104,7 +109,7 @@ modules.
scene.</td></tr>
<tr><td><img src="icons/box.png" width="20"></td><td>ROI</td><td>Adds a new ROI box to the 3D scene and the ROI browser. See also: <a href="#ROIs">ROIs</a>.</td></tr>
<tr><td><img src="icons/QuestionMarks.xpm" width="20"></td><td>Missing
module?</td><td>This opens the dialog that allows to customize the list of
module?</td><td>Opens the dialog that allows to customize the list of
modules that are allowed to appear in the <i>Compatible Modules</i> toolbar.</td></tr>
</table>
......@@ -113,15 +118,15 @@ A ROI (<b>r</b>egion <b>o</b>f <b>i</b>nterest) is usually used to specify a
certain area (2D) or volume (3D) that can then be accessed by
modules. Different modules will use ROIs for different purposes. The most
important purpose of ROI boxes in OpenWalnut is the selection of fibers in
conjuction with fiber display modules. It will be described in a separate
conjunction with fiber display modules. This is described in a separate
section below.
The ROIs can be moved around by dragging them with the right mouse
button. Their size can be changed by dragging one of their faces with the right
mouse button while the [Shift] key is pressed.
<h3>ROIs for selecting fibers</h3>
For the special task of selecting fiber bundles from larger sets of fibers ROIs can be
<h3>ROIs for Selecting Fibers</h3>
For the special task of selecting fiber bundles from larger sets of fibers, ROIs can be
combined in the ROI tree widget. All ROIs in the same branch of the tree are
combined using a Boolean "and" operation. The result will be a bundle
consisting only of fibers that pass through all boxes in the branch. The branches themselves are combined
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment