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

#include <mitkNavigationDataDisplacementFilter.h>

Inheritance diagram for mitk::NavigationDataDisplacementFilter:

Collaboration diagram for mitk::NavigationDataDisplacementFilter:

Public Member Functions
	mitkClassMacro (NavigationDataDisplacementFilter, NavigationDataToNavigationDataFilter)

Pointer	Clone () const

	mitkSetVectorMacro (Offset, mitk::Vector3D)
	Get Offset parameter. More...

	mitkGetVectorMacro (Offset, mitk::Vector3D)
	Set Offset parameter. More...

virtual void	SetParameters (const mitk::PropertyList *p) override
	Set all filter parameters (Offset) as the PropertyList p. More...

mitk::PropertyList::ConstPointer	GetParameters () const override
	Get all filter parameters (offset) as a PropertyList. More...

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

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

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

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

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

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

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 More...

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

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

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

virtual itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override

virtual void	Freeze ()

virtual void	UnFreeze ()

virtual bool	GetIsFrozen ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	NavigationDataDisplacementFilter ()

virtual	~NavigationDataDisplacementFilter ()

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

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

virtual	~NavigationDataToNavigationDataFilter ()

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

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

virtual	~NavigationDataSource ()

Protected Attributes
mitk::Vector3D	m_Offset
	offset that is added to all inputs More...

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

bool	m_IsFrozen

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

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 33 of file mitkNavigationDataDisplacementFilter.h.

Constructor & Destructor Documentation

mitk::NavigationDataDisplacementFilter::NavigationDataDisplacementFilter ( )

protected

Definition at line 21 of file mitkNavigationDataDisplacementFilter.cpp.

References m_Offset.

mitk::NavigationDataDisplacementFilter::~NavigationDataDisplacementFilter ( )

protectedvirtual

Definition at line 30 of file mitkNavigationDataDisplacementFilter.cpp.

Member Function Documentation

Pointer mitk::NavigationDataDisplacementFilter::Clone ( ) const

void mitk::NavigationDataDisplacementFilter::GenerateData ( )

overrideprotectedvirtual

filter execute method

Documentation adds the offset m_Offset to all inputs

Definition at line 35 of file mitkNavigationDataDisplacementFilter.cpp.

References mitk::NavigationData::GetPosition(), mitk::NavigationData::Graft(), mitk::NavigationData::IsDataValid(), mitk::NavigationData::SetDataValid(), and mitk::NavigationData::SetPosition().

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 68 of file mitkNavigationDataDisplacementFilter.cpp.

References mitk::Vector3DProperty::New(), and mitk::PropertyList::New().