diff --git a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmikUltrasound_BModeControls.png b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmikUltrasound_BModeControls.png new file mode 100644 index 0000000000..e91cb0d567 Binary files /dev/null and b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmikUltrasound_BModeControls.png differ diff --git a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound.dox b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound.dox index a484add03e..4abc2ba488 100644 --- a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound.dox +++ b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound.dox @@ -1,68 +1,95 @@ /** \page org_mitk_gui_qt_ultrasound The Ultrasound Plugin \imageMacro{QmitkUltrasound_Icon.png,"Icon of the Ultrasound Plugin",2.12} \tableofcontents -\section org_mitk_gui_qt_ultrasoundOverview +\section org_mitk_gui_qt_ultrasoundOverview Overview This plugin offers a simple interface to create and manage ultrasound devices. Devices, once configured, will be stored and loaded on the next start of MITK. One can configure several aspects of the images acquired. -Last but not least, this plugin makes the configured devices available as a microservice, -exposing them for further usage in other plugins. +Last but not least, this plugin makes the configured devices available as a +microservice, exposing them for further usage in other plugins. \section org_mitk_gui_qt_ultrasoundPrerequisites Prerequisites To make use of this plugin, you obviously require an ultrasound device. -The device must have a video-out of one kind or another. Typical video-outs are: HDMI, DVI, VGA and S-Video. -You also need a Video-Grabber that can acquire the image data from the ultrasound device. -In principal, this plugin is compatible with any grabber that allows the Operating system to access it's functionality. - -However, not all grabbers are created equal. Make sure your grabber supports the video-out offered by your ultrasound device and that it can achieve a satisfying framerate. -We have made good experiences with epiphan Grabbers and currently recommend the epiphan DVI2USB 3.0 device which supports HDMI, DVI and VGA, but less costly grabbers certainly are an option. +The device must have a video output or must be one of the supported API devices +(at the moment only Telemed LogicScan 128 is supported as an API device. +Typical video outputs are: HDMI, DVI, VGA and S-Video. +You also need a Video-Grabber that can acquire the image data from the +ultrasound device. In principal, this plugin is compatible with any grabber +that allows the operating system to access it's functionality. + +However, not all grabbers are created equal. Make sure your grabber supports +the video-out offered by your ultrasound device and that it can achieve a +satisfying framerate. We have made good experiences with epiphan Grabbers and +currently recommend the Epiphan +DVI2USB 3.0 device which supports HDMI, DVI and VGA, but less costly +grabbers certainly are an option. \section org_mitk_gui_qt_ultrasoundCreateDevice Creating an Device -To configure an ultrasound device, connect the ultrasound device to the grabber and the grabber to the computer. Start the ultrasound device and open the ultrasound plugin. The devicemanager will open. +To configure an ultrasound device as a video device, connect it to the grabber +and the grabber to the computer. Start the ultrasound device and open the +ultrasound plugin. The devicemanager will open. -\imageMacro{QmitkUltrasound_DeviceManagement.png,"MITK Screenshot with the devicemanager activated",7.54} +\imageMacro{QmitkUltrasound_DeviceManagement.png,"MITK Screenshot With the Device Manager Activated",7.54} -Any currently configured devices are listed in the box, which accordingly is empty now. -Click "New Device". +Any currently configured devices are listed in the box, which accordingly is +empty now. -\imageMacro{QmitkUltrasound_NewVideoDevice.png,"The 'New Device' form",7.62} +The creation of API devices depends on the device. A Telemed device would be +listed in the box if this version of MITK was compiled with support for Telemed +devices (see \link USHardwareTelemedPage\endlink). Such a device requires no +configuration. + +Click "New Video Device" if you want to create a new video device. -In the appearing form, enter descriptive data on your device in the corresponding fields. -Manufacturer and model will be used to display the device in MITK. +\imageMacro{QmitkUltrasound_NewVideoDevice.png,"The 'New Device' form",7.62} -You may choose the video source ID if more than one is available (as is the case on laptops with built-in webcams). -On Windows, try -1 (defaults to the first available source). On Linux and Mac try 0 and 1. -If the wrong camera is address, simply try the next ID. +In the appearing form, enter descriptive data on your device in the +corresponding fields. Manufacturer and model will be used to display the device +in MITK. -Most ultrasound images are grey scale, so using a grey scale conversion doesn't take information away from the image, but makes processing images significantly faster. -Only uncheck this box if you require color. +You may choose the video source ID if more than one is available (as is the +case on laptops with built-in webcams). Try 0 and 1. If the wrong camera is +addressed, simply try the next ID. -Click Add Device to save your changes. +Most ultrasound images are grey scale, so using a grey scale conversion doesn't +take information away from the image, but makes processing images significantly +faster. Only uncheck this box if you require color. -\imageMacro{QmitkUltrasound_DeviceManagement2.png,"Devicemanager with configured device",7.64} +Click "Add Video Device" to save your changes. -\section org_mitk_gui_qt_ultrasoundActivateConnect Activation and Connection +\imageMacro{QmitkUltrasound_DeviceManagement2.png,"Devicemanager With a Configured Device",7.64} -A ultrasound device in MITK can be connected and activated. The device you just created automatically is now connected. -A connected device is available to all other plugins in MITK, but does not jet generate image data. -Disconnecting the device causes it to be deleted and not be available anymore. +An ultrasound device in MITK can be activated or removed. Removing may not be +available for some API devices. The device you just created is available to all +other plugins in MITK, but does not yet generate image data. Activating the +device will start image generating. -Click the device, then click "Activate Device". The device is now activated and generates image data continuously. +\section org_mitk_gui_qt_ultrasoundUseDevice Using an Ultrasound Device -Click the "US-Imaging Tab" +Click the device, then click "Activate Device". The device is now activated and +generates image data continuously. The device is listed in the box on the +bottom of the view now. Viewing of the image data can be started by selecting +the device in this list and click the "Start Viewing" button. -\imageMacro{QmitkUltrasound_Imaging.png,"US Imaging Tab",7.60} +\imageMacro{QmitkUltrasound_Imaging.png,"US Imaging Tab for a Video Device",7.60} -Select the device and click "Start Viewing". The US-Image should appear. -You can adjust the cropping parameters to reduce the acquired image size which will further increase speed and remove unnecessary information. +You can adjust the cropping parameters to reduce the acquired image size which +will further increase speed and remove unnecessary information. All changes are saved and restored whenever MITK is started. +If an API device was selected, buttons for controlling the b mode imaging may +be available. This depends on the implementation of a control interface for +this specific device in MITK. + +\imageMacro{QmikUltrasound_BModeControls.png,"B Mode Controls for an API Device",7} + */ diff --git a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_DeviceManagement.png b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_DeviceManagement.png index c355ad1e50..6ed9bc6ac8 100644 Binary files a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_DeviceManagement.png and b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_DeviceManagement.png differ diff --git a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_DeviceManagement2.png b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_DeviceManagement2.png index 84ede8a48d..99a219d0d1 100644 Binary files a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_DeviceManagement2.png and b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_DeviceManagement2.png differ diff --git a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_Imaging.png b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_Imaging.png index 52a2e8f23c..87741909b8 100644 Binary files a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_Imaging.png and b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_Imaging.png differ diff --git a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_NewVideoDevice.png b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_NewVideoDevice.png index 31f4ed2f46..a45b2b0e44 100644 Binary files a/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_NewVideoDevice.png and b/Plugins/org.mitk.gui.qt.ultrasound/documentation/UserManual/QmitkUltrasound_NewVideoDevice.png differ