Loading...
Searching...
No Matches
mitk::USCombinedModality Class Reference
Combination of USDevice and NavigationDataSource. This class can be used as an ImageSource subclass. Additionally tracking data be retrieved from the NavigationDataSource returned by GetTrackingDevice(). More...
#include <mitkUSCombinedModality.h>
Inheritance diagram for mitk::USCombinedModality:
Public Member Functions | |
| mitkClassMacro (USCombinedModality, mitk::AbstractUltrasoundTrackerDevice) | |
| mitkNewMacro3Param (USCombinedModality, USDevice::Pointer, itk::SmartPointer< NavigationDataSource >, bool) | |
| AffineTransform3D::Pointer | GetUSPlaneTransform () override |
 Public Member Functions inherited from mitk::AbstractUltrasoundTrackerDevice | |
| mitkClassMacro (AbstractUltrasoundTrackerDevice, mitk::ImageSource) | |
| mitkNewMacro3Param (AbstractUltrasoundTrackerDevice, USDevice::Pointer, itk::SmartPointer< NavigationDataSource >, bool) | |
| itkGetMacro (UltrasoundDevice, itk::SmartPointer< USDevice >) | |
| itkSetMacro (UltrasoundDevice, itk::SmartPointer< USDevice >) | |
| itkGetMacro (TrackingDeviceDataSource, itk::SmartPointer< NavigationDataSource >) | |
| itkSetMacro (TrackingDeviceDataSource, itk::SmartPointer< NavigationDataSource >) | |
| itkGetMacro (IsTrackedUltrasoundActive, bool) | |
| AffineTransform3D::Pointer | GetCalibration () |
| Getter for calibration data of the currently active depth and probe. | |
| AffineTransform3D::Pointer | GetCalibration (std::string depth) |
| Getter for calibration data of the given depth and the currently active probe. | |
| AffineTransform3D::Pointer | GetCalibration (std::string depth, std::string probe) |
| Getter for calibration data of the given depth and probe. | |
| void | SetCalibration (AffineTransform3D::Pointer calibration) |
| Sets a transformation as calibration data. Calibration data is set for the currently activated probe and their current zoom factor. It also marks the device as calibrated. | |
| bool | RemoveCalibration () |
| Removes the calibration data of the currently active depth and probe. | |
| bool | RemoveCalibration (std::string depth) |
| Removes the calibration data of the given depth and the currently active probe. | |
| bool | RemoveCalibration (std::string depth, std::string probe) |
| Removes the calibration data of the given depth and probe. | |
| std::string | GetDeviceClass () |
| Returns the Class of the Device. | |
| USImageSource::Pointer | GetUSImageSource () |
| Wrapper for returning USImageSource of the UltrasoundDevice. | |
| itk::SmartPointer< mitk::NavigationDataSource > | GetNavigationDataSource () |
| bool | GetIsCalibratedForCurrentStatus () |
| bool | GetContainsAtLeastOneCalibration () |
| std::string | SerializeCalibration () |
| Serializes all contained calibrations into an xml fragment. | |
| void | DeserializeCalibration (const std::string &xmlString, bool clearPreviousCalibrations=true) |
| Deserializes a string provided by a prior call to Serialize(). If the bool flag is true, all prior calibrations will be deleted. If the flag is set to false, prior calibrations will be retained, but overwritten if one of equal name is present. | |
| void | SetNumberOfSmoothingValues (unsigned int numberOfSmoothingValues) |
| void | SetDelayCount (unsigned int delayCount) |
| void | UnregisterOnService () |
| Remove this device from the micro service. This method is public for mitk::USCombinedModality, because this devices can be completly removed. This is not possible for API devices, which should be available while their sub module is loaded. | |
| virtual void | RegisterAsMicroservice () |
| virtual itk::SmartPointer< USAbstractControlInterface > | GetControlInterfaceCustom () |
| Wrapper for returning custom control interface of the UltrasoundDevice. | |
| virtual itk::SmartPointer< USControlInterfaceBMode > | GetControlInterfaceBMode () |
| Wrapper for returning B mode control interface of the UltrasoundDevice. | |
| virtual itk::SmartPointer< USControlInterfaceProbes > | GetControlInterfaceProbes () |
| Wrapper for returning probes control interface of the UltrasoundDevice. | |
| virtual itk::SmartPointer< USControlInterfaceDoppler > | GetControlInterfaceDoppler () |
| Wrapper for returning doppler control interface of the UltrasoundDevice. | |
| virtual void | SetIsFreezed (bool freeze) |
| Can toggle if the combined modality is currently updated or freezed. | |
| virtual bool | GetIsFreezed () |
Protected Member Functions | |
| USCombinedModality (USDevice::Pointer usDevice, itk::SmartPointer< NavigationDataSource > trackingDevice, bool trackedUltrasoundActive=false) | |
| ~USCombinedModality () override | |
| void | GenerateData () override |
| Grabs the next frame from the input. This method is called internally, whenever Update() is invoked by an Output. | |
| void | OnFreeze (bool) override |
| Freezes or unfreezes the CombinedModality. | |
| Protected Member Functions inherited from mitk::AbstractUltrasoundTrackerDevice | |
| AbstractUltrasoundTrackerDevice (USDevice::Pointer usDevice, itk::SmartPointer< NavigationDataSource > trackingDevice, bool trackedUltrasoundActive) | |
| ~AbstractUltrasoundTrackerDevice () override | |
| void | GenerateData () override |
| Grabs the next frame from the input. Must be implemented by the derived class. This method is called internally, whenever Update() is invoked by an Output. | |
| std::string | GetIdentifierForCurrentCalibration () |
| std::string | GetIdentifierForCurrentProbe () |
| std::string | GetCurrentDepthValue () |
| void | RebuildFilterPipeline () |
Detailed Description
Combination of USDevice and NavigationDataSource. This class can be used as an ImageSource subclass. Additionally tracking data be retrieved from the NavigationDataSource returned by GetTrackingDevice().
A calibration of the ultrasound image stream to the navigation datas can be set for the currently active zoom level (of the ultrasound device) by SetCalibration(). The ultrasound images are transformed according to this calibration in the GenerateData() method.
Definition at line 45 of file mitkUSCombinedModality.h.
Constructor & Destructor Documentation
◆ USCombinedModality()
|
protected |
Definition at line 24 of file mitkUSCombinedModality.cpp.
◆ ~USCombinedModality()
|
overrideprotected |
Definition at line 35 of file mitkUSCombinedModality.cpp.
Member Function Documentation
◆ GenerateData()
|
overrideprotected |
Grabs the next frame from the input. This method is called internally, whenever Update() is invoked by an Output.
Definition at line 37 of file mitkUSCombinedModality.cpp.
◆ GetUSPlaneTransform()
|
overridevirtual |
Returns the index to world transform of the US plane.
Reimplemented from mitk::AbstractUltrasoundTrackerDevice.
Definition at line 30 of file mitkUSCombinedModality.cpp.
◆ mitkClassMacro()
| mitk::USCombinedModality::mitkClassMacro | ( | USCombinedModality | , |
| mitk::AbstractUltrasoundTrackerDevice | ) |
◆ mitkNewMacro3Param()
| mitk::USCombinedModality::mitkNewMacro3Param | ( | USCombinedModality | , |
| USDevice::Pointer | , | ||
| itk::SmartPointer< NavigationDataSource > | , | ||
| bool | ) |
◆ OnFreeze()
|
overrideprotectedvirtual |
Freezes or unfreezes the CombinedModality.
Reimplemented from mitk::AbstractUltrasoundTrackerDevice.
Definition at line 81 of file mitkUSCombinedModality.cpp.
The documentation for this class was generated from the following files:
- Modules/US/USNavigation/mitkUSCombinedModality.h
- Modules/US/USNavigation/mitkUSCombinedModality.cpp
