Data structure which stores streams of mitk::NavigationData for multiple tools. More...

#include <mitkNavigationDataSet.h>

Inheritance diagram for mitk::NavigationDataSet:

Public Types
typedef std::vector< std::vector< mitk::NavigationData::Pointer > >::iterator	NavigationDataSetIterator
	This iterator iterates over the distinct time steps in this set.

typedef std::vector< std::vector< mitk::NavigationData::Pointer > >::const_iterator	NavigationDataSetConstIterator
	This iterator iterates over the distinct time steps in this set. And is const.

Public Member Functions
	mitkClassMacro (NavigationDataSet, BaseData)

	mitkNewMacro1Param (Self, unsigned int)

bool	AddNavigationDatas (std::vector< mitk::NavigationData::Pointer > navigationDatas)
	Add mitk::NavigationData of the given tool to the Set.

NavigationData::Pointer	GetNavigationDataForIndex (unsigned int index, unsigned int toolIndex) const
	Get mitk::NavigationData from the given tool at given index.

virtual std::vector< mitk::NavigationData::Pointer >	GetDataStreamForTool (unsigned int toolIndex)
	Returns a vector that contains all tracking data for a given tool.

virtual std::vector< mitk::NavigationData::Pointer >	GetTimeStep (unsigned int index) const
	Returns a vector that contains NavigationDatas for each tool for a given timestep.

unsigned int	GetNumberOfTools () const
	Returns the number of tools for which NavigationDatas are stored in this set.

unsigned int	Size () const
	Returns the number of time steps stored in this NavigationDataSet.

virtual NavigationDataSetConstIterator	Begin () const
	Returns an iterator pointing to the first TimeStep.

virtual NavigationDataSetConstIterator	End () const
	Returns an iterator pointing behind to the last TimeStep.

void	SetRequestedRegionToLargestPossibleRegion () override

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

bool	VerifyRequestedRegion () override

void	SetRequestedRegion (const itk::DataObject *data) override

bool	IsEmpty () const override
	This overrid is probably a little hacky. See Bug 19086.

void	ConvertNavigationDataToPointSet () const

Protected Member Functions
	NavigationDataSet (unsigned int numTools)
	Constructs set with fixed number of tools.

	~NavigationDataSet () override

Protected Attributes
std::vector< std::vector< NavigationData::Pointer > >	m_NavigationDataVectors
	Holds all the mitk::NavigationData objects managed by this class.

unsigned int	m_NumberOfTools
	The Number of Tools that this class is going to support.

Detailed Description

Data structure which stores streams of mitk::NavigationData for multiple tools.

Use mitk::NavigationDataRecorder to create these sets easily from pipelines. Use mitk::NavigationDataPlayer to stream from these sets easily.

Definition at line 29 of file mitkNavigationDataSet.h.

Member Typedef Documentation

◆ NavigationDataSetConstIterator

std::vector<std::vector<mitk::NavigationData::Pointer>>::const_iterator mitk::NavigationDataSet::NavigationDataSetConstIterator

This iterator iterates over the distinct time steps in this set. And is const.

It returns an array of the length equal to GetNumberOfTools(), containing a mitk::NavigationData for each tool..

Definition at line 47 of file mitkNavigationDataSet.h.

◆ NavigationDataSetIterator

std::vector<std::vector<mitk::NavigationData::Pointer>>::iterator mitk::NavigationDataSet::NavigationDataSetIterator

This iterator iterates over the distinct time steps in this set.

It returns an array of the length equal to GetNumberOfTools(), containing a mitk::NavigationData for each tool..

Definition at line 39 of file mitkNavigationDataSet.h.

Constructor & Destructor Documentation

◆ NavigationDataSet()

mitk::NavigationDataSet::NavigationDataSet ( unsigned int numTools )

protected

Constructs set with fixed number of tools.

Parameters

numTools How many tools are used with this mitk::NavigationDataSet.

Definition at line 17 of file mitkNavigationDataSet.cpp.

◆ ~NavigationDataSet()

mitk::NavigationDataSet::~NavigationDataSet ( )

overrideprotected

Definition at line 22 of file mitkNavigationDataSet.cpp.

Member Function Documentation

◆ AddNavigationDatas()

bool mitk::NavigationDataSet::AddNavigationDatas ( std::vector< mitk::NavigationData::Pointer > navigationDatas )

Add mitk::NavigationData of the given tool to the Set.

Parameters

navigationDatas vector of mitk::NavigationData objects to be added. Make sure that the size of the vector equals the number of tools given in the constructor

Returns: true if object was be added to the set successfully, false otherwise

Definition at line 26 of file mitkNavigationDataSet.cpp.

◆ Begin()

mitk::NavigationDataSet::NavigationDataSetConstIterator mitk::NavigationDataSet::Begin ( ) const

virtual

Returns an iterator pointing to the first TimeStep.

Returns: Returns an iterator pointing to the first TimeStep.

Definition at line 178 of file mitkNavigationDataSet.cpp.

◆ ConvertNavigationDataToPointSet()

void mitk::NavigationDataSet::ConvertNavigationDataToPointSet ( ) const

Definition at line 153 of file mitkNavigationDataSet.cpp.

◆ End()

mitk::NavigationDataSet::NavigationDataSetConstIterator mitk::NavigationDataSet::End ( ) const

virtual

Returns an iterator pointing behind to the last TimeStep.

