mitk::ImageToIGTLMessageFilter Class Reference

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

#include <mitkImageToIGTLMessageFilter.h>

Inheritance diagram for mitk::ImageToIGTLMessageFilter:

Public Member Functions
	mitkClassMacro (ImageToIGTLMessageFilter, IGTLMessageSource)
	itkFactorylessNewMacro (Self)
	itkCloneMacro (Self)
void	GenerateData () override
	filter execute method
virtual void	SetInput (const mitk::Image *img)
	Sets one input Image.
virtual void	SetInput (unsigned int idx, const Image *img)
	Sets the input Image at a specific index.
const mitk::Image *	GetInput ()
	Returns the input of this filter.
const mitk::Image *	GetInput (unsigned int idx)
	Returns the input of this filter.
void	GenerateOutputInformation () override
virtual void	ConnectTo (mitk::ImageSource *UpstreamFilter)
Public Member Functions inherited from mitk::IGTLMessageSource
	mitkClassMacroItkParent (IGTLMessageSource, itk::ProcessObject)
	itkGetMacro (Name, std::string)
	itkSetMacro (Name, std::string)
	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.
	itkGetMacro (Type, std::string)
	itkSetMacro (Type, std::string)
	Sets the human readable type of this source. There will be a default type, or you can set the name with the method SetType(). You have to set this parameter otherwise it will not be found by the message provider.
IGTLMessage *	GetOutput (void)
	return the output (output with id 0) of the filter
IGTLMessage *	GetOutput (DataObjectPointerArraySizeType idx)
	return the output with id idx of the filter
IGTLMessage *	GetOutput (const std::string &messageName)
	return the output with name messageName of the filter
DataObjectPointerArraySizeType	GetOutputIndex (std::string messageName)
	return the index of the output with name messageName, -1 if no output with that name was found
virtual void	RegisterAsMicroservice ()
	Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice().
virtual void	UnRegisterMicroservice ()
	Registers this object as a Microservice, making it available to every module and/or plugin.
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().
virtual void	GraftNthOutput (unsigned int idx, itk::DataObject *graft)
	Graft the specified DataObject onto this ProcessObject's output.
virtual void	GraftOutput (itk::DataObject *graft)
	Graft the specified DataObject onto this ProcessObject's output.
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.
virtual mitk::PropertyList::ConstPointer	GetParameters () const
	Get all filter parameters as a PropertyList.
void	SetFPS (unsigned int fps)
	Sets the fps used for streaming this source.
unsigned int	GetFPS ()
	Gets the fps used for streaming this source.

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

Protected Attributes
mitk::ImageSource *	m_Upstream
Protected Attributes inherited from mitk::IGTLMessageSource
std::string	m_Name
std::string	m_Type
std::mutex	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.
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

Definition at line 18 of file mitkImageToIGTLMessageFilter.cpp.

~ImageToIGTLMessageFilter()

mitk::ImageToIGTLMessageFilter::~ImageToIGTLMessageFilter ( )

inlineoverrideprotected

Definition at line 83 of file mitkImageToIGTLMessageFilter.h.

Member Function Documentation

ConnectTo()

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

virtual

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

Definition at line 239 of file mitkImageToIGTLMessageFilter.cpp.

CreateOutputsForAllInputs()

void mitk::ImageToIGTLMessageFilter::CreateOutputsForAllInputs ( )

protectedvirtual

create output objects for all inputs

Definition at line 249 of file mitkImageToIGTLMessageFilter.cpp.

GenerateData()

void mitk::ImageToIGTLMessageFilter::GenerateData ( )

override

filter execute method

Definition at line 26 of file mitkImageToIGTLMessageFilter.cpp.

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

(

void

)

Returns the input of this filter.

Definition at line 223 of file mitkImageToIGTLMessageFilter.cpp.

GetInput() [2/2]

const mitk::Image * mitk::ImageToIGTLMessageFilter::GetInput

(

unsigned int

idx

)

Returns the input of this filter.

Definition at line 230 of file mitkImageToIGTLMessageFilter.cpp.

itkCloneMacro()

mitk::ImageToIGTLMessageFilter::itkCloneMacro

(

Self

)

itkFactorylessNewMacro()

mitk::ImageToIGTLMessageFilter::itkFactorylessNewMacro

(

Self

)

mitkClassMacro()

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

SetInput() [1/2]

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

virtual

Sets one input Image.

Definition at line 210 of file mitkImageToIGTLMessageFilter.cpp.

SetInput() [2/2]

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

virtual

Sets the input Image at a specific index.

Definition at line 216 of file mitkImageToIGTLMessageFilter.cpp.

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

• Modules/OpenIGTLink/Filters/mitkImageToIGTLMessageFilter.h
• Modules/OpenIGTLink/Filters/mitkImageToIGTLMessageFilter.cpp