Commit ace5db47 authored by Alexander Wiebel's avatar Alexander Wiebel
Browse files

[DOC #42] OWW2012: added documentation on how to edit the TF

parent 171d019d
//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
"Transfer Function 1D"
{
// Provide an icon. If the icon exists, it overrides the one provided by your
// getIcon method. This path is relative to your module's resource directory.
icon="WMTeamplate.png";
// Where to find the module?
website = "http://www.openwalnut.org";
// Provide a description, If you do so, this description overrides the one
// provided by your getDescription method.
// HINT: multi-line strings are not supported. Please provide long texts in
// one line.
description = "This module provides an intercative widget for manipulating one-dimensional transfer functions.";
// Help file. This should be an HTML or TXT document. Only one document allowed.
help ="help/index.html";
// Provide a list of authors. These authors can have further information associated with them.
author = "Mario Hlawitschka";
author = "OpenWalnut Project";
// Provide author information. Especially a contact address is very handy.
// This associates some URL and Mail contact info to "OpenWalnut Project".
"Mario Hlawitschka"
{
url="http://www.hlawitschka.net/";
email="Nachname [at] informatik [dot] uni - leipzig . de";
what="Design, Development and Bug fixing";
};
"OpenWalnut Project"
{
url="http://www.openwalnut.org";
email="contact@openwalnut.org";
what="Improvements and Bug fixing";
};
// Provide some tags to have modules nicely grouped and ordered.
// NOTE: tags are handled case insesitive.
// IMPORTANT: the order of appearance will be used by OW to classify your tags
tag = "DVR";
tag = "MRI";
tag = "fMRI";
};
<html>
<body>
<p>
The main purpose of the <b>Transfer Function 1D</b> module is to provide an
interface that allows the user to edit one-dimensional tranfer functions.</p>
<p>The most important and also most complex of its properties is the <b><i>Transfer
Function</i></b> property. The following image shows the property after the user has
already done some editing.</p>
<img src="editorWidget.png">
<p>
The dark areas in the background are two different representation of the
histogram of the dataset. One is a linear and one is a logarithmic version of
the histogram. The histograms provide an overview of the data's value
distribution.</p>
<p>
The curve with the dots allows to manipulate the opacity assigned to different
data values. The upside down triangles in the upper part are used to assign
certain colors to the data values (colormap).
The colors between the triangles are obtained by linear interpolation.
</p>
<h4>Usage</h4>
<p>
Both the curve and
the colormap can be adjusted by moving either the the dots or the triangles
with the left mouse button. New dots can be added by right-clicking into the
colormap. New triangles can be added by right-clicking in the area <i>above</i> the
colormap. Double-clicking with the left mouse button on one of the triangles
opens a color dialog and thus allows to change the color assigned to the
triangle. If the color dialog is open one can drag colors from the color dialog
to the different triangles.
</p>
</body>
</html>
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