IGTLinkMessageToNavigationDataFilter is a filter that receives OpenIGTLink messages as input and produce NavigationDatas as output. More...

#include <mitkIGTLMessageToNavigationDataFilter.h>

Inheritance diagram for mitk::IGTLMessageToNavigationDataFilter:

[legend]

Collaboration diagram for mitk::IGTLMessageToNavigationDataFilter:

[legend]

Public Member Functions
	mitkClassMacro (IGTLMessageToNavigationDataFilter, NavigationDataSource)

Pointer	Clone () const

virtual void	SetInput (const IGTLMessage *msg)
	Set the input of this filter. More...

virtual void	SetInput (unsigned int idx, const IGTLMessage *msg)
	Set input with id idx of this filter. More...

const IGTLMessage *	GetInput (void) const
	Get the input of this filter. More...

const IGTLMessage *	GetInput (unsigned int idx) const
	Get the input with id idx of this filter. More...

const IGTLMessage *	GetInput (std::string messageName) const
	Get the input with name messageName of this filter. More...

DataObjectPointerArraySizeType	GetInputIndex (std::string messageName)
	return the index of the input with name messageName, throw std::invalid_argument exception if that name was not found More...

virtual void	ConnectTo (mitk::IGTLMessageSource *UpstreamFilter)
	Connects the input of this filter to the outputs of the given IGTLMessageSource. More...

void	SetNumberOfExpectedOutputs (unsigned int numOutputs)
	Sets the number of expected outputs. More...

