NavigationDataTransformFilter applies an user-defined rigid transformation on navigation data objects. Input navigation data are mapped 1:1 on output navigation data. To run the filter SetRigid3DTransform(TransformType::Pointer transform) has to be called first. More...

#include <mitkNavigationDataTransformFilter.h>

Inheritance diagram for mitk::NavigationDataTransformFilter:

Public Types
typedef itk::VersorRigid3DTransform< double >	TransformType

Public Member Functions
	mitkClassMacro (NavigationDataTransformFilter, NavigationDataToNavigationDataFilter)

	itkFactorylessNewMacro (Self)

	itkCloneMacro (Self)

	itkSetObjectMacro (Rigid3DTransform, TransformType)
	Set the rigid transform used to transform the input navigation data.

	itkGetConstObjectMacro (Rigid3DTransform, TransformType)

	itkSetMacro (Precompose, bool)
	Set transform composition order.

	itkGetMacro (Precompose, bool)

	itkBooleanMacro (Precompose)

Public Member Functions inherited from mitk::NavigationDataToNavigationDataFilter
	mitkClassMacro (NavigationDataToNavigationDataFilter, NavigationDataSource)

virtual void	SetInput (const NavigationData *nd)
	Set the input of this filter.

virtual void	SetInput (unsigned int idx, const NavigationData *nd)
	Set input with id idx of this filter.

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

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

const NavigationData *	GetInput (std::string navDataName) const
	Get the input with name navDataName of this filter.

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

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

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

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

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

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

NavigationTool::Pointer	GetToolMetaData (DataObjectPointerArraySizeType idx)

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

	itkGetMacro (ToolMetaDataCollection, mitk::NavigationToolStorage::Pointer)

	itkSetMacro (ToolMetaDataCollection, mitk::NavigationToolStorage::Pointer)

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

virtual void	Freeze ()

virtual void	UnFreeze ()

	itkGetMacro (IsFrozen, bool)

Protected Member Functions
	NavigationDataTransformFilter ()

	~NavigationDataTransformFilter () override

void	GenerateData () override
	filter execute method

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

	~NavigationDataToNavigationDataFilter () override

void	CreateOutputsForAllInputs ()
	Create an output for each input.

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

	~NavigationDataSource () override

Protected Attributes
TransformType::Pointer	m_Rigid3DTransform
	transform which will be applied on navigation data(s)

bool	m_Precompose

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

bool	m_IsFrozen

NavigationToolStorage::Pointer	m_ToolMetaDataCollection

Additional Inherited Members
Static Public Attributes inherited from mitk::NavigationDataSource
static const std::string	US_INTERFACE_NAME = "org.mitk.services.NavigationDataSource"
	These Constants are used in conjunction with Microservices.

static const std::string	US_PROPKEY_DEVICENAME = US_INTERFACE_NAME + ".devicename"

static const std::string	US_PROPKEY_ID = US_INTERFACE_NAME + ".id"

static const std::string	US_PROPKEY_ISACTIVE = US_INTERFACE_NAME + ".isActive"

Detailed Description

NavigationDataTransformFilter applies an user-defined rigid transformation on navigation data objects. Input navigation data are mapped 1:1 on output navigation data. To run the filter SetRigid3DTransform(TransformType::Pointer transform) has to be called first.

Documentation

Definition at line 30 of file mitkNavigationDataTransformFilter.h.

Member Typedef Documentation

◆ TransformType

itk::VersorRigid3DTransform< double > mitk::NavigationDataTransformFilter::TransformType

Definition at line 39 of file mitkNavigationDataTransformFilter.h.

Constructor & Destructor Documentation

◆ NavigationDataTransformFilter()

mitk::NavigationDataTransformFilter::NavigationDataTransformFilter ( )

protected

Definition at line 16 of file mitkNavigationDataTransformFilter.cpp.

◆ ~NavigationDataTransformFilter()

mitk::NavigationDataTransformFilter::~NavigationDataTransformFilter ( )

overrideprotected

Definition at line 24 of file mitkNavigationDataTransformFilter.cpp.

Member Function Documentation

◆ GenerateData()

void mitk::NavigationDataTransformFilter::GenerateData ( )

overrideprotected

filter execute method

Documentation

transforms navigation data

Definition at line 29 of file mitkNavigationDataTransformFilter.cpp.

◆ itkBooleanMacro()

mitk::NavigationDataTransformFilter::itkBooleanMacro ( Precompose )

◆ itkCloneMacro()

mitk::NavigationDataTransformFilter::itkCloneMacro ( Self )

◆ itkFactorylessNewMacro()

mitk::NavigationDataTransformFilter::itkFactorylessNewMacro ( Self )

◆ itkGetConstObjectMacro()

mitk::NavigationDataTransformFilter::itkGetConstObjectMacro	(	Rigid3DTransform	,
		TransformType	)

◆ itkGetMacro()

mitk::NavigationDataTransformFilter::itkGetMacro	(	Precompose	,
		bool	)

◆ itkSetMacro()

mitk::NavigationDataTransformFilter::itkSetMacro	(	Precompose	,
		bool	)

Set transform composition order.

Documentation

If precompose is true, then transform is precomposed with the input NavigationData transform; that is, the resulting transformation consists of first applying transform, then applying the input NavigationData transformation.

If precompose is false or omitted, then transform is post-composed with the input NavigationData transform; that is the resulting transformation consists of first applying the NavigationData transformation, followed by transform.

◆ itkSetObjectMacro()

mitk::NavigationDataTransformFilter::itkSetObjectMacro	(	Rigid3DTransform	,
		TransformType	)

Set the rigid transform used to transform the input navigation data.

Documentation

◆ mitkClassMacro()

mitk::NavigationDataTransformFilter::mitkClassMacro	(	NavigationDataTransformFilter	,
		NavigationDataToNavigationDataFilter	)

Member Data Documentation

◆ m_Precompose

bool mitk::NavigationDataTransformFilter::m_Precompose

protected

Definition at line 81 of file mitkNavigationDataTransformFilter.h.

◆ m_Rigid3DTransform

TransformType::Pointer mitk::NavigationDataTransformFilter::m_Rigid3DTransform

protected

transform which will be applied on navigation data(s)

Definition at line 80 of file mitkNavigationDataTransformFilter.h.

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

Modules/IGT/Algorithms/mitkNavigationDataTransformFilter.h
Modules/IGT/Algorithms/mitkNavigationDataTransformFilter.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TransformType

Constructor & Destructor Documentation

◆ NavigationDataTransformFilter()

◆ ~NavigationDataTransformFilter()

Member Function Documentation

◆ GenerateData()

◆ itkBooleanMacro()

◆ itkCloneMacro()

◆ itkFactorylessNewMacro()

◆ itkGetConstObjectMacro()

◆ itkGetMacro()

◆ itkSetMacro()

◆ itkSetObjectMacro()

◆ mitkClassMacro()

Member Data Documentation

◆ m_Precompose

◆ m_Rigid3DTransform