diff --git a/Modules/US/Documentation/doxygen/USModule.dox b/Modules/US/Documentation/doxygen/USModule.dox
index 477bacdc55..60658eb0d7 100644
--- a/Modules/US/Documentation/doxygen/USModule.dox
+++ b/Modules/US/Documentation/doxygen/USModule.dox
@@ -1,61 +1,63 @@
/**
\page USModulePage The Ultrasound Module
\section USModulePageOverview Overview
The Ultrasound Module provides a microservice Based API for ultrasound devices.
The main features are:
- - Microservice-enabled Lifecycle Management, allowing other modules to easily consume USDevice-Functionality.
+
- Microservice-enabled Life cycle Management, allowing other modules to easily consume USDevice-Functionality.
- handling and processing of ultrasound image data
- Metadata for Ultrasound images
-
- USVideoDevice class which allows to connect any ultrasound device with a video-out via a Framegrabber
+
- USVideoDevice class which allows to connect any ultrasound device with a video-out via a Frame grabber
- - Fast image preprocessing capabilities(Greyscale Conversion, Cropping) via OpenCV
+
- Fast image preprocessing capabilities(Grey scale Conversion, Cropping) via OpenCV
- Advanced image processing functions via mitk filters.
- Connection of API-Enabled devices (specifically the Telemed LogicScan 128 is a work in progress)
- Control of API-enabled Devices via MITK (Work in Progress))
- Designed to interact with the \link IGTGeneralModulePage IGT Module \endlink for tracking functionality.
This module requires OpenCV to be enabled in the superbuild options via CMAKE.
Its functionality is made available to the User via the \link org_mitk_gui_qt_ultrasound UltrasoundSupport Plugin \endlink
\section USDeviceHierarchy Ultrasound Device Hierarchy
Ultrasound Devices are managed in a simple hierarchy:
\image html USHierarchy.png
- mitk::USDevice: The common superclass for all ultrasound devices. Deriving from this class will make sure that US-specific GUI-Components will be able to interact with your class.
- Especially, the Microservcie Lifecycle is modeled in this Module.
-
- mitk::USVideDevice: This class can be used for every Ultrasound device that is connected to the PC via a Framegrabber or similar Video input device. It offers image preprocessing functionality via OpenCV.
- The \link org_mitk_gui_qt_ultrasound UltrasoundSupport Plugin \endlink enables the USer to create USVideDevices.
+ Especially, the Microservice Life cycle is modeled in this Module.
+
- mitk::USVideoDevice: This class can be used for every Ultrasound device that is connected to the PC via a Frame grabber or similar Video input device. It offers image preprocessing functionality via OpenCV.
+ The \link org_mitk_gui_qt_ultrasound UltrasoundSupport Plugin \endlink enables the user to create USVideoDevice.
There also is a reusable Widget for this Task in the USUI Module.
- mitk::USApiDevice: This is a work-in-progress class that will contain a common superclass for Devices with API support.
-\section USDeviceLifecycle USDevice Lifecycle
+\section USDeviceLifecycle USDevice Life cycle
Once you a USDevice is constructed, it can be connected via call to mitk::USDevice::Connect().
-This will cause the Device to register itself in the Microservice Framework and will make the device available to other Modules, the UltrasoundSUpport Plugin and the USDeviceManagerWidget in the USUI Module.
+This will cause the Device to register itself in the Microservice Framework and will make the device available to other Modules, the UltrasoundSupport Plugin and the USDeviceManagerWidget in the USUI Module.
The Connect() method is not virtual and should never be overwritten.
Instead, override mitk::USDevice::OnConnect(), which will be called during the connection Process and enables you to react to this event.
-A connected device is available to other modules, but is not aquiring image data.
-Analogously to Connect, there is a function mitk::USDevice::Activate which will start the image aquisition.
+A connected device is available to other modules, but is not acquiring image data.
+Analogously to Connect, there is a function mitk::USDevice::Activate which will start the image acquisition.
Again, this method is not virtual, override mitk::USDevice::OnActivate to react to activation.
Matching functions mitk::USDevice::Disconnect(), mitk::USDevice::OnDisconnect, mitk::USDevice::Deactivate, mitk::USDevice::OnDeactivate exist as well.
The following diagram illustrates the situation:
\image html USLifecycle.png
The blue message symbols indicate that the corresponding method of the subclass is called to react to the event.
-
+\section USDWidgets available Widgets
+
+There are two Widgets available that ca be used for plugin development. The USDeviceManagerWidget can view connected USDevices and allows the user to activate, deactivate and disconnect devices. The NewVideoDeviceWidget allows the user to configure a frame grabber or other video input as a USVideoDevice. Both Plugins are described in more detail in the \link org_mitk_gui_qt_ultrasound UltrasoundSupport Plugin Documentation\endlink.
*/
\ No newline at end of file