Public Member Functions inherited from mitk::NavigationDataSource
	mitkClassMacroItkParent (NavigationDataSource, 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...

NavigationData *	GetOutput (void)
	return the output (output with id 0) of the filter More...

NavigationData *	GetOutput (DataObjectPointerArraySizeType idx)
	return the output with id idx of the filter More...

NavigationData *	GetOutput (const std::string &navDataName)
	return the output with name navDataName of the filter More...

NavigationTool::Pointer	GetToolMetaData (DataObjectPointerArraySizeType idx)

NavigationTool::Pointer	GetToolMetaData (const std::string &navDataName)

virtual mitk::NavigationToolStorage::Pointer	GetToolMetaDataCollection ()

virtual void	SetToolMetaDataCollection (mitk::NavigationToolStorage::Pointer _arg)

DataObjectPointerArraySizeType	GetOutputIndex (std::string navDataName)
	return the index of the output with name navDataName, -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 NavigationDataSource 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...

virtual void	Freeze ()

virtual void	UnFreeze ()

virtual bool	GetIsFrozen ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	IGTLMessageToNavigationDataFilter ()

	~IGTLMessageToNavigationDataFilter () override

void	GenerateData () override

void	GenerateTransformData ()

void	GenerateTrackingDataData ()

void	GenerateQuaternionTrackingDataData ()

void	CreateOutputsForAllInputs ()
	Create an output for each input. More...

void	GenerateOutputInformation () override
	Defines how the input will be copied into the output. More...

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

	~NavigationDataSource () override

Additional Inherited Members
Static Public Attributes inherited from mitk::NavigationDataSource
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_ID

static const std::string	US_PROPKEY_ISACTIVE

Protected Attributes inherited from mitk::NavigationDataSource
std::string	m_Name

bool	m_IsFrozen

NavigationToolStorage::Pointer	m_ToolMetaDataCollection

Detailed Description

IGTLinkMessageToNavigationDataFilter is a filter that receives OpenIGTLink messages as input and produce NavigationDatas as output.

Documentation IGTLinkMessageToNavigationDataFilter is a filter that receives OpenIGTLink messages as input and produce NavigationDatas as output. If the OpenIGTLink message is not of the proper type the filter will not do anything.

Definition at line 35 of file mitkIGTLMessageToNavigationDataFilter.h.

Constructor & Destructor Documentation

◆ IGTLMessageToNavigationDataFilter()

mitk::IGTLMessageToNavigationDataFilter::IGTLMessageToNavigationDataFilter ( )

protected

◆ ~IGTLMessageToNavigationDataFilter()

mitk::IGTLMessageToNavigationDataFilter::~IGTLMessageToNavigationDataFilter ( )

overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::IGTLMessageToNavigationDataFilter::Clone ( ) const

◆ ConnectTo()

virtual void mitk::IGTLMessageToNavigationDataFilter::ConnectTo ( mitk::IGTLMessageSource * UpstreamFilter )

virtual

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

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

◆ CreateOutputsForAllInputs()

void mitk::IGTLMessageToNavigationDataFilter::CreateOutputsForAllInputs ( )

protected

Create an output for each input.

This Method sets the number of outputs to the number of inputs and creates missing outputs objects.

Warning: any additional outputs that exist before the method is called are deleted

◆ GenerateData()

void mitk::IGTLMessageToNavigationDataFilter::GenerateData ( )

overrideprotected

◆ GenerateOutputInformation()

void mitk::IGTLMessageToNavigationDataFilter::GenerateOutputInformation ( )

overrideprotected

Defines how the input will be copied into the output.

◆ GenerateQuaternionTrackingDataData()

void mitk::IGTLMessageToNavigationDataFilter::GenerateQuaternionTrackingDataData ( )

protected

◆ GenerateTrackingDataData()

void mitk::IGTLMessageToNavigationDataFilter::GenerateTrackingDataData ( )

protected

◆ GenerateTransformData()

void mitk::IGTLMessageToNavigationDataFilter::GenerateTransformData ( )

protected

◆ GetInput() [1/3]

const IGTLMessage* mitk::IGTLMessageToNavigationDataFilter::GetInput ( std::string messageName ) const

Get the input with name messageName of this filter.

◆ GetInput() [2/3]

const IGTLMessage* mitk::IGTLMessageToNavigationDataFilter::GetInput ( unsigned int idx ) const

Get the input with id idx of this filter.

◆ GetInput() [3/3]

const IGTLMessage* mitk::IGTLMessageToNavigationDataFilter::GetInput ( void ) const

Get the input of this filter.

Set an input

◆ GetInputIndex()

DataObjectPointerArraySizeType mitk::IGTLMessageToNavigationDataFilter::GetInputIndex ( std::string messageName )

return the index of the input with name messageName, throw std::invalid_argument exception if that name was not found

◆ mitkClassMacro()

mitk::IGTLMessageToNavigationDataFilter::mitkClassMacro	(	IGTLMessageToNavigationDataFilter	,
		NavigationDataSource
	)

◆ New()

static Pointer mitk::IGTLMessageToNavigationDataFilter::New ( )

static

◆ SetInput() [1/2]

virtual void mitk::IGTLMessageToNavigationDataFilter::SetInput ( const IGTLMessage * msg )

virtual

Set the input of this filter.

Warning: : this will set the number of outputs to the number of inputs, deleting any extra outputs that might have been initialized. Subclasses that have a different number of outputs than inputs must overwrite the SetInput methods.

◆ SetInput() [2/2]

virtual void mitk::IGTLMessageToNavigationDataFilter::SetInput	(	unsigned int	idx,
		const IGTLMessage *	msg
	)

virtual

Set input with id idx of this filter.

Warning: : this will set the number of outputs to the number of inputs, deleting any extra outputs that might have been initialized. Subclasses that have a different number of outputs than inputs must overwrite the SetInput methods. If the last input is set to nullptr, the number of inputs will be decreased by one (-> removing the last input). If other inputs are set to nullptr, the number of inputs will not change.

◆ SetNumberOfExpectedOutputs()

void mitk::IGTLMessageToNavigationDataFilter::SetNumberOfExpectedOutputs ( unsigned int numOutputs )

Sets the number of expected outputs.

Normally, this is done automatically by the filter concept. However, in our case we can not know, for example, how many tracking elements are stored in the incoming igtl message. Therefore, we have to set the number here to the expected value.

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

mitkIGTLMessageToNavigationDataFilter.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IGTLMessageToNavigationDataFilter()

◆ ~IGTLMessageToNavigationDataFilter()

Member Function Documentation

◆ Clone()

◆ ConnectTo()

◆ CreateOutputsForAllInputs()

◆ GenerateData()

◆ GenerateOutputInformation()

◆ GenerateQuaternionTrackingDataData()

◆ GenerateTrackingDataData()

◆ GenerateTransformData()

◆ GetInput() [1/3]

◆ GetInput() [2/3]

◆ GetInput() [3/3]

◆ GetInputIndex()

◆ mitkClassMacro()

◆ New()

◆ SetInput() [1/2]

◆ SetInput() [2/2]

◆ SetNumberOfExpectedOutputs()