Control the position and orientation of rendered slices with NavigationData. More...

#include <mitkNavigationDataSliceVisualization.h>

Inheritance diagram for mitk::NavigationDataSliceVisualization:

Public Types
enum	ViewDirection { Axial = 0 , Sagittal , Coronal , AxialOblique , SagittalOblique , Oblique }

Public Member Functions
	mitkClassMacro (NavigationDataSliceVisualization, NavigationDataToNavigationDataFilter)

	itkNewMacro (Self)

	itkSetObjectMacro (Renderer, BaseRenderer)
	Set/get the renderer that visualizes the navigation data.

	itkGetConstObjectMacro (Renderer, BaseRenderer)

	itkSetMacro (TipOffset, Vector3D)
	Set/get the tip offset used for plane tracking.

	itkGetConstMacro (TipOffset, Vector3D)

virtual void	SetToolTrajectory (Vector3D direction)
	Set/get the tool trajectory used to define the cutting plane normal direction.

	itkGetConstMacro (ToolTrajectory, Vector3D)

	itkSetMacro (WorldVerticalVector, Vector3D)
	Set/get the world vertical vector used to define the y-axis of the cutting plane.

	itkGetConstMacro (WorldVerticalVector, Vector3D)

	itkSetEnumMacro (ViewDirection, ViewDirection)
	Set/get the orientation of the sliced plane.

	itkGetEnumMacro (ViewDirection, ViewDirection)

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
	NavigationDataSliceVisualization ()

void	GenerateData () override

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
BaseRenderer::Pointer	m_Renderer

Vector3D	m_TipOffset

Vector3D	m_ToolTrajectory

Vector3D	m_WorldVerticalVector

ViewDirection	m_ViewDirection

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

Control the position and orientation of rendered slices with NavigationData.

Documentation

A NavigationDataToNavigationDataFilter that takes NavigationData as input and sets the position and, optionally, the orientation of the slice plane for a user-specified renderer.

Definition at line 30 of file mitkNavigationDataSliceVisualization.h.

Member Enumeration Documentation

◆ ViewDirection

enum mitk::NavigationDataSliceVisualization::ViewDirection

Enumerator
Axial	Tracked slice planes are NOT re-oriented, only the position of the slice plane is controlled by the input navigation data.
Sagittal
Coronal
AxialOblique	Axial plane "tilted" about the lateral vector so that it is coplanar with the tool trajectory
SagittalOblique	Sagittal plane "tilted" about the axial vector so that it is coplanar with the tool trajectory
Oblique	Slice plane normal to the tool trajectory

Definition at line 36 of file mitkNavigationDataSliceVisualization.h.

Constructor & Destructor Documentation

◆ NavigationDataSliceVisualization()

mitk::NavigationDataSliceVisualization::NavigationDataSliceVisualization ( )

protected

Definition at line 16 of file mitkNavigationDataSliceVisualization.cpp.

Member Function Documentation

◆ GenerateData()

void mitk::NavigationDataSliceVisualization::GenerateData ( )

overrideprotected

Todo: <C++11> Use std::signbit

Todo: <C++11> Use std::copysign

Definition at line 49 of file mitkNavigationDataSliceVisualization.cpp.

◆ itkGetConstMacro() [1/3]

mitk::NavigationDataSliceVisualization::itkGetConstMacro	(	TipOffset	,
		Vector3D	)

◆ itkGetConstMacro() [2/3]

mitk::NavigationDataSliceVisualization::itkGetConstMacro	(	ToolTrajectory	,
		Vector3D	)

◆ itkGetConstMacro() [3/3]

mitk::NavigationDataSliceVisualization::itkGetConstMacro	(	WorldVerticalVector	,
		Vector3D	)

◆ itkGetConstObjectMacro()

mitk::NavigationDataSliceVisualization::itkGetConstObjectMacro	(	Renderer	,
		BaseRenderer	)

◆ itkGetEnumMacro()

mitk::NavigationDataSliceVisualization::itkGetEnumMacro	(	ViewDirection	,
		ViewDirection	)

◆ itkNewMacro()

mitk::NavigationDataSliceVisualization::itkNewMacro ( Self )

