A device holds information about it's model, make and the connected probes. It is the common super class for all devices and acts as an image source for mitkUSImages. It is the base class for all US Devices, and every new device should extend it. More...

#include <mitkUSDevice.h>

Inheritance diagram for mitk::USDevice:

[legend]

Collaboration diagram for mitk::USDevice:

[legend]

Classes
struct	PropertyKeys
	These constants are used in conjunction with Microservices. The constants aren't defined as static member attributes to avoid the "static initialization order fiasco", which would occur when objects of this class are used in module activators (for restoring stored device, for example). More...

struct	USImageCropArea

Public Types
enum	DeviceStates { State_NoState, State_Initialized, State_Connected, State_Activated }

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

Public Member Functions
	mitkClassMacro (USDevice, mitk::ImageSource)

virtual itk::SmartPointer< USControlInterfaceBMode >	GetControlInterfaceBMode ()
	Default getter for the b mode control interface. Has to be implemented in a subclass if a b mode control interface is available. Default implementation returns null. More...

virtual itk::SmartPointer< USControlInterfaceProbes >	GetControlInterfaceProbes ()
	Default getter for the probes control interface. Has to be implemented in a subclass if a probes control interface is available. Default implementation returns null. More...

virtual itk::SmartPointer< USControlInterfaceDoppler >	GetControlInterfaceDoppler ()
	Default getter for the doppler control interface. Has to be implemented in a subclass if a doppler control interface is available. Default implementation returns null. More...

bool	Initialize ()
	Changes device state to mitk::USDevice::State_Initialized. During initialization the virtual method mitk::USDevice::OnInitialization will be called. If this method returns false the initialization process will be canceled. Otherwise the mitk::USDevice is registered in a micro service. More...

bool	Connect ()
	Connects this device. A connected device is ready to deliver images (i.e. be Activated). A Connected Device can be active. A disconnected Device cannot be active. Internally calls onConnect and then registers the device with the service. A device usually should override the OnConnection() method, but never the Connect() method, since this will possibly exclude the device from normal service management. The exact flow of events is: 0. Check if the device is already connected. If yes, return true anyway, but don't do anything. More...

void	ConnectAsynchron ()

bool	Disconnect ()
	Works analogously to mitk::USDevice::Connect(). Don't override this Method, but onDisconnection instead. More...

bool	Activate ()
	Activates this device. After the activation process, the device will start to produce images. This Method will fail, if the device is not connected. More...

void	Deactivate ()
	Deactivates this device. After the deactivation process, the device will no longer produce images, but still be connected. More...

virtual void	SetIsFreezed (bool freeze)
	Can toggle if ultrasound image is currently updated or freezed. More...

virtual bool	GetIsFreezed ()

void	PushFilter (AbstractOpenCVImageFilter::Pointer filter)

void	PushFilterIfNotPushedBefore (AbstractOpenCVImageFilter::Pointer filter)

bool	RemoveFilter (AbstractOpenCVImageFilter::Pointer filter)

void	ProbeChanged (std::string probename)
	To be called when the used probe changed. Will update the service properties. More...

void	DepthChanged (double depth)
	To be called when the scanning depth of the probe changed. Will update the service properties. More...

void	UpdateServiceProperty (std::string key, std::string value)
	Given property is updated in the device micro service. This method is mainly for being used by the control interface superclasses. You do not need to call it by yoursefs in your concrete control interface classes. More...

void	UpdateServiceProperty (std::string key, double value)

void	UpdateServiceProperty (std::string key, bool value)

virtual std::string	GetDeviceClass ()=0
	Returns the Class of the Device. This Method must be reimplemented by every Inheriting Class. More...

bool	GetIsInitialized ()
	True, if the device object is created and initialized, false otherwise. More...

bool	GetIsActive ()
	True, if the device is currently generating image data, false otherwise. More...

bool	GetIsConnected ()
	True, if the device is currently ready to start transmitting image data or is already transmitting image data. A disconnected device cannot be activated. More...

mitk::USDevice::USImageCropArea	GetCropArea ()

virtual USImageSource::Pointer	GetUSImageSource ()=0

std::string	GetDeviceManufacturer ()
	Deprecated -> use GetManufacturer() instead. More...

std::string	GetDeviceModel ()
	Deprecated -> use GetName() instead. More...

std::string	GetDeviceComment ()
	Deprecated -> use GetCommend() instead. More...

virtual std::string	GetManufacturer ()

virtual std::string	GetName ()

virtual std::string	GetComment ()