Returns: Returns an iterator pointing behind to the last TimeStep.

Definition at line 183 of file mitkNavigationDataSet.cpp.

◆ GetDataStreamForTool()

std::vector< mitk::NavigationData::Pointer > mitk::NavigationDataSet::GetDataStreamForTool ( unsigned int toolIndex )

virtual

Returns a vector that contains all tracking data for a given tool.

This is a relatively expensive operation, as it requires the construction of a new vector.

Parameters

toolIndex Index of the tool for which the stream should be returned.

Returns: Returns a vector that contains all tracking data for a given tool.

Definition at line 98 of file mitkNavigationDataSet.cpp.

◆ GetNavigationDataForIndex()

mitk::NavigationData::Pointer mitk::NavigationDataSet::GetNavigationDataForIndex	(	unsigned int	index,
		unsigned int	toolIndex ) const

Get mitk::NavigationData from the given tool at given index.

Parameters

toolIndex	Index of the tool from which mitk::NavigationData should be returned.
index	Index of the mitk::NavigationData object that should be returned.

Returns: mitk::NavigationData at the specified indices, 0 if there is no object at the indices.

Definition at line 50 of file mitkNavigationDataSet.cpp.

◆ GetNumberOfTools()

unsigned int mitk::NavigationDataSet::GetNumberOfTools ( ) const

Returns the number of tools for which NavigationDatas are stored in this set.

This is always equal to the number given in the constructor of this class.

Returns: the number of tools for which NavigationDatas are stored in this set.

Definition at line 119 of file mitkNavigationDataSet.cpp.

◆ GetTimeStep()

std::vector< mitk::NavigationData::Pointer > mitk::NavigationDataSet::GetTimeStep ( unsigned int index ) const

virtual

Returns a vector that contains NavigationDatas for each tool for a given timestep.

If GetNumberOFTools() equals four, then 4 NavigationDatas will be returned.

Parameters

index Index of the timeStep for which the datas should be returned. cannot be larger than mitk::NavigationDataSet::Size()

Returns: Returns a vector that contains all tracking data for a given tool.

Definition at line 114 of file mitkNavigationDataSet.cpp.

◆ IsEmpty()

bool mitk::NavigationDataSet::IsEmpty ( ) const

override

This overrid is probably a little hacky. See Bug 19086.

Definition at line 148 of file mitkNavigationDataSet.cpp.

◆ mitkClassMacro()

mitk::NavigationDataSet::mitkClassMacro	(	NavigationDataSet	,
		BaseData	)

◆ mitkNewMacro1Param()

mitk::NavigationDataSet::mitkNewMacro1Param	(	Self	,
		unsigned int	)

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::NavigationDataSet::RequestedRegionIsOutsideOfTheBufferedRegion ( )

override

Definition at line 134 of file mitkNavigationDataSet.cpp.

◆ SetRequestedRegion()

void mitk::NavigationDataSet::SetRequestedRegion ( const itk::DataObject * data )

override

Definition at line 144 of file mitkNavigationDataSet.cpp.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::NavigationDataSet::SetRequestedRegionToLargestPossibleRegion ( )

override

Definition at line 130 of file mitkNavigationDataSet.cpp.

◆ Size()

unsigned int mitk::NavigationDataSet::Size ( ) const

Returns the number of time steps stored in this NavigationDataSet.

This is not the total number of Navigation Datas stored in this set, but the number stored for each tool. i.e. the total number of NavigationDatas equals Size() * GetNumberOfTools();

Returns: Returns the number of time steps stored in this NavigationDataSet.

Definition at line 124 of file mitkNavigationDataSet.cpp.

◆ VerifyRequestedRegion()

bool mitk::NavigationDataSet::VerifyRequestedRegion ( )

override

Definition at line 139 of file mitkNavigationDataSet.cpp.

Member Data Documentation

◆ m_NavigationDataVectors

std::vector<std::vector<NavigationData::Pointer> > mitk::NavigationDataSet::m_NavigationDataVectors

protected

Holds all the mitk::NavigationData objects managed by this class.

The first dimension is the index of the navigation data, the second is the tool to which this data belongs. i.e. the first dimension is usually the longer one.

Definition at line 152 of file mitkNavigationDataSet.h.

◆ m_NumberOfTools

unsigned int mitk::NavigationDataSet::m_NumberOfTools

protected

The Number of Tools that this class is going to support.

Definition at line 157 of file mitkNavigationDataSet.h.

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

Modules/IGTBase/include/mitkNavigationDataSet.h
Modules/IGTBase/src/mitkNavigationDataSet.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ NavigationDataSetConstIterator

◆ NavigationDataSetIterator

Constructor & Destructor Documentation

◆ NavigationDataSet()

◆ ~NavigationDataSet()

Member Function Documentation

◆ AddNavigationDatas()

◆ Begin()

◆ ConvertNavigationDataToPointSet()

◆ End()

◆ GetDataStreamForTool()

◆ GetNavigationDataForIndex()

◆ GetNumberOfTools()

◆ GetTimeStep()

◆ IsEmpty()

◆ mitkClassMacro()

◆ mitkNewMacro1Param()

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

◆ SetRequestedRegion()

◆ SetRequestedRegionToLargestPossibleRegion()

◆ Size()

◆ VerifyRequestedRegion()

Member Data Documentation

◆ m_NavigationDataVectors

◆ m_NumberOfTools