NavigationData filter calcuting occluded positions on a target surface. The occlusion caused by obstacle structures is calculated between the current NavigationData position and a given target surface. More...

#include <mitkUSNavigationTargetOcclusionFilter.h>

Inheritance diagram for mitk::USNavigationTargetOcclusionFilter:

Public Member Functions
	mitkClassMacro (USNavigationTargetOcclusionFilter, NavigationDataPassThroughFilter)

	itkNewMacro (Self)

void	SetTargetStructure (itk::SmartPointer< DataNode > targetStructure)
	Sets the target structure for which the occluded positions should be calculated.

void	SetObstacleStructures (DataStorage::SetOfObjects::ConstPointer obstacleStructures)
	Sets the obstacle structures which can occlude the target structure.

void	SelectStartPositionInput (unsigned int n)
	Sets the index of the input which is used for occlusion calculation. The occlusion will be calculated between the NavigationData position of this input and the target structure.

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

	itkNewMacro (Self)

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

	~USNavigationTargetOcclusionFilter () override

void	GenerateData () override

vtkSmartPointer< vtkPolyData >	GetVtkPolyDataOfTarget ()
	Returns the vtk poly data of the target structure.

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

	~NavigationDataPassThroughFilter () override

void	GenerateData () override
	Passes navigation data from all inputs to all outputs. If a subclass wants to implement its own version of the GenerateData() method it should call this method inside its implementation.

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
DataStorage::SetOfObjects::ConstPointer	m_ObstacleStructures

itk::SmartPointer< DataNode >	m_TargetStructure

unsigned int	m_StartPositionInput

std::vector< bool >	m_OccludedPositions

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

NavigationData filter calcuting occluded positions on a target surface. The occlusion caused by obstacle structures is calculated between the current NavigationData position and a given target surface.

Definition at line 35 of file mitkUSNavigationTargetOcclusionFilter.h.

Constructor & Destructor Documentation

◆ USNavigationTargetOcclusionFilter()

mitk::USNavigationTargetOcclusionFilter::USNavigationTargetOcclusionFilter ( )

protected

Definition at line 28 of file mitkUSNavigationTargetOcclusionFilter.cpp.

◆ ~USNavigationTargetOcclusionFilter()

mitk::USNavigationTargetOcclusionFilter::~USNavigationTargetOcclusionFilter ( )

overrideprotected

Definition at line 33 of file mitkUSNavigationTargetOcclusionFilter.cpp.

Member Function Documentation

◆ GenerateData()

void mitk::USNavigationTargetOcclusionFilter::GenerateData ( )

overrideprotected

Definition at line 52 of file mitkUSNavigationTargetOcclusionFilter.cpp.

◆ GetVtkPolyDataOfTarget()

vtkSmartPointer< vtkPolyData > mitk::USNavigationTargetOcclusionFilter::GetVtkPolyDataOfTarget ( )

protected

Returns the vtk poly data of the target structure.

Returns: vtkPolyData if the target structure data node contains one, returns null otherwise

Definition at line 166 of file mitkUSNavigationTargetOcclusionFilter.cpp.

◆ itkNewMacro()

mitk::USNavigationTargetOcclusionFilter::itkNewMacro ( Self )

◆ mitkClassMacro()

mitk::USNavigationTargetOcclusionFilter::mitkClassMacro	(	USNavigationTargetOcclusionFilter	,
		NavigationDataPassThroughFilter	)

◆ SelectStartPositionInput()

void mitk::USNavigationTargetOcclusionFilter::SelectStartPositionInput ( unsigned int n )

Sets the index of the input which is used for occlusion calculation. The occlusion will be calculated between the NavigationData position of this input and the target structure.

Definition at line 47 of file mitkUSNavigationTargetOcclusionFilter.cpp.

◆ SetObstacleStructures()

void mitk::USNavigationTargetOcclusionFilter::SetObstacleStructures ( DataStorage::SetOfObjects::ConstPointer obstacleStructures )

Sets the obstacle structures which can occlude the target structure.

Parameters

obstacleStructures Set of DataNodes containing a mitk::Surface each

Definition at line 42 of file mitkUSNavigationTargetOcclusionFilter.cpp.

◆ SetTargetStructure()

void mitk::USNavigationTargetOcclusionFilter::SetTargetStructure ( itk::SmartPointer< DataNode > targetStructure )

Sets the target structure for which the occluded positions should be calculated.

Parameters

targetStructure DataNode containing a mitk::Surface

Definition at line 37 of file mitkUSNavigationTargetOcclusionFilter.cpp.

Member Data Documentation

◆ m_ObstacleStructures

DataStorage::SetOfObjects::ConstPointer mitk::USNavigationTargetOcclusionFilter::m_ObstacleStructures

protected

Definition at line 72 of file mitkUSNavigationTargetOcclusionFilter.h.

◆ m_OccludedPositions

std::vector<bool> mitk::USNavigationTargetOcclusionFilter::m_OccludedPositions

protected

Definition at line 77 of file mitkUSNavigationTargetOcclusionFilter.h.

◆ m_StartPositionInput

unsigned int mitk::USNavigationTargetOcclusionFilter::m_StartPositionInput

protected

Definition at line 75 of file mitkUSNavigationTargetOcclusionFilter.h.

◆ m_TargetStructure

itk::SmartPointer<DataNode> mitk::USNavigationTargetOcclusionFilter::m_TargetStructure

protected

Definition at line 73 of file mitkUSNavigationTargetOcclusionFilter.h.

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

Plugins/org.mitk.gui.qt.igt.app.ultrasoundtrackingnavigation/src/internal/Filter/mitkUSNavigationTargetOcclusionFilter.h
Plugins/org.mitk.gui.qt.igt.app.ultrasoundtrackingnavigation/src/internal/Filter/mitkUSNavigationTargetOcclusionFilter.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ USNavigationTargetOcclusionFilter()

◆ ~USNavigationTargetOcclusionFilter()

Member Function Documentation

◆ GenerateData()

◆ GetVtkPolyDataOfTarget()

◆ itkNewMacro()

◆ mitkClassMacro()

◆ SelectStartPositionInput()

◆ SetObstacleStructures()

◆ SetTargetStructure()

Member Data Documentation

◆ m_ObstacleStructures

◆ m_OccludedPositions

◆ m_StartPositionInput

◆ m_TargetStructure