void	SetManufacturer (std::string manufacturer)

void	SetName (std::string name)

void	SetComment (std::string comment)

virtual DeviceStates	GetDeviceState ()

virtual us::ServiceProperties	GetServiceProperties ()

void	GrabImage ()

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

virtual itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Make a DataObject of the correct type to used as the specified output. More...

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

Public Attributes
virtual mitkNewMessage2Macro(PropertyChanged, const std::string &, const std::string &) static mitk itk::SmartPointer< USAbstractControlInterface >	GetControlInterfaceCustom ()
	Event for being notified about changes of the micro service properties. This event can be used if no micro service context is available. More...

Protected Member Functions
virtual void	SetImage (mitk::Image::Pointer _arg)

virtual void	SetSpawnAcquireThread (bool _arg)

virtual bool	GetSpawnAcquireThread ()

void	ProvideViaOIGTL ()
	Registers an OpenIGTLink device as a microservice so that we can send the images of this device via the network. More...

void	DisableOIGTL ()
	Deregisters the microservices for OpenIGTLink. More...

us::ServiceProperties	ConstructServiceProperties ()
	This Method constructs the service properties which can later be used to register the object with the Microservices Return service properties. More...

void	UnregisterOnService ()
	Remove this device from the micro service. More...

virtual bool	OnInitialization ()=0
	Is called during the initialization process. Override this method in a subclass to handle the actual initialization. If it returns false, the initialization process will be canceled. More...

virtual bool	OnConnection ()=0
	Is called during the connection process. Override this method in a subclass to handle the actual connection. If it returns false, the connection process will be canceled. More...

virtual bool	OnDisconnection ()=0
	Is called during the disconnection process. Override this method in a subclass to handle the actual disconnection. If it returns false, the disconnection process will be canceled. More...

virtual bool	OnActivation ()=0
	Is called during the activation process. After this method is finished, the device should be generating images. If it returns false, the activation process will be canceled. More...

virtual bool	OnDeactivation ()=0
	Is called during the deactivation process. After a call to this method the device should still be connected, but not producing images anymore. More...

virtual void	OnFreeze (bool)
	Called when mitk::USDevice::SetIsFreezed() is called. Subclasses can overwrite this method to do additional actions. Default implementation does noting. More...

	USDevice (std::string manufacturer, std::string model)
	Enforces minimal Metadata to be set. More...

	USDevice (mitk::USImageMetadata::Pointer metadata)
	Constructs a device with the given Metadata. Make sure the Metadata contains meaningful content! More...

virtual	~USDevice ()

virtual void	GenerateData () override
	Grabs the next frame from the Video input. This method is called internally, whenever Update() is invoked by an Output. More...

std::string	GetServicePropertyLabel ()

Protected Member Functions inherited from mitk::ImageSource
	ImageSource ()

virtual	~ImageSource ()

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

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

virtual	~BaseDataSource ()

Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	Acquire (void *pInfoStruct)

static ITK_THREAD_RETURN_TYPE	ConnectThread (void *pInfoStruct)

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
mitk::Image::Pointer	m_Image

mitk::Image::Pointer	m_OutputImage

mitk::IGTLServer::Pointer	m_IGTLServer

mitk::IGTLMessageProvider::Pointer	m_IGTLMessageProvider

mitk::ImageToIGTLMessageFilter::Pointer	m_ImageToIGTLMsgFilter

bool	m_IsFreezed

DeviceStates	m_DeviceState

USImageCropArea	m_CropArea

Additional Inherited Members
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 ()

Detailed Description

A device holds information about it's model, make and the connected probes. It is the common super class for all devices and acts as an image source for mitkUSImages. It is the base class for all US Devices, and every new device should extend it.

US Devices support output of calibrated images, i.e. images that include a specific geometry. To achieve this, call SetCalibration, and make sure that the subclass also calls apply transformation at some point (The USDevice does not automatically apply the transformation to the image)

Note that USDevices will be removed from micro servive when their destructor is called. Registering into micro service is done when mitk::USDevice::Initialize() is called.

Definition at line 77 of file mitkUSDevice.h.

Member Enumeration Documentation

enum mitk::USDevice::DeviceStates

Enumerator
State_NoState
State_Initialized
State_Connected
State_Activated

Definition at line 80 of file mitkUSDevice.h.

Constructor & Destructor Documentation

mitk::USDevice::USDevice	(	std::string	manufacturer,
		std::string	model
	)

protected

Enforces minimal Metadata to be set.

