diff --git a/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/QmitkMxNMultiWidgetEditor.dox b/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/QmitkMxNMultiWidgetEditor.dox new file mode 100644 index 0000000000..f826235ca1 --- /dev/null +++ b/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/QmitkMxNMultiWidgetEditor.dox @@ -0,0 +1,150 @@ +/** +\page org_mitk_editors_mxnmultiwidget The MxN Display + +\imageMacro{QmitkMxNMultiWidgetEditor.svg,"Icon of the MxN Display",16.00} + +\tableofcontents + +\section org_mitk_editors_mxnmultiwidget_F1Help General remark on F1 help + This is the help window of the MxN display. To display the help windows of other plugins, press F1 when the plugin of interest is active + (please make sure the tab of the plugin of interest is highlighted). + Alternatively, go to the Help menu and select Open Help Perspective. A help window opens from which you can select the documentation of the plugin of interest. + +\section org_mitk_editors_mxnmultiwidget_Overview Overview + The MxN display is an alternative image viewer to the Standard display. + It is a more flexible, customizable approach to displaying images with a strong focus on displaying different images + simultaneously but independently. + Unlike than the Standard Display it allows to show a different image for each window view while also allowing independent image navigation. + The number of window views can be freely chosen and anatomical view planes / view directions can be changed for each window view. + +\section org_mitk_editors_mxnmultiwidget_Working Working with the MxN display + The following sections describe how to work with the MxN display. The MxN display can be customized and several + properties can be set to modify the behavior. + +\subsection org_mitk_editors_mxnmultiwidget_Configuration Configuration Toolbar + The MxNDisplay is initialized with a single window view and a configuration toolbar on the right side. + In the toolbar you can find three icons / actions, where two buttons have an on/off state. + +
\imageMacro{QtWidgets/resource/mwLayout.png, "Layout button", 16.00} +
\imageMacro{QtWidgets/resource/mwSynchronized.png, "Synchronize button", 16.00} + \imageMacro{QtWidgets/resource/mwDesynchronized.png, "Desynchronize button", 16.00} +
\imageMacro{QtWidgets/resource/mwMITK.png, "MITK mode button", 16.00} + \imageMacro{QtWidgets/resource/mwPACS.png, "PACS mode button", 16.00} +
+ + + +\subsubsection org_mitk_editors_mxnmultiwidget_Layout MxN display layout + There are several options to customize the MxN display layout. + + Using the layout button from the configuration toolbar allows to customize the layout the following way: + + + \imageMacro{layoutWidget.png, "Layout widget" , 16.00} + + By moving the cursor to the upper right corner of any window you can activate the window menu. It consists of three buttons: + + + \imageMacro{layoutArrangements.png, "Layout arrangement", 16.00} + +\subsubsection org_mitk_editors_mxnmultiwidget_Synchronization Window synchronization + If data is displayed inside a window view you can interact with the window / loaded image using your mouse. + As long as the interaction synchronization is disabled (), mouse interactions, + such as zooming, setting the point of interest, mouse wheel scrolling etc. will affect only the window view you click in. + If the interaction synchronization is enabled (), performing any of the mouse interactions inside a window view + will perform the same interaction in any other visible window view. + +\subsubsection org_mitk_editors_mxnmultiwidget_Interaction_Mode Mouse interaction mode + As mentioned before, you can use the mouse to interact with each window / loaded image. + There are two interaction modes which can be switched between using the interaction mode button: + the MITK interaction mouse mode and the PACS interaction mouse mode. + If the PACS interaction mouse mode is selected, an interaction tool bar is added to the left side of the + MxN display: It allows to select the action to perform for the left mouse button. + The difference between the MITK and PACS mode is as follows: + + MITK interaction mouse mode + + + PACS interaction mouse mode + + +\subsection org_mitk_editors_mxnmultiwidget_Utility Utility Menu + Each window view has a utility menu at the top with four UI elements that allow to perform the following actions: + + + \imageMacro{utilityMenu.png, "Utility menu", 8.00} + +\subsubsection org_mitk_editors_mxnmultiwidget_Data_Selection Data node selection + Using the data selection button of a window view you can open a data node selection dialog which shows the currently + selected data nodes for the window view. + "Currently selected" means that you can either decide to show all available data nodes from the data storage + or - for a better data node overview - only show an individually selected subset of the available data nodes. + You can either remove a node from the selection by clicking the "x" on a data node or use the "Change selection" + button to individually select data nodes. + The "Select all nodes" checkbox denotes which of the selection types is currently used - showing all available data nodes + or showing only a subset of data nodes. Checking the checkbox will reset the selection to all available data nodes. + + Selecting data nodes does not mean that this node always has to be visible in the window view (rendered). If you want to hide + a node, e.g. for temporarily inspecting underlying images, you can do so by clicking the "eye" icon for each selected data node. + + If you want to reset the window view to a specific node / image, you can use the "arrow" icon. This will reset the camera to focus + on the selected node, using default zoom and centered camera position. + If you want so reset the camera to focus on the whole scene / all selected nodes, you can use the window menu, see + \ref org_mitk_editors_mxnmultiwidget_Layout. + Resetting a window only affects the corresponding window view, regardless of any synchronization / lock state. + +\subsubsection org_mitk_editors_mxnmultiwidget_Lock_Button Lock button + So far showing / hiding nodes or removing them from a selection / changing a selection affected all window views. + If you want to use individual selections for a window view, you can unlock / decouple the window view from other window views + by clicking on the lock button in the utility menu. + This will decouple the current window view. Changing the visibility of a node or selecting individual nodes / removing nodes + using the data node selection button will affect only the current window view. + This allows to show different images in each window view, e.g. by decoupling multiple window views and selecting individual nodes + in each window. + It is still possible to have a synchronized mouse interaction, see \ref org_mitk_editors_mxnmultiwidget_Synchronization and + \ref org_mitk_editors_mxnmultiwidget_Interaction_Mode. + +\subsubsection org_mitk_editors_mxnmultiwidget_Slice_Slider Slice selection slider + Displayed data is typically 3D data but each window view shows a 2D slice of the 3D volume. The direction in which the + 3D volume is sliced is defined by the "view direction" (or "anatomical plane"). + To define at which position in the view direction the 3D volume should be sliced, the slice selection slider can be used. + It can either be moved using the mouse or by using the appropriate mouse interaction (see above, e.g. mouse wheel scroling). + +\subsubsection org_mitk_editors_mxnmultiwidget_View_Direction View direction + Each window view "is looking in" one of the three avaiable view directions, namely "Axial", "Sagittal" or "Coronal". + You can change the view direction by switching to another anatomical plane in the view direction drop down menu. + Changing the view direction will reset the camera to its default for the new view direction, meaning default zoom and + centered camera position. + +*/ diff --git a/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/QmitkMxNMultiWidgetEditor.svg b/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/QmitkMxNMultiWidgetEditor.svg new file mode 100644 index 0000000000..b02b7a8538 --- /dev/null +++ b/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/QmitkMxNMultiWidgetEditor.svg @@ -0,0 +1,80 @@ + + + + + + + image/svg+xml + + + + + + + + + + + diff --git a/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/layoutArrangements.png b/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/layoutArrangements.png new file mode 100644 index 0000000000..3fb71d353b Binary files /dev/null and b/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/layoutArrangements.png differ diff --git a/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/layoutWidget.png b/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/layoutWidget.png new file mode 100644 index 0000000000..283752b2d4 Binary files /dev/null and b/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/layoutWidget.png differ diff --git a/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/utilityMenu.png b/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/utilityMenu.png new file mode 100644 index 0000000000..647cc4e94d Binary files /dev/null and b/Plugins/org.mitk.gui.qt.mxnmultiwidgeteditor/documentation/UserManual/utilityMenu.png differ