Medical Imaging Interaction Toolkit  2018.4.99-65942676
Medical Imaging Interaction Toolkit
mitk::ImageToIGTLMessageFilter Class Reference

This filter creates IGTL messages from mitk::Image objects. More...

#include <mitkImageToIGTLMessageFilter.h>

Inheritance diagram for mitk::ImageToIGTLMessageFilter:
Collaboration diagram for mitk::ImageToIGTLMessageFilter:

Public Member Functions

 mitkClassMacro (ImageToIGTLMessageFilter, IGTLMessageSource)
 
Pointer Clone () const
 
void GenerateData () override
 filter execute method More...
 
virtual void SetInput (const mitk::Image *img)
 Sets one input Image. More...
 
virtual void SetInput (unsigned int idx, const Image *img)
 Sets the input Image at a specific index. More...
 
const mitk::ImageGetInput ()
 Returns the input of this filter. More...
 
const mitk::ImageGetInput (unsigned int idx)
 Returns the input of this filter. More...
 
void GenerateOutputInformation () override
 
virtual void ConnectTo (mitk::ImageSource *UpstreamFilter)
 Connects the input of this filter to the outputs of the given ImageSource. More...
 
- Public Member Functions inherited from mitk::IGTLMessageSource
 mitkClassMacroItkParent (IGTLMessageSource, itk::ProcessObject)
 
virtual std::string GetName ()
 
virtual void SetName (std::string _arg)
 Sets the human readable name of this source. There is also a default name, but you can use this method if you need to define it on your own. More...
 
virtual std::string GetType ()
 
virtual void SetType (std::string _arg)
 
IGTLMessageGetOutput (void)
 return the output (output with id 0) of the filter More...
 
IGTLMessageGetOutput (DataObjectPointerArraySizeType idx)
 return the output with id idx of the filter More...
 
IGTLMessageGetOutput (const std::string &messageName)
 return the output with name messageName of the filter More...
 
DataObjectPointerArraySizeType GetOutputIndex (std::string messageName)
 return the index of the output with name messageName, -1 if no output with that name was found More...
 
virtual void RegisterAsMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice(). More...
 
virtual void UnRegisterMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. More...
 
std::string GetMicroserviceID ()
 Returns the id that this device is registered with. The id will only be valid, if the IGTLMessageSource has been registered using RegisterAsMicroservice(). More...
 
virtual void GraftNthOutput (unsigned int idx, itk::DataObject *graft)
 Graft the specified DataObject onto this ProcessObject's output. More...
 
virtual void GraftOutput (itk::DataObject *graft)
 Graft the specified DataObject onto this ProcessObject's output. More...
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual void SetParameters (const mitk::PropertyList *)
 Set all filter parameters as the PropertyList p. More...
 
virtual mitk::PropertyList::ConstPointer GetParameters () const
 Get all filter parameters as a PropertyList. More...
 
void SetFPS (unsigned int fps)
 Sets the fps used for streaming this source. More...
 
unsigned int GetFPS ()
 Gets the fps used for streaming this source. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ImageToIGTLMessageFilter ()
 
 ~ImageToIGTLMessageFilter () override
 
virtual void CreateOutputsForAllInputs ()
 create output objects for all inputs More...
 
- Protected Member Functions inherited from mitk::IGTLMessageSource
 IGTLMessageSource ()
 
 ~IGTLMessageSource () override
 

Protected Attributes

mitk::ImageSourcem_Upstream
 
- Protected Attributes inherited from mitk::IGTLMessageSource
std::string m_Name
 
std::string m_Type
 
itk::FastMutexLock::Pointer m_StreamingFPSMutex
 
unsigned int m_StreamingFPS
 
us::ServiceRegistration< Self > m_ServiceRegistration
 

Additional Inherited Members

- Static Public Attributes inherited from mitk::IGTLMessageSource
static const std::string US_INTERFACE_NAME
 These Constants are used in conjunction with Microservices. More...
 
static const std::string US_PROPKEY_DEVICENAME
 
static const std::string US_PROPKEY_DEVICETYPE
 
static const std::string US_PROPKEY_ID
 
static const std::string US_PROPKEY_ISACTIVE
 

Detailed Description

This filter creates IGTL messages from mitk::Image objects.

Documentation

Definition at line 30 of file mitkImageToIGTLMessageFilter.h.

Constructor & Destructor Documentation

◆ ImageToIGTLMessageFilter()

mitk::ImageToIGTLMessageFilter::ImageToIGTLMessageFilter ( )
protected

◆ ~ImageToIGTLMessageFilter()

mitk::ImageToIGTLMessageFilter::~ImageToIGTLMessageFilter ( )
inlineoverrideprotected

Definition at line 83 of file mitkImageToIGTLMessageFilter.h.

Member Function Documentation

◆ Clone()

Pointer mitk::ImageToIGTLMessageFilter::Clone ( ) const

◆ ConnectTo()

virtual void mitk::ImageToIGTLMessageFilter::ConnectTo ( mitk::ImageSource UpstreamFilter)
virtual

Connects the input of this filter to the outputs of the given ImageSource.

This method does not support smartpointer. use FilterX.GetPointer() to retrieve a dumbpointer.

◆ CreateOutputsForAllInputs()

virtual void mitk::ImageToIGTLMessageFilter::CreateOutputsForAllInputs ( )
protectedvirtual

create output objects for all inputs

◆ GenerateData()

void mitk::ImageToIGTLMessageFilter::GenerateData ( )
override

filter execute method

◆ GenerateOutputInformation()

void mitk::ImageToIGTLMessageFilter::GenerateOutputInformation ( )
inlineoverride

empty implementation to prevent calling of the superclass method that would try to copy information from the input Image to the output PointSet, which makes no sense!

Definition at line 69 of file mitkImageToIGTLMessageFilter.h.

◆ GetInput() [1/2]

const mitk::Image* mitk::ImageToIGTLMessageFilter::GetInput ( )

Returns the input of this filter.

◆ GetInput() [2/2]

const mitk::Image* mitk::ImageToIGTLMessageFilter::GetInput ( unsigned int  idx)

Returns the input of this filter.

◆ mitkClassMacro()

mitk::ImageToIGTLMessageFilter::mitkClassMacro ( ImageToIGTLMessageFilter  ,
IGTLMessageSource   
)

◆ New()

static Pointer mitk::ImageToIGTLMessageFilter::New ( )
static

◆ SetInput() [1/2]

virtual void mitk::ImageToIGTLMessageFilter::SetInput ( const mitk::Image img)
virtual

Sets one input Image.

◆ SetInput() [2/2]

virtual void mitk::ImageToIGTLMessageFilter::SetInput ( unsigned int  idx,
const Image img 
)
virtual

Sets the input Image at a specific index.

Member Data Documentation

◆ m_Upstream

mitk::ImageSource* mitk::ImageToIGTLMessageFilter::m_Upstream
protected

Definition at line 90 of file mitkImageToIGTLMessageFilter.h.


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