diff --git a/Plugins/org.mitk.gui.qt.datamanager/documentation/UserManual/QmitkDatamanager.dox b/Plugins/org.mitk.gui.qt.datamanager/documentation/UserManual/QmitkDatamanager.dox index d06d0340e4..e80cdc05ae 100644 --- a/Plugins/org.mitk.gui.qt.datamanager/documentation/UserManual/QmitkDatamanager.dox +++ b/Plugins/org.mitk.gui.qt.datamanager/documentation/UserManual/QmitkDatamanager.dox @@ -1,109 +1,132 @@ /** \page org_mitk_views_datamanager DataManager \imageMacro{data-manager.svg,"Icon of the Data Manager",2.00} \tableofcontents -\section QmitkDataManagerIntroduction Introduction +\section DataManagerIntroduction Introduction -The Datamanager is the central componenent to manage medical data like images, surfaces, etc.. -After loading one or more data into the Datamanager the data are shown in the four-view window, the so called Standard View. -The user can now start working on the data by just clicking into the standard view or by using the MITK-modules such as "Segmentation" or "Basic Image Processing". +The Datamanager is the central component to manage medical data like images, segmentation masks, registrations, surfaces, point sets, annotations, measurements, etc..
+After loading data into the Datamanager the data is shown in the four-view window, the so-called Standard Display. +The user can now start working on the data by interacting with the data inside the Standard Display, +by using the MITK-plugins such as Segmentation or Basic Image Processing or by using the context menu inside the data manager. -\imageMacro{QmitkDatamanager_Overview.png,"How MITK looks when started",16.00} +\imageMacro{QmitkDatamanager_Overview.png, "How MITK looks when started", 16.00} +\section DataManagerLoadingData Loading Data -\section QmitkDataManagerLoading Loading Data +There are several ways of loading data into the Datamanager as so-called data nodes: -There are three ways of loading data into the Datamanager as so called Data-Elements. - -The user can just drag and drop data into the Datamanager or directly into one of the four parts of the Standard View. -He can as well use the Open-Button in the right upper corner. Or he can use the standard "File->Open"-Dialog on the top. + -A lot of file-formats can be loaded into MITK, for example +A lot of file-formats can be loaded into MITK, for example: The user can also load a series of 2D images (e.g. image001.png, image002.png ...) to a MITK 3D volume. To do this, just drag and drop one of those 2D data files into the Datamanager by holding the ALT key. -After loading one or more data into the Datamanager they appear as Data-Elements in a sorted list inside the Datamanager. -Data-Elements can also be sorted hierarchically as a parent-child-relation. -For example after using the Segmentation-Module on Data-Element1 the result is created as Data-Element2, which is a child of Data-Element1 (see Screenshot1). -The order can be changed by drag and drop. +\section DataManagerSavingData Saving Data -\imageMacro{QmitkDatamanager_ParentChild.png,"Screenshot1",9.61} +There are several ways of saving data from the Datamanager: -The listed Data-Elements are shown in the standard view. -Here the user can scale or rotate the medical objects or he can change the cutting planes of the object by just using the mouse inside this view. + -\section QmitkDataManagerSaving Saving Data +There are two ways of saving a whole whole project with all data nodes: + -There are two ways of saving data from the Datamanger. The user can either save the whole project with all Data-Elements by clicking on "File"->"Save Project" -or he can save single Data-Elements by right-clicking->"Save", directly on a Data-Element. -When saving the whole project, the sorting of Data-Elements is saved as well. By contrast the sorting is lost, when saving a single Data-Element. +When saving the whole project, the order / hierarchy of data nodes is saved as well. By contrast the order / hierarchy is lost, when saving a single data node. -\section QmitkDataManagerProperties Working with the Datamanager +\section DataManagerWorking Working with the Datamanager -\subsection QmitkDataManagerPropertiesList List of Data-Elements +After loading data into the Datamanager the data appears as data nodes in a sorted list inside the Datamanager. +The user can change the order of the data nodes manually by dragging one or multiple data nodes and dropping them at any position inside the Datamanager. +Data nodes can also be sorted hierarchically as a parent-child-relation. +For example after using the Segmentation-Plugin to create a segmentation on Data-Element1, the result is created as Data-Element2, +which is a child of Data-Element1 (see \ref ParentChild "Parent-Child-Relation" screenshot).
+A parent-child-relation can be changed by dragging a child of a data node and dropping it onto another data node. +For this the Property Allow changing of parent nodes needs to be enabled (see \ref QmitkDataManagerPreferencePage "Preference page"). -The Data-Elements are listed in the Datamanager. -As described above the elements can be sorted hierarchically as a parent-child-relation. -For example after using the Segmentation-Module on Data-Element1 the result is created as Data-Element2, which is a child of Data-Element1 (see Screenshot1). -By drag and drop the sorting of Data-Elements and their hierarchical relation can be changed. +\anchor ParentChild +\imageMacro{QmitkDatamanager_ParentChild.png, "Parent-Child-Relation", 9.61} -\subsection QmitkDataManagerPropertiesVisibility Visibility of Data-Elements +\subsection DataManagerNodeVisibility Visibility of data nodes -By default all loaded Data-Elements are visible in the standard view. -The visibility can be changed by right-clicking on the Data-Element and then choosing "Toogle visibility". -The box in front of the Data-Element in the Datamanager shows the visibility. -A green-filled box means a visible Data-Element, an empty box means an invisible Data-Element (see Screenshot1). +By default all loaded data nodes are visible in the Standard Display. The visibility is indicated by the checkbox in front of the data node name in the Datamanager. +If a data node is visible, the checkbox is filled - an empty checkbox indicates a hidden data node (see Screenshot1). +Hint: The data nodes are rendered on top of each other, such that the topmost visible data node is always displayed on top of other data nodes. By hiding +the topmost visible data node the next data node becomes the topmost visible data node and the hidden data node is not rendered anymore. +Note: "Visible" does not mean that the node is correctly displayed inside the render windows. The user might have to re-initialize a data node to have it correctly displayed. -\subsection QmitkDataManagerPropertiesRepresentation Representation of Data-Elements +\subsection DataManagerNodeSelection Selection of data nodes -There are different types of representations how to show the Data-Element inside the standard view. By right-clicking on the Data-Element all options are listed (see Screenshot2 and Screenshot 3). +Some MITK-plugins contain widgets to control the data nodes that are used for plugin-specific data processing. These widgets can be configured such that they listen to the current selection +of the Datamanager. Having such a plugin active each selection change of data nodes inside the data manager will change the respective selection of the plugin. The data node selection widgets +can have specific node predicates, which means that only specific data nodes can be controlled by the widgets. It might happen that a selected data node will not be represented in such a +selection widget or that the selection widget will be emptied. - +\section DataManagerContextMenu Context Menu -\imageMacro{QmitkDatamanager_ImageProperties.png,"Screenshot2: Properties for images",10.56} -\imageMacro{QmitkDatamanager_SurfaceProperties.png,"Screenshot3: Properties for surfaces",11.01} +\subsection DataManagerRepresentation Representation of data nodes +There are different types of representations how to show the Data-Element inside the standard view. By right-clicking on the Data-Element all options are listed (see Screenshot2 and Screenshot 3). -\subsection QmitkDataManagerPropertiesPreferences Preferences + -The Property List displays all the properties the currently selected Data-Element has. Which properties these are depends on the Data-Element. Examples are opacity, shader, visibility. These properties can be changed by clicking on the appropriate field in the "value" column. +\imageMacro{QmitkDatamanager_ImageProperties.png,"Screenshot2: Properties for images",10.56} +\imageMacro{QmitkDatamanager_SurfaceProperties.png,"Screenshot3: Properties for surfaces",11.01} -\imageMacro{QmitkDatamanager_PropertyList.png,"Screenshot5: Property List",7.85} +\section DataManagerPreferences Data Manager Preference +\subsection DataManagerHotkeys Data Manager Hotkeys */