Definition at line 45 of file mitkUSDevice.cpp.

References mitk::USDevice::USImageCropArea::cropBottom, mitk::USDevice::USImageCropArea::cropLeft, mitk::USDevice::USImageCropArea::cropRight, mitk::USDevice::USImageCropArea::cropTop, m_CropArea, and mitk::Image::New().

mitk::USDevice::USDevice ( mitk::USImageMetadata::Pointer metadata )

protected

Constructs a device with the given Metadata. Make sure the Metadata contains meaningful content!

Deprecated:: Use USDevice(std::string manufacturer, std::string model) instead.

Definition at line 72 of file mitkUSDevice.cpp.

References mitk::USDevice::USImageCropArea::cropBottom, mitk::USDevice::USImageCropArea::cropLeft, mitk::USDevice::USImageCropArea::cropRight, mitk::USDevice::USImageCropArea::cropTop, m_CropArea, and mitk::Image::New().

mitk::USDevice::~USDevice ( )

protectedvirtual

Definition at line 101 of file mitkUSDevice.cpp.

Member Function Documentation

ITK_THREAD_RETURN_TYPE mitk::USDevice::Acquire ( void * pInfoStruct )

staticprotected

Definition at line 618 of file mitkUSDevice.cpp.

References GetIsActive(), GrabImage(), and m_IsFreezed.

bool mitk::USDevice::Activate ( )

Activates this device. After the activation process, the device will start to produce images. This Method will fail, if the device is not connected.

Definition at line 296 of file mitkUSDevice.cpp.

References MITK_INFO, and mitk::New().

bool mitk::USDevice::Connect ( )

Connects this device. A connected device is ready to deliver images (i.e. be Activated). A Connected Device can be active. A disconnected Device cannot be active. Internally calls onConnect and then registers the device with the service. A device usually should override the OnConnection() method, but never the Connect() method, since this will possibly exclude the device from normal service management. The exact flow of events is: 0. Check if the device is already connected. If yes, return true anyway, but don't do anything.

Call OnConnection() Here, a device should establish it's connection with the hardware Afterwards, it should be ready to start transmitting images at any time.
If OnConnection() returns true ("successful"), then the device is registered with the service.
if not, it the method itself returns false or may throw an expection, depeneding on the device implementation.

Definition at line 238 of file mitkUSDevice.cpp.

References MITK_DEBUG, MITK_ERROR, and MITK_INFO.

Referenced by ConnectThread().

void mitk::USDevice::ConnectAsynchron ( )

Definition at line 270 of file mitkUSDevice.cpp.

ITK_THREAD_RETURN_TYPE mitk::USDevice::ConnectThread ( void * pInfoStruct )

staticprotected

Definition at line 643 of file mitkUSDevice.cpp.

References Connect().

us::ServiceProperties mitk::USDevice::ConstructServiceProperties ( )

protected

This Method constructs the service properties which can later be used to register the object with the Microservices Return service properties.

Definition at line 172 of file mitkUSDevice.cpp.

References mitk::USDevice::PropertyKeys::US_PROPKEY_CLASS, mitk::USDevice::PropertyKeys::US_PROPKEY_COMMENT, mitk::USDevice::PropertyKeys::US_PROPKEY_ISACTIVE, mitk::USDevice::PropertyKeys::US_PROPKEY_ISCONNECTED, mitk::USDevice::PropertyKeys::US_PROPKEY_LABEL, mitk::USDevice::PropertyKeys::US_PROPKEY_MANUFACTURER, mitk::USDevice::PropertyKeys::US_PROPKEY_NAME, and mitk::USDevice::PropertyKeys::US_PROPKEY_PROBES_SELECTED.

void mitk::USDevice::Deactivate ( )

Deactivates this device. After the deactivation process, the device will no longer produce images, but still be connected.

Definition at line 369 of file mitkUSDevice.cpp.

References MITK_WARN.

void mitk::USDevice::DepthChanged ( double depth )

To be called when the scanning depth of the probe changed. Will update the service properties.

Parameters

depth that is now used

Definition at line 661 of file mitkUSDevice.cpp.

void mitk::USDevice::DisableOIGTL ( )

protected

Deregisters the microservices for OpenIGTLink.

Definition at line 393 of file mitkUSDevice.cpp.

bool mitk::USDevice::Disconnect ( )

Works analogously to mitk::USDevice::Connect(). Don't override this Method, but onDisconnection instead.

Definition at line 275 of file mitkUSDevice.cpp.

