Medical Imaging Interaction Toolkit  2018.4.99-bd7b41ba
Medical Imaging Interaction Toolkit
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:
Collaboration 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)
 
virtual itk::SmartPointer< USDeviceGetUltrasoundDevice ()
 
virtual void SetUltrasoundDevice (itk::SmartPointer< USDevice > _arg)
 
virtual itk::SmartPointer< NavigationDataSourceGetTrackingDeviceDataSource ()
 
virtual void SetTrackingDeviceDataSource (itk::SmartPointer< NavigationDataSource > _arg)
 
virtual bool GetIsTrackedUltrasoundActive ()
 
AffineTransform3D::Pointer GetCalibration ()
 Getter for calibration data of the currently active depth and probe. More...
 
AffineTransform3D::Pointer GetCalibration (std::string depth)
 Getter for calibration data of the given depth and the currently active probe. More...
 
AffineTransform3D::Pointer GetCalibration (std::string depth, std::string probe)
 Getter for calibration data of the given depth and probe. More...
 
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. More...
 
bool RemoveCalibration ()
 Removes the calibration data of the currently active depth and probe. More...
 
bool RemoveCalibration (std::string depth)
 Removes the calibration data of the given depth and the currently active probe. More...
 
bool RemoveCalibration (std::string depth, std::string probe)
 Removes the calibration data of the given depth and probe. More...
 
std::string GetDeviceClass ()
 Returns the Class of the Device. More...
 
USImageSource::Pointer GetUSImageSource ()
 Wrapper for returning USImageSource of the UltrasoundDevice. More...
 
itk::SmartPointer< mitk::NavigationDataSourceGetNavigationDataSource ()
 
bool GetIsCalibratedForCurrentStatus ()
 
bool GetContainsAtLeastOneCalibration ()
 
std::string SerializeCalibration ()
 Serializes all contained calibrations into an xml fragment. More...
 
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. More...
 
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. More...
 
virtual void RegisterAsMicroservice ()
 
virtual itk::SmartPointer< USAbstractControlInterfaceGetControlInterfaceCustom ()
 Wrapper for returning custom control interface of the UltrasoundDevice. More...
 
virtual itk::SmartPointer< USControlInterfaceBModeGetControlInterfaceBMode ()
 Wrapper for returning B mode control interface of the UltrasoundDevice. More...
 
virtual itk::SmartPointer< USControlInterfaceProbesGetControlInterfaceProbes ()
 Wrapper for returning probes control interface of the UltrasoundDevice. More...
 
virtual itk::SmartPointer< USControlInterfaceDopplerGetControlInterfaceDoppler ()
 Wrapper for returning doppler control interface of the UltrasoundDevice. More...
 
virtual void SetIsFreezed (bool freeze)
 Can toggle if the combined modality is currently updated or freezed. More...
 
virtual bool GetIsFreezed ()
 
- Public Member Functions inherited from mitk::ImageSource
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
OutputTypeGetOutput ()
 Get the output data of this image source object. More...
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Make a DataObject of the correct type to used as the specified output. More...
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual vtkImageData * GetVtkImageData ()
 
virtual const vtkImageData * GetVtkImageData () const
 
- Public Member Functions inherited from mitk::BaseDataSource
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Access itk::ProcessObject::m_Updating. More...
 

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. More...
 
void OnFreeze (bool) override
 Freezes or unfreezes the CombinedModality. More...
 
- 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. More...
 
std::string GetIdentifierForCurrentCalibration ()
 
std::string GetIdentifierForCurrentProbe ()
 
std::string GetCurrentDepthValue ()
 
void RebuildFilterPipeline ()
 
- Protected Member Functions inherited from mitk::ImageSource
 ImageSource ()
 
 ~ImageSource () override
 
void GenerateData () override
 A version of GenerateData() specific for image processing filters. More...
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...
 
void PrepareOutputs () override
 This method is intentionally left blank. More...
 
virtual void AllocateOutputs ()
 The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...
 
virtual void BeforeThreadedGenerateData ()
 If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). More...
 
virtual void AfterThreadedGenerateData ()
 If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). More...
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
 Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Additional Inherited Members

- Public Types inherited from mitk::ImageSource
typedef ImageSource Self
 
typedef BaseDataSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef mitk::Image OutputImageType
 Some convenient typedefs. More...
 
typedef OutputImageType OutputType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef SlicedData::RegionType OutputImageRegionType
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 
- Static Public Member Functions inherited from mitk::ImageSource
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 Method for creation through the object factory. More...
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 
- Static Public Attributes inherited from mitk::AbstractUltrasoundTrackerDevice
static const std::string DeviceClassIdentifier
 
static const char * DefaultProbeIdentifier
 
static const char * ProbeAndDepthSeperator
 
static const std::string US_INTERFACE_NAME
 
static const std::string US_PROPKEY_DEVICENAME
 
static const std::string US_PROPKEY_CLASS
 
static const std::string US_PROPKEY_ID
 
- Static Protected Member Functions inherited from mitk::ImageSource
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 Static function used as a "callback" by the MultiThreader. More...
 
- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 
- Protected Attributes inherited from mitk::AbstractUltrasoundTrackerDevice
USDevice::Pointer m_UltrasoundDevice
 
itk::SmartPointer< NavigationDataSourcem_TrackingDeviceDataSource
 
std::map< std::string, AffineTransform3D::Pointer > m_Calibrations
 
itk::SmartPointer< mitk::NavigationDataSmoothingFilterm_SmoothingFilter
 
itk::SmartPointer< mitk::NavigationDataDelayFilterm_DelayFilter
 
itk::SmartPointer< mitk::NavigationDataDisplacementFilterm_DisplacementFilter
 
itk::SmartPointer< mitk::NavigationDataSourcem_LastFilterOfIGTPipeline
 
unsigned int m_NumberOfSmoothingValues
 
unsigned int m_DelayCount
 
us::ServiceRegistration< Selfm_ServiceRegistration
 The device's ServiceRegistration object that allows to modify it's Microservice registraton details. More...
 
us::ServiceProperties m_ServiceProperties
 Properties of the device's Microservice. More...
 

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()

mitk::USCombinedModality::USCombinedModality ( USDevice::Pointer  usDevice,
itk::SmartPointer< NavigationDataSource trackingDevice,
bool  trackedUltrasoundActive = false 
)
protected

Definition at line 24 of file mitkUSCombinedModality.cpp.

◆ ~USCombinedModality()

mitk::USCombinedModality::~USCombinedModality ( )
overrideprotected

Definition at line 35 of file mitkUSCombinedModality.cpp.

Member Function Documentation

◆ GenerateData()

◆ GetUSPlaneTransform()

mitk::AffineTransform3D::Pointer mitk::USCombinedModality::GetUSPlaneTransform ( )
overridevirtual

Returns the index to world transform of the US plane.

Reimplemented from mitk::AbstractUltrasoundTrackerDevice.

Definition at line 30 of file mitkUSCombinedModality.cpp.

References mitk::AbstractUltrasoundTrackerDevice::GetCalibration().

◆ mitkClassMacro()

mitk::USCombinedModality::mitkClassMacro ( USCombinedModality  ,
mitk::AbstractUltrasoundTrackerDevice   
)

◆ mitkNewMacro3Param()

mitk::USCombinedModality::mitkNewMacro3Param ( USCombinedModality  ,
USDevice::Pointer  ,
itk::SmartPointer< NavigationDataSource ,
bool   
)

◆ OnFreeze()

void mitk::USCombinedModality::OnFreeze ( bool  freeze)
overrideprotectedvirtual

The documentation for this class was generated from the following files: