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

#include <mitkNavigationDataToIGTLMessageFilter.h>

Inheritance diagram for mitk::NavigationDataToIGTLMessageFilter:

Collaboration diagram for mitk::NavigationDataToIGTLMessageFilter:

Public Types
enum	OperationMode { ModeSendQTransMsg, ModeSendTransMsg, ModeSendQTDataMsg, ModeSendTDataMsg }
	There are four different operation modes. More...

Public Member Functions
	mitkClassMacro (NavigationDataToIGTLMessageFilter, IGTLMessageSource)

Pointer	Clone () const

virtual void	GenerateData () override
	filter execute method More...

virtual void	SetInput (const mitk::NavigationData *NavigationData)
	Sets one input NavigationData. More...

virtual void	SetInput (unsigned int idx, const NavigationData *nd)
	Sets the input NavigationData at a specific index. More...

const mitk::NavigationData *	GetInput ()
	Returns the input of this filter. More...

const mitk::NavigationData *	GetInput (unsigned int idx)
	Returns the input number idx of this filter. More...

virtual void	SetOperationMode (OperationMode mode)
	Sets the mode of this filter. More...

virtual OperationMode	GetOperationMode () const
	returns the mode of this filter. More...

void	GenerateOutputInformation () override

virtual void	ConnectTo (mitk::NavigationDataSource *UpstreamFilter)
	Connects the input of this filter to the outputs of the given NavigationDataSource. 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)

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

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

IGTLMessage *	GetOutput (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...

virtual itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override

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

virtual	~NavigationDataToIGTLMessageFilter ()

virtual void	GenerateDataModeSendQTDataMsg ()
	Generates the output. More...

virtual void	GenerateDataModeSendTDataMsg ()
	Generates the output for ModeSendTDataMsg. More...

virtual void	GenerateDataModeSendQTransMsg ()
	Generates the output for ModeSendQTransMsg. More...

virtual void	GenerateDataModeSendTransMsg ()
	Generates the output for ModeSendTransMsg. More...

virtual void	CreateOutputsForAllInputs ()
	create output objects according to OperationMode for all inputs More...

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

virtual	~IGTLMessageSource ()

Protected Attributes
OperationMode	m_OperationMode
	Stores the mode. See enum OperationMode. More...

unsigned int	m_CurrentTimeStep
	Indicates the current timestamp. More...

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::NavigaitionData objects.

Documentation

Definition at line 35 of file mitkNavigationDataToIGTLMessageFilter.h.

Member Enumeration Documentation

enum mitk::NavigationDataToIGTLMessageFilter::OperationMode

There are four different operation modes.

Documentation

ModeSendQTransMsg: every input NavigationData is processed into one output message that contains a position and a orientation (quaternion).
ModeSendTransMsg: every input NavigationData is processed into one output message that contains a 4x4 transformation.
ModeSendQTDataMsg:all input NavigationData is processed into one single output message that contains a position and orientation (quaternion) for each navigation data.
ModeSendTDataMsg:all input NavigationData is processed into one single output message that contains a 4x4 transformation for each navigation data.

Enumerator
ModeSendQTransMsg
ModeSendTransMsg
ModeSendQTDataMsg
ModeSendTDataMsg

Definition at line 56 of file mitkNavigationDataToIGTLMessageFilter.h.

Constructor & Destructor Documentation

mitk::NavigationDataToIGTLMessageFilter::NavigationDataToIGTLMessageFilter ( )

protected

Definition at line 27 of file mitkNavigationDataToIGTLMessageFilter.cpp.

References m_CurrentTimeStep, and mitk::IGTLMessage::New().

mitk::NavigationDataToIGTLMessageFilter::~NavigationDataToIGTLMessageFilter ( )

protectedvirtual

Definition at line 41 of file mitkNavigationDataToIGTLMessageFilter.cpp.

Member Function Documentation

Pointer mitk::NavigationDataToIGTLMessageFilter::Clone ( ) const

void mitk::NavigationDataToIGTLMessageFilter::ConnectTo ( mitk::NavigationDataSource * UpstreamFilter )

virtual

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

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

Definition at line 352 of file mitkNavigationDataToIGTLMessageFilter.cpp.

References mitk::NavigationDataSource::GetOutput().

void mitk::NavigationDataToIGTLMessageFilter::CreateOutputsForAllInputs ( )

protectedvirtual

create output objects according to OperationMode for all inputs

Definition at line 101 of file mitkNavigationDataToIGTLMessageFilter.cpp.

void mitk::NavigationDataToIGTLMessageFilter::GenerateData ( )

overridevirtual

filter execute method

Definition at line 45 of file mitkNavigationDataToIGTLMessageFilter.cpp.

void mitk::NavigationDataToIGTLMessageFilter::GenerateDataModeSendQTDataMsg ( )

protectedvirtual

Generates the output.

Generates the output for ModeSendQTDataMsg

Definition at line 233 of file mitkNavigationDataToIGTLMessageFilter.cpp.

References mitk::NavigationData::GetName(), mitk::NavigationData::GetOrientation(), mitk::NavigationData::GetPosition(), MITK_INFO, mitk::New(), and mitk::IGTLMessage::SetMessage().

void mitk::NavigationDataToIGTLMessageFilter::GenerateDataModeSendQTransMsg ( )

protectedvirtual

Generates the output for ModeSendQTransMsg.

Definition at line 165 of file mitkNavigationDataToIGTLMessageFilter.cpp.

References mitk::NavigationData::GetName(), mitk::NavigationData::GetOrientation(), mitk::NavigationData::GetPosition(), mitk::NavigationData::IsDataValid(), mitk::New(), and mitk::IGTLMessage::SetMessage().

void mitk::NavigationDataToIGTLMessageFilter::GenerateDataModeSendTDataMsg ( )

protectedvirtual

Generates the output for ModeSendTDataMsg.

Definition at line 276 of file mitkNavigationDataToIGTLMessageFilter.cpp.

References ConvertAffineTransformationIntoIGTLMatrix(), mitk::Equal(), mitk::NavigationData::GetAffineTransform3D(), mitk::NavigationData::GetName(), mitk::New(), mitk::IGTLMessage::SetDataValid(), and mitk::IGTLMessage::SetMessage().

void mitk::NavigationDataToIGTLMessageFilter::GenerateDataModeSendTransMsg ( )

protectedvirtual

Generates the output for ModeSendTransMsg.

Definition at line 197 of file mitkNavigationDataToIGTLMessageFilter.cpp.

References ConvertAffineTransformationIntoIGTLMatrix(), mitk::NavigationData::GetAffineTransform3D(), mitk::NavigationData::GetName(), mitk::NavigationData::IsDataValid(), mitk::New(), and mitk::IGTLMessage::SetMessage().

void mitk::NavigationDataToIGTLMessageFilter::GenerateOutputInformation ( void )

inlineoverride

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

Definition at line 113 of file mitkNavigationDataToIGTLMessageFilter.h.

const mitk::NavigationData * mitk::NavigationDataToIGTLMessageFilter::GetInput ( void )

Returns the input of this filter.

Definition at line 87 of file mitkNavigationDataToIGTLMessageFilter.cpp.

const mitk::NavigationData * mitk::NavigationDataToIGTLMessageFilter::GetInput ( unsigned int idx )

Returns the input number idx of this filter.

Definition at line 94 of file mitkNavigationDataToIGTLMessageFilter.cpp.

virtual OperationMode mitk::NavigationDataToIGTLMessageFilter::GetOperationMode ( ) const

virtual

returns the mode of this filter.

See OperationMode for the behavior in the different modes

mitk::NavigationDataToIGTLMessageFilter::mitkClassMacro	(	NavigationDataToIGTLMessageFilter	,
		IGTLMessageSource
	)

static Pointer mitk::NavigationDataToIGTLMessageFilter::New ( )

static

void mitk::NavigationDataToIGTLMessageFilter::SetInput ( const mitk::NavigationData * NavigationData )

virtual

Sets one input NavigationData.

Definition at line 73 of file mitkNavigationDataToIGTLMessageFilter.cpp.

void mitk::NavigationDataToIGTLMessageFilter::SetInput	(	unsigned int	idx,
		const NavigationData *	nd
	)

virtual

Sets the input NavigationData at a specific index.

Definition at line 80 of file mitkNavigationDataToIGTLMessageFilter.cpp.

void mitk::NavigationDataToIGTLMessageFilter::SetOperationMode ( OperationMode mode )

virtual

Sets the mode of this filter.

See OperationMode for the behavior in the different modes A call to this method will change the number of outputs of the filter. After calling this method, all previously acquired pointers to outputs are invalid Always set the operation mode first, then get the outputs with GetOutput()

Definition at line 345 of file mitkNavigationDataToIGTLMessageFilter.cpp.