MITK-IGT
IGT Extension of MITK
|
Abstract class for an easy handling of a combination of an USDevice and a NavigationDataSource. This class can be used as an ImageSource subclass. Additionally tracking data be retrieved from the NavigationDataSource returned by GetTrackingDevice(). More...
#include <mitkAbstractUltrasoundTrackerDevice.h>
Public Member Functions | |
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. | |
virtual AffineTransform3D::Pointer | GetUSPlaneTransform () |
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 () |
virtual void | OnFreeze (bool) |
Called when mitk::AbstractUltrasoundTrackerDevice::SetIsFreezed() is called. Subclasses can overwrite this method to do additional actions. Default implementation does noting. | |
Static Public Attributes | |
static const std::string | DeviceClassIdentifier |
static const char * | DefaultProbeIdentifier = "default" |
static const char * | ProbeAndDepthSeperator = "_" |
static const std::string | US_INTERFACE_NAME |
static const std::string | US_PROPKEY_DEVICENAME = US_INTERFACE_NAME + ".devicename" |
static const std::string | US_PROPKEY_CLASS = US_INTERFACE_NAME + ".class" |
static const std::string | US_PROPKEY_ID = US_INTERFACE_NAME + ".id" |
Protected Member Functions | |
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 () |
Protected Attributes | |
USDevice::Pointer | m_UltrasoundDevice |
itk::SmartPointer< NavigationDataSource > | m_TrackingDeviceDataSource |
std::map< std::string, AffineTransform3D::Pointer > | m_Calibrations |
itk::SmartPointer< mitk::NavigationDataSmoothingFilter > | m_SmoothingFilter |
itk::SmartPointer< mitk::NavigationDataDelayFilter > | m_DelayFilter |
itk::SmartPointer< mitk::NavigationDataDisplacementFilter > | m_DisplacementFilter |
itk::SmartPointer< mitk::NavigationDataSource > | m_LastFilterOfIGTPipeline |
unsigned int | m_NumberOfSmoothingValues |
unsigned int | m_DelayCount |
us::ServiceRegistration< Self > | m_ServiceRegistration |
The device's ServiceRegistration object that allows to modify it's Microservice registraton details. | |
us::ServiceProperties | m_ServiceProperties |
Properties of the device's Microservice. | |
Abstract class for an easy handling of a combination of an USDevice and a 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 50 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 49 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
overrideprotected |
Definition at line 112 of file mitkAbstractUltrasoundTrackerDevice.cpp.
void mitk::AbstractUltrasoundTrackerDevice::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.
mitk::Exception | if the given string could not be parsed correctly. |
Definition at line 265 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
overrideprotected |
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.
Definition at line 351 of file mitkAbstractUltrasoundTrackerDevice.cpp.
mitk::AffineTransform3D::Pointer mitk::AbstractUltrasoundTrackerDevice::GetCalibration | ( | ) |
Getter for calibration data of the currently active depth and probe.
Definition at line 121 of file mitkAbstractUltrasoundTrackerDevice.cpp.
mitk::AffineTransform3D::Pointer mitk::AbstractUltrasoundTrackerDevice::GetCalibration | ( | std::string | depth | ) |
Getter for calibration data of the given depth and the currently active probe.
depth | depth of the b mode ultrasound image for which the calibration should be returned |
Definition at line 126 of file mitkAbstractUltrasoundTrackerDevice.cpp.
mitk::AffineTransform3D::Pointer mitk::AbstractUltrasoundTrackerDevice::GetCalibration | ( | std::string | depth, |
std::string | probe ) |
Getter for calibration data of the given depth and probe.
depth | depth of the b mode ultrasound image for which the calibration should be returned |
probe | probe of the ultrasound device for which the calibration should be returned |
Definition at line 131 of file mitkAbstractUltrasoundTrackerDevice.cpp.
bool mitk::AbstractUltrasoundTrackerDevice::GetContainsAtLeastOneCalibration | ( | ) |
Definition at line 222 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
virtual |
Wrapper for returning B mode control interface of the UltrasoundDevice.
Definition at line 465 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
virtual |
Wrapper for returning custom control interface of the UltrasoundDevice.
Definition at line 454 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
virtual |
Wrapper for returning doppler control interface of the UltrasoundDevice.
Definition at line 487 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
virtual |
Wrapper for returning probes control interface of the UltrasoundDevice.
Definition at line 476 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
protected |
Definition at line 379 of file mitkAbstractUltrasoundTrackerDevice.cpp.
std::string mitk::AbstractUltrasoundTrackerDevice::GetDeviceClass | ( | ) |
Returns the Class of the Device.
Definition at line 191 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
protected |
Definition at line 353 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
protected |
Definition at line 359 of file mitkAbstractUltrasoundTrackerDevice.cpp.
bool mitk::AbstractUltrasoundTrackerDevice::GetIsCalibratedForCurrentStatus | ( | ) |
Definition at line 217 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
virtual |
Definition at line 107 of file mitkAbstractUltrasoundTrackerDevice.cpp.
mitk::NavigationDataSource::Pointer mitk::AbstractUltrasoundTrackerDevice::GetNavigationDataSource | ( | ) |
Definition at line 207 of file mitkAbstractUltrasoundTrackerDevice.cpp.
mitk::USImageSource::Pointer mitk::AbstractUltrasoundTrackerDevice::GetUSImageSource | ( | ) |
Wrapper for returning USImageSource of the UltrasoundDevice.
Definition at line 196 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
virtual |
Returns the index to world transform of the US plane.
Reimplemented in mitk::TrackedUltrasound, and mitk::USCombinedModality.
Definition at line 75 of file mitkAbstractUltrasoundTrackerDevice.cpp.
mitk::AbstractUltrasoundTrackerDevice::itkGetMacro | ( | IsTrackedUltrasoundActive | , |
bool | ) |
mitk::AbstractUltrasoundTrackerDevice::itkGetMacro | ( | TrackingDeviceDataSource | , |
itk::SmartPointer< NavigationDataSource > | ) |
mitk::AbstractUltrasoundTrackerDevice::itkGetMacro | ( | UltrasoundDevice | , |
itk::SmartPointer< USDevice > | ) |
mitk::AbstractUltrasoundTrackerDevice::itkSetMacro | ( | TrackingDeviceDataSource | , |
itk::SmartPointer< NavigationDataSource > | ) |
mitk::AbstractUltrasoundTrackerDevice::itkSetMacro | ( | UltrasoundDevice | , |
itk::SmartPointer< USDevice > | ) |
mitk::AbstractUltrasoundTrackerDevice::mitkClassMacro | ( | AbstractUltrasoundTrackerDevice | , |
mitk::ImageSource | ) |
mitk::AbstractUltrasoundTrackerDevice::mitkNewMacro3Param | ( | AbstractUltrasoundTrackerDevice | , |
USDevice::Pointer | , | ||
itk::SmartPointer< NavigationDataSource > | , | ||
bool | ) |
|
inlinevirtual |
Called when mitk::AbstractUltrasoundTrackerDevice::SetIsFreezed() is called. Subclasses can overwrite this method to do additional actions. Default implementation does noting.
Reimplemented in mitk::TrackedUltrasound, and mitk::USCombinedModality.
Definition at line 221 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 400 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
virtual |
Definition at line 439 of file mitkAbstractUltrasoundTrackerDevice.cpp.
bool mitk::AbstractUltrasoundTrackerDevice::RemoveCalibration | ( | ) |
Removes the calibration data of the currently active depth and probe.
Definition at line 170 of file mitkAbstractUltrasoundTrackerDevice.cpp.
bool mitk::AbstractUltrasoundTrackerDevice::RemoveCalibration | ( | std::string | depth | ) |
Removes the calibration data of the given depth and the currently active probe.
depth | depth of the b mode ultrasound image for which the calibration should be removed |
Definition at line 175 of file mitkAbstractUltrasoundTrackerDevice.cpp.
bool mitk::AbstractUltrasoundTrackerDevice::RemoveCalibration | ( | std::string | depth, |
std::string | probe ) |
Removes the calibration data of the given depth and probe.
depth | depth of the b mode ultrasound image for which the calibration should be removed |
probe | probe of the ultrasound device for which the calibration should be removed |
Definition at line 180 of file mitkAbstractUltrasoundTrackerDevice.cpp.
std::string mitk::AbstractUltrasoundTrackerDevice::SerializeCalibration | ( | ) |
Serializes all contained calibrations into an xml fragment.
The returned string contains one parent node named "calibrations" and several subnodes, one for each calibration that is present.
Definition at line 227 of file mitkAbstractUltrasoundTrackerDevice.cpp.
void mitk::AbstractUltrasoundTrackerDevice::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.
Definition at line 152 of file mitkAbstractUltrasoundTrackerDevice.cpp.
void mitk::AbstractUltrasoundTrackerDevice::SetDelayCount | ( | unsigned int | delayCount | ) |
Definition at line 338 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
virtual |
Can toggle if the combined modality is currently updated or freezed.
freeze | true to stop updating the ultrasound image and the tracking data, false to start updating again |
Definition at line 80 of file mitkAbstractUltrasoundTrackerDevice.cpp.
void mitk::AbstractUltrasoundTrackerDevice::SetNumberOfSmoothingValues | ( | unsigned int | numberOfSmoothingValues | ) |
Definition at line 325 of file mitkAbstractUltrasoundTrackerDevice.cpp.
void mitk::AbstractUltrasoundTrackerDevice::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.
Definition at line 423 of file mitkAbstractUltrasoundTrackerDevice.cpp.
|
static |
Definition at line 55 of file mitkAbstractUltrasoundTrackerDevice.h.
|
static |
Definition at line 54 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 245 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 253 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 248 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 249 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 250 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 252 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Properties of the device's Microservice.
Definition at line 263 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
The device's ServiceRegistration object that allows to modify it's Microservice registraton details.
Definition at line 258 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 247 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 244 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
Definition at line 243 of file mitkAbstractUltrasoundTrackerDevice.h.
|
static |
Definition at line 56 of file mitkAbstractUltrasoundTrackerDevice.h.
|
static |
Definition at line 57 of file mitkAbstractUltrasoundTrackerDevice.h.
|
static |
Definition at line 59 of file mitkAbstractUltrasoundTrackerDevice.h.
|
static |
Definition at line 58 of file mitkAbstractUltrasoundTrackerDevice.h.
|
static |
Definition at line 60 of file mitkAbstractUltrasoundTrackerDevice.h.