diff --git a/Plugins/org.mitk.gui.qt.python/documentation/UserManual/MitkPythonPluginView.png b/Plugins/org.mitk.gui.qt.python/documentation/UserManual/MitkPythonPluginView.png new file mode 100644 index 0000000000..befab56719 Binary files /dev/null and b/Plugins/org.mitk.gui.qt.python/documentation/UserManual/MitkPythonPluginView.png differ diff --git a/Plugins/org.mitk.gui.qt.python/documentation/UserManual/QmitkPython.dox b/Plugins/org.mitk.gui.qt.python/documentation/UserManual/QmitkPython.dox index d1ab3c52fe..0696c4eed9 100644 --- a/Plugins/org.mitk.gui.qt.python/documentation/UserManual/QmitkPython.dox +++ b/Plugins/org.mitk.gui.qt.python/documentation/UserManual/QmitkPython.dox @@ -1,10 +1,35 @@ /** \page org_mitk_gui_qt_python The Python Plugin Available sections: - \ref org_mitk_gui_qt_pythonOverview + - \ref org_mitk_gui_qt_pythonUsage + - \ref org_mitk_gui_qt_PythonConsole + - \ref org_mitk_gui_qt_PythonSnippets \section org_mitk_gui_qt_pythonOverview Overview The Python view provides the graphical front end to run Python code through the mitkPython module. Furthermore the ITK/VTK/OpenCV Python wrapping can be used. +Images and surfaces in the DataManager can be transferred via a drag & drop mechanism into the MITK Python Console. + +\section org_mitk_gui_qt_pythonUsage Transfer data +Images and surfaces can be tranferred from the data manger into the python console. To transfer an image or +surface simply drag it from the data manager into the Variable Stack view, as shown in Figure. +A new entry will appear in the Variable Stack, as soon as the data is transferred. As soon as the +entry is available the object can be accessed and modified in the python console. Three dimensional +images will be copied in-memory to python via numpy and a SimpleITK image object is created with the +same properties. When a two dimensional image is transferred the user can choose to transfer it as an OpenCV +image object. Surfaces are fully memory mapped as a vtkPolyData object. To transfer an image or surface +from the python runtime to the data manager just double click on the corresponding entry in the Variable Stack View. + +\imageMacro{QmitkPythonView.png,"Screenshot of the MITK Python Plugin",20} + +\section org_mitk_gui_qt_PythonConsole +The Python console can be used for interactive programming. All items in the data storage can be accessed +in the python console. The console can also be used to load python scripts and run them. + +\section org_mitk_gui_qt_PythonSnippets +The python plugin contains some code snippets of SimpleITK/VTK/OpenCV that can be run in the python console. +Snippets can be modified and saved by the user. + */