References MITK_WARN.

Referenced by QmitkUSDeviceManagerWidget::DisconnectAllDevices().

void mitk::USDevice::GenerateData ( )

overrideprotectedvirtual

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

Reimplemented from mitk::ImageSource.

Reimplemented in mitk::USCombinedModality.

Definition at line 576 of file mitkUSDevice.cpp.

virtual std::string mitk::USDevice::GetComment ( )

virtual

mitk::USControlInterfaceBMode::Pointer mitk::USDevice::GetControlInterfaceBMode ( )

virtual

Default getter for the b mode control interface. Has to be implemented in a subclass if a b mode control interface is available. Default implementation returns null.

Returns: null pointer

Reimplemented in mitk::USCombinedModality, and mitk::USTelemedDevice.

Definition at line 121 of file mitkUSDevice.cpp.

References MITK_INFO.

mitk::USControlInterfaceDoppler::Pointer mitk::USDevice::GetControlInterfaceDoppler ( )

virtual

Default getter for the doppler control interface. Has to be implemented in a subclass if a doppler control interface is available. Default implementation returns null.

Returns: null pointer

Reimplemented in mitk::USCombinedModality, and mitk::USTelemedDevice.

Definition at line 135 of file mitkUSDevice.cpp.

References MITK_INFO.

mitk::USControlInterfaceProbes::Pointer mitk::USDevice::GetControlInterfaceProbes ( )

virtual

Default getter for the probes control interface. Has to be implemented in a subclass if a probes control interface is available. Default implementation returns null.

Returns: null pointer

Reimplemented in mitk::USCombinedModality, and mitk::USTelemedDevice.

Definition at line 128 of file mitkUSDevice.cpp.

References MITK_INFO.

mitk::USDevice::USImageCropArea mitk::USDevice::GetCropArea ( )

Definition at line 37 of file mitkUSDevice.cpp.

References MITK_INFO.

virtual std::string mitk::USDevice::GetDeviceClass ( )

pure virtual

Returns the Class of the Device. This Method must be reimplemented by every Inheriting Class.

Implemented in mitk::USCombinedModality, mitk::USVideoDevice, mitk::USTelemedDevice, and mitk::USIGTLDevice.

std::string mitk::USDevice::GetDeviceComment ( )

Deprecated -> use GetCommend() instead.

Definition at line 574 of file mitkUSDevice.cpp.

std::string mitk::USDevice::GetDeviceManufacturer ( )

Deprecated -> use GetManufacturer() instead.

Definition at line 570 of file mitkUSDevice.cpp.

std::string mitk::USDevice::GetDeviceModel ( )

Deprecated -> use GetName() instead.

Definition at line 572 of file mitkUSDevice.cpp.

virtual DeviceStates mitk::USDevice::GetDeviceState ( )

virtual

bool mitk::USDevice::GetIsActive ( )

True, if the device is currently generating image data, false otherwise.

Definition at line 563 of file mitkUSDevice.cpp.

Referenced by Acquire().

bool mitk::USDevice::GetIsConnected ( )

True, if the device is currently ready to start transmitting image data or is already transmitting image data. A disconnected device cannot be activated.

Definition at line 565 of file mitkUSDevice.cpp.

bool mitk::USDevice::GetIsFreezed ( )

virtual

Returns: true if device is currently freezed (no image update is done), false otherwise

Definition at line 426 of file mitkUSDevice.cpp.

References MITK_WARN.

bool mitk::USDevice::GetIsInitialized ( )

True, if the device object is created and initialized, false otherwise.

Definition at line 558 of file mitkUSDevice.cpp.

virtual std::string mitk::USDevice::GetManufacturer ( )

virtual

virtual std::string mitk::USDevice::GetName ( )

virtual

virtual us::ServiceProperties mitk::USDevice::GetServiceProperties ( )

virtual

std::string mitk::USDevice::GetServicePropertyLabel ( )

protected

Definition at line 603 of file mitkUSDevice.cpp.

virtual bool mitk::USDevice::GetSpawnAcquireThread ( )

protectedvirtual

virtual USImageSource::Pointer mitk::USDevice::GetUSImageSource ( )

pure virtual

Returns: Returns the current image source of this device.

Implemented in mitk::USCombinedModality, mitk::USTelemedDevice, mitk::USVideoDevice, and mitk::USIGTLDevice.

void mitk::USDevice::GrabImage ( )

mitk::Image* mitk::USDevice::GetOutput() { if (this->GetNumberOfOutputs() < 1) return NULL;

return static_cast<USImage*>(this->ProcessObject::GetPrimaryOutput()); }

mitk::Image* mitk::USDevice::GetOutput(unsigned int idx) { if (this->GetNumberOfOutputs() < 1) return NULL; return static_cast<USImage*>(this->ProcessObject::GetOutput(idx)); }

void mitk::USDevice::GraftOutput(itk::DataObject *graft) { this->GraftNthOutput(0, graft); }

void mitk::USDevice::GraftNthOutput(unsigned int idx, itk::DataObject *graft) { if ( idx >= this->GetNumberOfOutputs() ) { itkExceptionMacro(<<"Requested to graft output " << idx << " but this filter only has " << this->GetNumberOfOutputs() << " Outputs."); }

if ( !graft ) { itkExceptionMacro(<<"Requested to graft output with a NULL pointer object" ); }

itk::DataObject* output = this->GetOutput(idx); if ( !output ) { itkExceptionMacro(<<"Requested to graft output that is a NULL pointer" ); } Call Graft on USImage to copy member data output->Graft( graft ); }

Definition at line 546 of file mitkUSDevice.cpp.

Referenced by Acquire().

bool mitk::USDevice::Initialize ( )

Changes device state to mitk::USDevice::State_Initialized. During initialization the virtual method mitk::USDevice::OnInitialization will be called. If this method returns false the initialization process will be canceled. Otherwise the mitk::USDevice is registered in a micro service.

Definition at line 220 of file mitkUSDevice.cpp.

References us::GetModuleContext().

mitk::USDevice::mitkClassMacro	(	USDevice	,
		mitk::ImageSource
	)

virtual bool mitk::USDevice::OnActivation ( )

protectedpure virtual

Is called during the activation process. After this method is finished, the device should be generating images. If it returns false, the activation process will be canceled.

Returns: true if successful and false if unsuccessful

Exceptions

mitk::Exception implementation may throw an exception to clarify what went wrong

Implemented in mitk::USCombinedModality, mitk::USVideoDevice, mitk::USTelemedDevice, and mitk::USIGTLDevice.

virtual bool mitk::USDevice::OnConnection ( )

protectedpure virtual

Is called during the connection process. Override this method in a subclass to handle the actual connection. If it returns false, the connection process will be canceled.

Returns: true if successful and false if unsuccessful

Exceptions

mitk::Exception implementation may throw an exception to clarify what went wrong

Implemented in mitk::USCombinedModality, mitk::USVideoDevice, mitk::USTelemedDevice, and mitk::USIGTLDevice.

virtual bool mitk::USDevice::OnDeactivation ( )

protectedpure virtual

Is called during the deactivation process. After a call to this method the device should still be connected, but not producing images anymore.

Returns: true if successful and false if unsuccessful

Exceptions

mitk::Exception implementation may throw an exception to clarify what went wrong

Implemented in mitk::USCombinedModality, mitk::USVideoDevice, mitk::USTelemedDevice, and mitk::USIGTLDevice.

virtual bool mitk::USDevice::OnDisconnection ( )

protectedpure virtual

Is called during the disconnection process. Override this method in a subclass to handle the actual disconnection. If it returns false, the disconnection process will be canceled.

Returns: true if successful and false if unsuccessful

Exceptions

mitk::Exception implementation may throw an exception to clarify what went wrong

Implemented in mitk::USCombinedModality, mitk::USVideoDevice, mitk::USTelemedDevice, and mitk::USIGTLDevice.

virtual void mitk::USDevice::OnFreeze ( bool )

inlineprotectedvirtual

Called when mitk::USDevice::SetIsFreezed() is called. Subclasses can overwrite this method to do additional actions. Default implementation does noting.

Reimplemented in mitk::USCombinedModality, and mitk::USTelemedDevice.

Definition at line 415 of file mitkUSDevice.h.

virtual bool mitk::USDevice::OnInitialization ( )

protectedpure virtual

Is called during the initialization process. Override this method in a subclass to handle the actual initialization. If it returns false, the initialization process will be canceled.

Returns: true if successful and false if unsuccessful

Exceptions

mitk::Exception implementation may throw an exception to clarify what went wrong

Implemented in mitk::USCombinedModality, mitk::USVideoDevice, mitk::USTelemedDevice, and mitk::USIGTLDevice.

void mitk::USDevice::ProbeChanged ( std::string probename )

To be called when the used probe changed. Will update the service properties.

Parameters

probename of the now used probe

