Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::USIGTLDevice Class Reference

A mitk::USIGTLDevice is a USDevice to receive images over an OpenIGTLink connection. It registers an OIGTL device as a Microservice to receive image messages and transforms them to mitk::Images. It can act both as a server (listening for incoming connections) and as a client (connecting to an existing OIGTL server). More...

#include <mitkUSIGTLDevice.h>

Inheritance diagram for mitk::USIGTLDevice:
Collaboration diagram for mitk::USIGTLDevice:

Public Member Functions

 mitkClassMacro (USIGTLDevice, mitk::USDevice)
 
 mitkNewMacro5Param (Self, std::string, std::string, std::string, int, bool)
 
virtual std::string GetDeviceClass ()
 Returns the Class of the Device. This Method must be reimplemented by every Inheriting Class. More...
 
virtual USImageSource::Pointer GetUSImageSource ()
 
 USIGTLDevice (std::string manufacturer, std::string model, std::string host, int port, bool server)
 
- Public Member Functions inherited from mitk::USDevice
 mitkClassMacro (USDevice, mitk::ImageSource)
 
virtual itk::SmartPointer< USControlInterfaceBModeGetControlInterfaceBMode ()
 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< USControlInterfaceProbesGetControlInterfaceProbes ()
 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< USControlInterfaceDopplerGetControlInterfaceDoppler ()
 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)
 
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 ()
 
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
 
OutputTypeGetOutput ()
 Get the output data of this image source object. More...
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (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
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

virtual bool OnInitialization ()
 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 ()
 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 ()
 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 ()
 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 ()
 Is called during the deactivation process. After a call to this method the device should still be connected, but not producing images anymore. More...
 
- Protected Member Functions inherited from mitk::USDevice
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 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 ()
 

Additional Inherited Members

- Public Types inherited from mitk::USDevice
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< 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 ()
 
- Public Attributes inherited from mitk::USDevice
virtual mitkNewMessage2Macro(PropertyChanged, const std::string &, const std::string &) static mitk itk::SmartPointer< USAbstractControlInterfaceGetControlInterfaceCustom ()
 Event for being notified about changes of the micro service properties. This event can be used if no micro service context is available. More...
 
- Static Protected Member Functions inherited from mitk::USDevice
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 inherited from mitk::USDevice
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
 

Detailed Description

A mitk::USIGTLDevice is a USDevice to receive images over an OpenIGTLink connection. It registers an OIGTL device as a Microservice to receive image messages and transforms them to mitk::Images. It can act both as a server (listening for incoming connections) and as a client (connecting to an existing OIGTL server).

Definition at line 39 of file mitkUSIGTLDevice.h.

Constructor & Destructor Documentation

mitk::USIGTLDevice::USIGTLDevice ( std::string  manufacturer,
std::string  model,
std::string  host,
int  port,
bool  server 
)

Member Function Documentation

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

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

Implements mitk::USDevice.

Definition at line 48 of file mitkUSIGTLDevice.cpp.

mitk::USImageSource::Pointer mitk::USIGTLDevice::GetUSImageSource ( )
virtual
Returns
Returns the current image source of this device.

Implements mitk::USDevice.

Definition at line 50 of file mitkUSIGTLDevice.cpp.

mitk::USIGTLDevice::mitkClassMacro ( USIGTLDevice  ,
mitk::USDevice   
)
mitk::USIGTLDevice::mitkNewMacro5Param ( Self  ,
std::string  ,
std::string  ,
std::string  ,
int  ,
bool   
)
bool mitk::USIGTLDevice::OnActivation ( )
protectedvirtual

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::Exceptionimplementation may throw an exception to clarify what went wrong

Implements mitk::USDevice.

Definition at line 64 of file mitkUSIGTLDevice.cpp.

bool mitk::USIGTLDevice::OnConnection ( )
protectedvirtual

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::Exceptionimplementation may throw an exception to clarify what went wrong

Implements mitk::USDevice.

Definition at line 57 of file mitkUSIGTLDevice.cpp.

bool mitk::USIGTLDevice::OnDeactivation ( )
protectedvirtual

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::Exceptionimplementation may throw an exception to clarify what went wrong

Implements mitk::USDevice.

Definition at line 69 of file mitkUSIGTLDevice.cpp.

bool mitk::USIGTLDevice::OnDisconnection ( )
protectedvirtual

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::Exceptionimplementation may throw an exception to clarify what went wrong

Implements mitk::USDevice.

Definition at line 59 of file mitkUSIGTLDevice.cpp.

bool mitk::USIGTLDevice::OnInitialization ( )
protectedvirtual

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::Exceptionimplementation may throw an exception to clarify what went wrong

Implements mitk::USDevice.

Definition at line 55 of file mitkUSIGTLDevice.cpp.


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