mitk::NavigationDataDisplacementFilter Class Reference

NavigationDataDisplacementFilter adds an offset to navigation data objects. More...

#include <mitkNavigationDataDisplacementFilter.h>

Inheritance diagram for mitk::NavigationDataDisplacementFilter:

Public Member Functions
	mitkClassMacro (NavigationDataDisplacementFilter, NavigationDataToNavigationDataFilter)
	itkFactorylessNewMacro (Self)
	itkCloneMacro (Self)
	mitkSetVectorMacro (Offset, mitk::Vector3D)
	Get Offset parameter.
	mitkGetVectorMacro (Offset, mitk::Vector3D)
	Set Offset parameter.
	itkSetMacro (Transform6DOF, bool)
	itkGetMacro (Transform6DOF, bool)
void	SetTransformation (mitk::AffineTransform3D::Pointer transform)
void	SetParameters (const mitk::PropertyList *p) override
	Set all filter parameters (Offset) as the PropertyList p.
mitk::PropertyList::ConstPointer	GetParameters () const override
	Get all filter parameters (offset) as a PropertyList.
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	Freeze ()
virtual void	UnFreeze ()
	itkGetMacro (IsFrozen, bool)

Protected Member Functions
	NavigationDataDisplacementFilter ()
	~NavigationDataDisplacementFilter () 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
mitk::Vector3D	m_Offset
	offset that is added to all inputs
bool	m_Transform6DOF
mitk::NavigationData::Pointer	m_Transformation
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

NavigationDataDisplacementFilter adds an offset to navigation data objects.

Documentation

Example class that shows how to write a navigation filter. This filter adds a offset that can be specified as a parameter to each input navigation data.

Definition at line 29 of file mitkNavigationDataDisplacementFilter.h.

Constructor & Destructor Documentation

NavigationDataDisplacementFilter()

mitk::NavigationDataDisplacementFilter::NavigationDataDisplacementFilter ( )

protected

Definition at line 17 of file mitkNavigationDataDisplacementFilter.cpp.

~NavigationDataDisplacementFilter()

mitk::NavigationDataDisplacementFilter::~NavigationDataDisplacementFilter ( )

overrideprotected

Definition at line 29 of file mitkNavigationDataDisplacementFilter.cpp.

Member Function Documentation

GenerateData()

void mitk::NavigationDataDisplacementFilter::GenerateData ( )

overrideprotected

filter execute method

Documentation

adds the offset m_Offset to all inputs

Definition at line 34 of file mitkNavigationDataDisplacementFilter.cpp.

GetParameters()

mitk::PropertyList::ConstPointer mitk::NavigationDataDisplacementFilter::GetParameters ( ) const

overridevirtual

Get all filter parameters (offset) as a PropertyList.

This method returns a PropertyList containing the following properties (name : data type):

• "NavigationDataDisplacementFilter_Offset" : mitk::Vector3DProperty The returned PropertyList must be assigned to a SmartPointer immediately, or else it will get destroyed.

Reimplemented from mitk::NavigationDataSource.

Definition at line 129 of file mitkNavigationDataDisplacementFilter.cpp.

itkCloneMacro()

mitk::NavigationDataDisplacementFilter::itkCloneMacro

(

Self

)

itkFactorylessNewMacro()

mitk::NavigationDataDisplacementFilter::itkFactorylessNewMacro

(

Self

)

itkGetMacro()

mitk::NavigationDataDisplacementFilter::itkGetMacro	(	Transform6DOF	,
		bool	)

itkSetMacro()

mitk::NavigationDataDisplacementFilter::itkSetMacro	(	Transform6DOF	,
		bool	)

mitkClassMacro()

mitk::NavigationDataDisplacementFilter::mitkClassMacro	(	NavigationDataDisplacementFilter	,
		NavigationDataToNavigationDataFilter	)

mitkGetVectorMacro()

mitk::NavigationDataDisplacementFilter::mitkGetVectorMacro	(	Offset	,
		mitk::Vector3D	)

Set Offset parameter.

mitkSetVectorMacro()

mitk::NavigationDataDisplacementFilter::mitkSetVectorMacro	(	Offset	,
		mitk::Vector3D	)

Get Offset parameter.

SetParameters()

void mitk::NavigationDataDisplacementFilter::SetParameters ( const mitk::PropertyList * p )

overridevirtual

Set all filter parameters (Offset) as the PropertyList p.

This method reads the following properties from the PropertyList (name : data type):

• "NavigationDataDisplacementFilter_Offset" : mitk::Vector3DProperty

Reimplemented from mitk::NavigationDataSource.

Definition at line 119 of file mitkNavigationDataDisplacementFilter.cpp.

SetTransformation()

void mitk::NavigationDataDisplacementFilter::SetTransformation

(

mitk::AffineTransform3D::Pointer

transform

)

Definition at line 113 of file mitkNavigationDataDisplacementFilter.cpp.

Member Data Documentation

m_Offset

mitk::Vector3D mitk::NavigationDataDisplacementFilter::m_Offset

protected

offset that is added to all inputs

Definition at line 72 of file mitkNavigationDataDisplacementFilter.h.

m_Transform6DOF

bool mitk::NavigationDataDisplacementFilter::m_Transform6DOF

protected

Definition at line 74 of file mitkNavigationDataDisplacementFilter.h.

m_Transformation

mitk::NavigationData::Pointer mitk::NavigationDataDisplacementFilter::m_Transformation

protected

Definition at line 76 of file mitkNavigationDataDisplacementFilter.h.

---

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

• Modules/IGT/Algorithms/mitkNavigationDataDisplacementFilter.h
• Modules/IGT/Algorithms/mitkNavigationDataDisplacementFilter.cpp