Definition at line 656 of file mitkUSDevice.cpp.

void mitk::USDevice::ProvideViaOIGTL ( )

protected

Registers an OpenIGTLink device as a microservice so that we can send the images of this device via the network.

Definition at line 337 of file mitkUSDevice.cpp.

References GetName(), mitk::ImageToIGTLMessageFilter::New(), mitk::New(), and mitk::IGTLMessageProvider::New().

void mitk::USDevice::PushFilter ( AbstractOpenCVImageFilter::Pointer filter )

Definition at line 439 of file mitkUSDevice.cpp.

References MITK_ERROR, and mitkThrow.

void mitk::USDevice::PushFilterIfNotPushedBefore ( AbstractOpenCVImageFilter::Pointer filter )

Definition at line 451 of file mitkUSDevice.cpp.

References MITK_ERROR, and mitkThrow.

bool mitk::USDevice::RemoveFilter ( AbstractOpenCVImageFilter::Pointer filter )

Definition at line 467 of file mitkUSDevice.cpp.

References MITK_ERROR, and mitkThrow.

void mitk::USDevice::SetComment ( std::string comment )

Definition at line 162 of file mitkUSDevice.cpp.

virtual void mitk::USDevice::SetImage ( mitk::Image::Pointer _arg )

protectedvirtual

void mitk::USDevice::SetIsFreezed ( bool freeze )

virtual

Can toggle if ultrasound image is currently updated or freezed.

Parameters

freeze true to stop updating the ultrasound image, false to start updating again

Definition at line 402 of file mitkUSDevice.cpp.

References MITK_WARN.

void mitk::USDevice::SetManufacturer ( std::string manufacturer )

Definition at line 141 of file mitkUSDevice.cpp.

void mitk::USDevice::SetName ( std::string name )

Definition at line 152 of file mitkUSDevice.cpp.

virtual void mitk::USDevice::SetSpawnAcquireThread ( bool _arg )

protectedvirtual

Referenced by mitk::USCombinedModality::USCombinedModality().

void mitk::USDevice::UnregisterOnService ( )

protected

Remove this device from the micro service.

Definition at line 207 of file mitkUSDevice.cpp.

Referenced by mitk::USVideoDevice::UnregisterOnService().

void mitk::USDevice::UpdateServiceProperty	(	std::string	key,
		std::string	value
	)

Given property is updated in the device micro service. This method is mainly for being used by the control interface superclasses. You do not need to call it by yoursefs in your concrete control interface classes.

Definition at line 479 of file mitkUSDevice.cpp.

void mitk::USDevice::UpdateServiceProperty	(	std::string	key,
		double	value
	)

Definition at line 488 of file mitkUSDevice.cpp.

void mitk::USDevice::UpdateServiceProperty	(	std::string	key,
		bool	value
	)

Definition at line 495 of file mitkUSDevice.cpp.

Member Data Documentation

mitk::USAbstractControlInterface::Pointer mitk::USDevice::GetControlInterfaceCustom

Event for being notified about changes of the micro service properties. This event can be used if no micro service context is available.

Returns: keys for the microservice properties of ultrasound devices Default getter for the custom control interface. Has to be implemented in a subclass if a custom control interface is available. Default implementation returns null.; null pointer

Definition at line 156 of file mitkUSDevice.h.

USImageCropArea mitk::USDevice::m_CropArea

protected

Definition at line 346 of file mitkUSDevice.h.

Referenced by USDevice().

DeviceStates mitk::USDevice::m_DeviceState

protected

Definition at line 343 of file mitkUSDevice.h.

mitk::IGTLMessageProvider::Pointer mitk::USDevice::m_IGTLMessageProvider

protected

Definition at line 338 of file mitkUSDevice.h.

mitk::IGTLServer::Pointer mitk::USDevice::m_IGTLServer

protected

Definition at line 337 of file mitkUSDevice.h.

mitk::Image::Pointer mitk::USDevice::m_Image

protected

Definition at line 323 of file mitkUSDevice.h.

mitk::ImageToIGTLMessageFilter::Pointer mitk::USDevice::m_ImageToIGTLMsgFilter

protected

Definition at line 339 of file mitkUSDevice.h.

bool mitk::USDevice::m_IsFreezed

protected

Definition at line 341 of file mitkUSDevice.h.

Referenced by Acquire().

mitk::Image::Pointer mitk::USDevice::m_OutputImage

protected

Definition at line 324 of file mitkUSDevice.h.

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

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation