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:

[legend]

Collaboration diagram for mitk::USCombinedModality:

[legend]

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< 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...

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

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...

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< 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 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::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< 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...

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

◆ ~USCombinedModality()

mitk::USCombinedModality::~USCombinedModality ( )

overrideprotected

Member Function Documentation

◆ GenerateData()

void mitk::USCombinedModality::GenerateData ( )

overrideprotected

Grabs the next frame from the input. This method is called internally, whenever Update() is invoked by an Output.

◆ GetUSPlaneTransform()

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

overridevirtual

Returns the index to world transform of the US plane.

Reimplemented from mitk::AbstractUltrasoundTrackerDevice.

◆ mitkClassMacro()

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

◆ mitkNewMacro3Param()

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

◆ OnFreeze()

void mitk::USCombinedModality::OnFreeze ( bool )

overrideprotectedvirtual

Freezes or unfreezes the CombinedModality.