◆ itkSetEnumMacro()

mitk::NavigationDataSliceVisualization::itkSetEnumMacro	(	ViewDirection	,
		ViewDirection	)

Set/get the orientation of the sliced plane.

Default is Axial.

◆ itkSetMacro() [1/2]

mitk::NavigationDataSliceVisualization::itkSetMacro	(	TipOffset	,
		Vector3D	)

Set/get the tip offset used for plane tracking.

This is an additional offset vector applied to the input navigation data. It is defined in tool tip coordinates. In other words:

position_slice = position_input + orient_input.rotate(TipOffset)

Default is [0,0,0].

◆ itkSetMacro() [2/2]

mitk::NavigationDataSliceVisualization::itkSetMacro	(	WorldVerticalVector	,
		Vector3D	)

Set/get the world vertical vector used to define the y-axis of the cutting plane.

This vector, defined in world coordinates, applies only when the ViewDirection is Oblique. It is projected onto the cutting plane to define the vertical orientation of the slice.

The direction of this vector does not matter (i.e. [0,1,0] is the same as [0,-1,0]). The direction will be determined automatically by choosing the one that is closest to the direction of the y-axis of the PlaneGeometry before each update. This way, the anatomical axis directions that get set initially will be maintained after every update of this filter.

Default is [0,1,0].

◆ itkSetObjectMacro()

mitk::NavigationDataSliceVisualization::itkSetObjectMacro	(	Renderer	,
		BaseRenderer	)

Set/get the renderer that visualizes the navigation data.

◆ mitkClassMacro()

mitk::NavigationDataSliceVisualization::mitkClassMacro	(	NavigationDataSliceVisualization	,
		NavigationDataToNavigationDataFilter	)

◆ SetToolTrajectory()

void mitk::NavigationDataSliceVisualization::SetToolTrajectory ( Vector3D direction )

virtual

Set/get the tool trajectory used to define the cutting plane normal direction.

This vector, defined in tool tip coordinates, applies only when the ViewDirection is Oblique.

Default is [0,0,-1].

Definition at line 33 of file mitkNavigationDataSliceVisualization.cpp.

Member Data Documentation

◆ m_Renderer

BaseRenderer::Pointer mitk::NavigationDataSliceVisualization::m_Renderer

protected

Definition at line 126 of file mitkNavigationDataSliceVisualization.h.

◆ m_TipOffset

Vector3D mitk::NavigationDataSliceVisualization::m_TipOffset

protected

Definition at line 127 of file mitkNavigationDataSliceVisualization.h.

◆ m_ToolTrajectory

Vector3D mitk::NavigationDataSliceVisualization::m_ToolTrajectory

protected

Definition at line 128 of file mitkNavigationDataSliceVisualization.h.

◆ m_ViewDirection

ViewDirection mitk::NavigationDataSliceVisualization::m_ViewDirection

protected

Definition at line 130 of file mitkNavigationDataSliceVisualization.h.

◆ m_WorldVerticalVector

Vector3D mitk::NavigationDataSliceVisualization::m_WorldVerticalVector

protected

Definition at line 129 of file mitkNavigationDataSliceVisualization.h.

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

Modules/IGT/Rendering/mitkNavigationDataSliceVisualization.h
Modules/IGT/Rendering/mitkNavigationDataSliceVisualization.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ViewDirection

Constructor & Destructor Documentation

◆ NavigationDataSliceVisualization()

Member Function Documentation

◆ GenerateData()

◆ itkGetConstMacro() [1/3]

◆ itkGetConstMacro() [2/3]

◆ itkGetConstMacro() [3/3]

◆ itkGetConstObjectMacro()

◆ itkGetEnumMacro()

◆ itkNewMacro()

◆ itkSetEnumMacro()

◆ itkSetMacro() [1/2]

◆ itkSetMacro() [2/2]

◆ itkSetObjectMacro()

◆ mitkClassMacro()

◆ SetToolTrajectory()

Member Data Documentation

◆ m_Renderer

◆ m_TipOffset

◆ m_ToolTrajectory

◆ m_ViewDirection

◆ m_WorldVerticalVector