Class that reads NavigationData from input and transfers the information to the geometry of the associated BaseData. More...

#include <mitkNavigationDataObjectVisualizationFilter.h>

Inheritance diagram for mitk::NavigationDataObjectVisualizationFilter:

[legend]

Collaboration diagram for mitk::NavigationDataObjectVisualizationFilter:

[legend]

Public Types
enum	RotationMode { RotationStandard, RotationTransposed }

typedef BaseData::ConstPointer	RepresentationPointer
	Smart Pointer type to a BaseData. More...

typedef std::map< unsigned int, RepresentationPointer >	RepresentationPointerMap
	STL map of index to BaseData . Using map to be able to set non continuous indices. More...

typedef RepresentationPointerMap::size_type	RepresentationPointerMapSizeType
	Size type of an std::vector. More...

Public Member Functions
	mitkClassMacro (NavigationDataObjectVisualizationFilter, NavigationDataToNavigationDataFilter)

Pointer	Clone () const

void	SetRepresentationObject (unsigned int index, BaseData *data)
	Set the representation object of the input. More...

const BaseData *	GetRepresentationObject (unsigned int idx)
	Get the representation object associated with the index idx. More...

virtual void	SetTransformPosition (unsigned int index, bool applyTransform)
	if set to true, the filter will use the position part of the input navigation data at the given index to transform the representation object. If set to false, it will not. If no value is set, it defaults to true. More...

virtual bool	GetTransformPosition (unsigned int index) const
	returns whether position part of the input navigation data at the given index is used for the transformation of the representation object. More...

virtual void	TransformPositionOn (unsigned int index)
	sets the TransformPosition flag to true for the given index More...

virtual void	TransformPositionOff (unsigned int index)
	sets the TransformPosition flag to false for the given index More...

virtual void	SetTransformOrientation (unsigned int index, bool applyTransform)
	if set to true, the filter will use the orientation part of the input navigation data at the given index to transform the representation object. If set to false, it will not. If no value is set, it defaults to true. More...

virtual bool	GetTransformOrientation (unsigned int index) const
	returns whether orientation part of the input navigation data at the given index is used for the transformation of the representation object. More...

virtual void	TransformOrientationOn (unsigned int index)
	sets the TransformOrientation flag to true for the given index More...

virtual void	TransformOrientationOff (unsigned int index)
	sets the TransformOrientation flag to false for the given index More...

void	SetOffset (int index, mitk::AffineTransform3D::Pointer offset)
	Defines an offset for a representation object. This offset is applied before the object is visualized. If no offset is given, no offset will be used. To deactivate the offset just set it to NULL. The offset is deactivated by default. More...

virtual void	SetRotationMode (RotationMode r)

mitk::AffineTransform3D::Pointer	GetOffset (int index)

RepresentationPointerMapSizeType	GetNumberOfToolRepresentations () const
	Get the number of added BaseData associated to NavigationData. More...

virtual void	GenerateData () override

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	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 Types
typedef std::map< itk::ProcessObject::DataObjectPointerArraySizeType, bool >	BooleanInputMap

typedef std::map< unsigned int, mitk::AffineTransform3D::Pointer >	OffsetPointerMap

Protected Member Functions
	NavigationDataObjectVisualizationFilter ()
	Constructor. More...

	~NavigationDataObjectVisualizationFilter ()
	Destructor. 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
RepresentationPointerMap	m_RepresentationList
	An array of the BaseData which represent the tools. More...

BooleanInputMap	m_TransformPosition
	if set to true, the filter will use the position part of the input navigation data at the given index for the calculation of the transform. If no entry for the index exists, it defaults to true. More...

BooleanInputMap	m_TransformOrientation
	if set to true, the filter will use the orientation part of the input navigation data at the given index for the calculation of the transform. If no entry for the index exists, it defaults to true. More...

OffsetPointerMap	m_OffsetList

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

Class that reads NavigationData from input and transfers the information to the geometry of the associated BaseData.

Derived from NavigationDataToNavigationDataFilter

Definition at line 34 of file mitkNavigationDataObjectVisualizationFilter.h.

Member Typedef Documentation

typedef std::map<itk::ProcessObject::DataObjectPointerArraySizeType, bool> mitk::NavigationDataObjectVisualizationFilter::BooleanInputMap

protected

Definition at line 131 of file mitkNavigationDataObjectVisualizationFilter.h.

typedef std::map<unsigned int, mitk::AffineTransform3D::Pointer> mitk::NavigationDataObjectVisualizationFilter::OffsetPointerMap

protected

Definition at line 132 of file mitkNavigationDataObjectVisualizationFilter.h.

