diff --git a/Plugins/org.mitk.gui.qt.fit.demo/documentation/UserManual/Manual.dox b/Plugins/org.mitk.gui.qt.fit.demo/documentation/UserManual/Manual.dox index c1da7391ae..a921ef4b7f 100644 --- a/Plugins/org.mitk.gui.qt.fit.demo/documentation/UserManual/Manual.dox +++ b/Plugins/org.mitk.gui.qt.fit.demo/documentation/UserManual/Manual.dox @@ -1,17 +1,23 @@ /** \page org_mitk_views_fit_demo The Model Fit Demo View \imageMacro{fit_demo_doc.svg,"Icon of the Fit Demo View",3.0} \tableofcontents \section FIT_DEMO_Introduction Introduction -This plugin is a very simple demo plugin that allows 1) to generate a demo 3D+t image (with linear increasing values) and 2) to perform a linear fit on a selected node. -It was/is use to demonstrate basic principle and to generate example fit sessions for demo and testing purposes (e.g. functionality of the fit inspector). +The Fit Generator Demo View is a very simple demo view that allows 1) to generate a demo 3D+t image (with linear increasing values, model parameters are slope and offset) and 2) to perform a linear fit on a selected node. +The purpose of this view is to demonstrate the basic principle of MITK's model fit functionality and to generate example fit sessions for demo and testing purposes (e.g. the functionality of the fit inspector). + +\section FIT_DEMO_Usage Usage + +To run the demo please follow these steps:\n + +1. Press the button Generate test data to create 3D+t demo data. Alternatively, you can also load a different data set of your choice. +2. Choose the data node that should be used as Selected Time Series input. You can optionally create a mask on the data set and select it by pressing "CTRL" and the selected mask node. +3. Press Start Modelling to start the fitting process. +4. Wait and see... +5. The output nodes slope, offset, x-intercept and fit evaluation parameters can be found as child nodes of the chosen input. -\section FIT_DEMO_Contact Contact information -This plug-in is being developed by the SIDT group (Software development for Integrated Diagnostics -and Therapy) at the German Cancer Research Center (DKFZ). If you have any questions, need support, -find a bug or have a feature request, feel free to contact us at www.mitk.org. */