Medical Imaging Interaction Toolkit
2023.12.00
Medical Imaging Interaction Toolkit
|
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) | |
virtual itk::SmartPointer< USDevice > | GetUltrasoundDevice () |
virtual void | SetUltrasoundDevice (itk::SmartPointer< USDevice > _arg) |
virtual itk::SmartPointer< NavigationDataSource > | GetTrackingDeviceDataSource () |
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... | |
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. 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::NavigationDataSource > | GetNavigationDataSource () |
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< USAbstractControlInterface > | GetControlInterfaceCustom () |
Wrapper for returning custom control interface of the UltrasoundDevice. More... | |
virtual itk::SmartPointer< USControlInterfaceBMode > | GetControlInterfaceBMode () |
Wrapper for returning B mode control interface of the UltrasoundDevice. More... | |
virtual itk::SmartPointer< USControlInterfaceProbes > | GetControlInterfaceProbes () |
Wrapper for returning probes control interface of the UltrasoundDevice. More... | |
virtual itk::SmartPointer< USControlInterfaceDoppler > | GetControlInterfaceDoppler () |
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 () |
virtual void | OnFreeze (bool) |
Called when mitk::AbstractUltrasoundTrackerDevice::SetIsFreezed() is called. Subclasses can overwrite this method to do additional actions. Default implementation does noting. More... | |
Public Member Functions inherited from mitk::ImageSource | |
virtual std::vector< std::string > | GetClassHierarchy () const override |
virtual const char * | GetClassName () const |
Pointer | Clone () const |
OutputType * | GetOutput () |
Get the output data of this image source object. More... | |
const OutputType * | GetOutput () const |
OutputType * | GetOutput (DataObjectPointerArraySizeType idx) |
const OutputType * | GetOutput (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 | |
OutputType * | GetOutput () |
const OutputType * | GetOutput () const |
OutputType * | GetOutput (DataObjectPointerArraySizeType idx) |
const OutputType * | GetOutput (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... | |
Static Public Attributes | |
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 |
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. 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 | |
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. More... | |
us::ServiceProperties | m_ServiceProperties |
Properties of the device's Microservice. More... | |
Additional Inherited Members | |
Public Types inherited from mitk::ImageSource | |
typedef ImageSource | Self |
typedef BaseDataSource | Superclass |
typedef itk::SmartPointer< Self > | Pointer |
typedef itk::SmartPointer< const Self > | ConstPointer |
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< Self > | Pointer |
typedef itk::SmartPointer< const Self > | ConstPointer |
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 Protected Member Functions inherited from mitk::ImageSource | |
static itk::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 () |
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 |
|
overrideprotected |
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. |
|
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.
AffineTransform3D::Pointer mitk::AbstractUltrasoundTrackerDevice::GetCalibration | ( | ) |
Getter for calibration data of the currently active depth and probe.
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 |
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 |
bool mitk::AbstractUltrasoundTrackerDevice::GetContainsAtLeastOneCalibration | ( | ) |
|
virtual |
Wrapper for returning B mode control interface of the UltrasoundDevice.
|
virtual |
Wrapper for returning custom control interface of the UltrasoundDevice.
|
virtual |
Wrapper for returning doppler control interface of the UltrasoundDevice.
|
virtual |
Wrapper for returning probes control interface of the UltrasoundDevice.
|
protected |
std::string mitk::AbstractUltrasoundTrackerDevice::GetDeviceClass | ( | ) |
Returns the Class of the Device.
|
protected |
|
protected |
bool mitk::AbstractUltrasoundTrackerDevice::GetIsCalibratedForCurrentStatus | ( | ) |
|
virtual |
|
virtual |
itk::SmartPointer<mitk::NavigationDataSource> mitk::AbstractUltrasoundTrackerDevice::GetNavigationDataSource | ( | ) |
|
virtual |
|
virtual |
USImageSource::Pointer mitk::AbstractUltrasoundTrackerDevice::GetUSImageSource | ( | ) |
Wrapper for returning USImageSource of the UltrasoundDevice.
|
virtual |
Returns the index to world transform of the US plane.
Reimplemented in mitk::USCombinedModality, and mitk::TrackedUltrasound.
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::USCombinedModality, and mitk::TrackedUltrasound.
Definition at line 221 of file mitkAbstractUltrasoundTrackerDevice.h.
|
protected |
|
virtual |
bool mitk::AbstractUltrasoundTrackerDevice::RemoveCalibration | ( | ) |
Removes the calibration data of the currently active depth and probe.
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 |
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 |
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.
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.
void mitk::AbstractUltrasoundTrackerDevice::SetDelayCount | ( | unsigned int | delayCount | ) |
|
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 |
void mitk::AbstractUltrasoundTrackerDevice::SetNumberOfSmoothingValues | ( | unsigned int | numberOfSmoothingValues | ) |
|
virtual |
|
virtual |
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.
|
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.