typedef BaseData::ConstPointer mitk::NavigationDataObjectVisualizationFilter::RepresentationPointer

Smart Pointer type to a BaseData.

Definition at line 60 of file mitkNavigationDataObjectVisualizationFilter.h.

typedef std::map<unsigned int, RepresentationPointer> mitk::NavigationDataObjectVisualizationFilter::RepresentationPointerMap

STL map of index to BaseData . Using map to be able to set non continuous indices.

Definition at line 65 of file mitkNavigationDataObjectVisualizationFilter.h.

typedef RepresentationPointerMap::size_type mitk::NavigationDataObjectVisualizationFilter::RepresentationPointerMapSizeType

Size type of an std::vector.

Definition at line 70 of file mitkNavigationDataObjectVisualizationFilter.h.

Member Enumeration Documentation

enum mitk::NavigationDataObjectVisualizationFilter::RotationMode

Defines the rotation modes of this tracking device which results in different representations of quaternions.

Standard: normal representation, rawdata from the device is not changed (DEFAULT)
Transposed: the rotation is stored transposed, which is (by mistake!) expected by some older MITK classes due to an ambigious method naming in VNL.

CAUTION: The rotation mode can only be changed for backward compatibility of old WRONG code. PLEASE DO NOT CHANGE THE ROTATION MODE UNLESS YOU ARE KNOWING EXACTLY WHAT YOU ARE DOING!

use SetRotationMode to change the mode.

Enumerator
RotationStandard
RotationTransposed

Definition at line 55 of file mitkNavigationDataObjectVisualizationFilter.h.

Constructor & Destructor Documentation

mitk::NavigationDataObjectVisualizationFilter::NavigationDataObjectVisualizationFilter ( )

protected

Constructor.

Definition at line 21 of file mitkNavigationDataObjectVisualizationFilter.cpp.

mitk::NavigationDataObjectVisualizationFilter::~NavigationDataObjectVisualizationFilter ( )

protected

Destructor.

Definition at line 29 of file mitkNavigationDataObjectVisualizationFilter.cpp.

Member Function Documentation

Pointer mitk::NavigationDataObjectVisualizationFilter::Clone ( ) const

void mitk::NavigationDataObjectVisualizationFilter::GenerateData ( )

overridevirtual

set the offset by convert from itkPoint to itkVector and setting offset of transform/

Definition at line 71 of file mitkNavigationDataObjectVisualizationFilter.cpp.

References mitk::BaseData::GetGeometry(), mitk::BaseGeometry::GetIndexToWorldTransform(), mitk::NavigationData::GetOrientation(), mitk::NavigationData::GetPosition(), mitk::BaseGeometry::GetSpacing(), mitk::NavigationData::Graft(), mitk::NavigationData::IsDataValid(), MITK_WARN, mitk::BaseGeometry::Modified(), mitk::New(), offset, mitk::NavigationData::SetDataValid(), mitk::BaseGeometry::SetIndexToWorldTransform(), mitk::BaseGeometry::SetSpacing(), and mitk::TransferMatrix().

RepresentationPointerMapSizeType mitk::NavigationDataObjectVisualizationFilter::GetNumberOfToolRepresentations ( ) const

inline

Get the number of added BaseData associated to NavigationData.

Returns: Returns the size of the internal map

Definition at line 119 of file mitkNavigationDataObjectVisualizationFilter.h.

mitk::AffineTransform3D::Pointer mitk::NavigationDataObjectVisualizationFilter::GetOffset ( int index )

Returns: Returns the offset of a represenation object. Returns NULL if there is no offset.

Definition at line 45 of file mitkNavigationDataObjectVisualizationFilter.cpp.

const mitk::BaseData * mitk::NavigationDataObjectVisualizationFilter::GetRepresentationObject ( unsigned int idx )

Get the representation object associated with the index idx.

Parameters

idx	the corresponding input number with which the BaseData is associated

Returns: Returns the desired BaseData if it exists for the given input; Returns NULL if no BaseData was found.

Definition at line 36 of file mitkNavigationDataObjectVisualizationFilter.cpp.

bool mitk::NavigationDataObjectVisualizationFilter::GetTransformOrientation ( unsigned int index ) const

virtual

returns whether orientation part of the input navigation data at the given index is used for the transformation of the representation object.

Definition at line 227 of file mitkNavigationDataObjectVisualizationFilter.cpp.

bool mitk::NavigationDataObjectVisualizationFilter::GetTransformPosition ( unsigned int index ) const

virtual

returns whether position part of the input navigation data at the given index is used for the transformation of the representation object.

Definition at line 192 of file mitkNavigationDataObjectVisualizationFilter.cpp.

mitk::NavigationDataObjectVisualizationFilter::mitkClassMacro	(	NavigationDataObjectVisualizationFilter	,
		NavigationDataToNavigationDataFilter
	)

static Pointer mitk::NavigationDataObjectVisualizationFilter::New ( )

static

Referenced by mitk::TrackingDeviceSourceConfigurator::CreateNavigationDataObjectVisualizationFilter(), and main().

void mitk::NavigationDataObjectVisualizationFilter::SetOffset	(	int	index,
		mitk::AffineTransform3D::Pointer	offset
	)

Defines an offset for a representation object. This offset is applied before the object is visualized. If no offset is given, no offset will be used. To deactivate the offset just set it to NULL. The offset is deactivated by default.

Parameters

offset The new offset which will be set. Set to NULL to deactivate the offset.

Definition at line 59 of file mitkNavigationDataObjectVisualizationFilter.cpp.

References offset.

void mitk::NavigationDataObjectVisualizationFilter::SetRepresentationObject	(	unsigned int	index,
		BaseData *	data
	)

Set the representation object of the input.

Parameters

data	The BaseData to be associated to the index
index	the index with which data will be associated

Definition at line 54 of file mitkNavigationDataObjectVisualizationFilter.cpp.

void mitk::NavigationDataObjectVisualizationFilter::SetRotationMode ( RotationMode r )

virtual

Sets the rotation mode of this class. See documentation of enum RotationMode for details on the different modes. CAUTION: The rotation mode can only be changed for backward compatibility of old WRONG code. PLEASE DO NOT CHANGE THE ROTATION MODE UNLESS YOU ARE KNOWING EXACTLY WHAT YOU ARE DOING!

Definition at line 65 of file mitkNavigationDataObjectVisualizationFilter.cpp.

void mitk::NavigationDataObjectVisualizationFilter::SetTransformOrientation	(	unsigned int	index,
		bool	applyTransform
	)

virtual

if set to true, the filter will use the orientation part of the input navigation data at the given index to transform the representation object. If set to false, it will not. If no value is set, it defaults to true.

Definition at line 215 of file mitkNavigationDataObjectVisualizationFilter.cpp.

void mitk::NavigationDataObjectVisualizationFilter::SetTransformPosition	(	unsigned int	index,
		bool	applyTransform
	)

virtual

if set to true, the filter will use the position part of the input navigation data at the given index to transform the representation object. If set to false, it will not. If no value is set, it defaults to true.

Definition at line 180 of file mitkNavigationDataObjectVisualizationFilter.cpp.

void mitk::NavigationDataObjectVisualizationFilter::TransformOrientationOff ( unsigned int index )

virtual

sets the TransformOrientation flag to false for the given index

Definition at line 244 of file mitkNavigationDataObjectVisualizationFilter.cpp.

void mitk::NavigationDataObjectVisualizationFilter::TransformOrientationOn ( unsigned int index )

virtual

sets the TransformOrientation flag to true for the given index

Definition at line 238 of file mitkNavigationDataObjectVisualizationFilter.cpp.

void mitk::NavigationDataObjectVisualizationFilter::TransformPositionOff ( unsigned int index )

virtual

sets the TransformPosition flag to false for the given index

Definition at line 209 of file mitkNavigationDataObjectVisualizationFilter.cpp.

void mitk::NavigationDataObjectVisualizationFilter::TransformPositionOn ( unsigned int index )

virtual

sets the TransformPosition flag to true for the given index

Definition at line 203 of file mitkNavigationDataObjectVisualizationFilter.cpp.

Member Data Documentation

OffsetPointerMap mitk::NavigationDataObjectVisualizationFilter::m_OffsetList

protected

Definition at line 150 of file mitkNavigationDataObjectVisualizationFilter.h.

RepresentationPointerMap mitk::NavigationDataObjectVisualizationFilter::m_RepresentationList

protected

An array of the BaseData which represent the tools.

Definition at line 147 of file mitkNavigationDataObjectVisualizationFilter.h.

BooleanInputMap mitk::NavigationDataObjectVisualizationFilter::m_TransformOrientation

protected

if set to true, the filter will use the orientation part of the input navigation data at the given index for the calculation of the transform. If no entry for the index exists, it defaults to true.

Definition at line 149 of file mitkNavigationDataObjectVisualizationFilter.h.

BooleanInputMap mitk::NavigationDataObjectVisualizationFilter::m_TransformPosition

protected

if set to true, the filter will use the position part of the input navigation data at the given index for the calculation of the transform. If no entry for the index exists, it defaults to true.

Definition at line 148 of file mitkNavigationDataObjectVisualizationFilter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation