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

#include <mitkNavigationDataSet.h>

Inheritance diagram for mitk::NavigationDataSet:

[legend]

Collaboration diagram for mitk::NavigationDataSet:

[legend]

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

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

Public Types inherited from mitk::BaseData
typedef BaseData	Self

typedef itk::DataObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::Identifiable
using	UIDType = std::string

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

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

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

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

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

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

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

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

void	SetRequestedRegionToLargestPossibleRegion () override
	Set the RequestedRegion to the LargestPossibleRegion. More...

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
	Determine whether the RequestedRegion is outside of the BufferedRegion. More...

bool	VerifyRequestedRegion () override
	Verify that the RequestedRegion is within the LargestPossibleRegion. More...

void	SetRequestedRegion (const itk::DataObject *data) override
	Set the requested region from this data object to match the requested region of the data object passed in as a parameter. More...

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

void	ConvertNavigationDataToPointSet () const

Public Member Functions inherited from mitk::BaseData
virtual std::vector< std::string >	GetClassHierarchy () const

virtual const char *	GetClassName () const

BaseProperty::ConstPointer	GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
	Get property by its key. More...

std::vector< std::string >	GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
	Query keys of existing properties. More...

std::vector< std::string >	GetPropertyContextNames () const override
	Query names of existing contexts. More...

BaseProperty *	GetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
	Get property by its key. More...

void	SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
	Add new or change existent property. More...

void	RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
	Removes a property. If the property does not exist, nothing will be done. More...

const mitk::TimeGeometry *	GetTimeGeometry () const
	Return the TimeGeometry of the data as const pointer. More...

mitk::TimeGeometry *	GetTimeGeometry ()
	Return the TimeGeometry of the data as pointer. More...

const mitk::TimeGeometry *	GetUpdatedTimeGeometry ()
	Return the TimeGeometry of the data. More...

virtual void	Expand (unsigned int timeSteps)
	Expands the TimeGeometry to a number of TimeSteps. More...

const mitk::BaseGeometry *	GetUpdatedGeometry (int t=0)
	Return the BaseGeometry of the data at time t. More...

mitk::BaseGeometry *	GetGeometry (int t=0) const
	Return the geometry, which is a TimeGeometry, of the data as non-const pointer. More...

void	UpdateOutputInformation () override
	Update the information for this BaseData (the geometry in particular) so that it can be used as an output of a BaseProcess. More...

void	CopyInformation (const itk::DataObject *data) override
	Copy information from the specified data set. More...

virtual bool	IsInitialized () const
	Check whether the data has been initialized, i.e., at least the Geometry and other header data has been set. More...

virtual void	Clear ()
	Calls ClearData() and InitializeEmpty();. More...

virtual bool	IsEmptyTimeStep (unsigned int t) const
	Check whether object contains data (at a specified time), e.g., a set of points may be empty. More...

void	ExecuteOperation (Operation *operation) override
	overwrite if the Data can be called by an Interactor (StateMachine). More...

virtual void	SetGeometry (BaseGeometry *aGeometry3D)
	Set the BaseGeometry of the data, which will be referenced (not copied!). Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry which saves the given BaseGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...

virtual void	SetTimeGeometry (TimeGeometry *geometry)
	Set the TimeGeometry of the data, which will be referenced (not copied!). More...

virtual void	SetClonedGeometry (const BaseGeometry *aGeometry3D)
	Set a clone of the provided Geometry as Geometry of the data. Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...

virtual void	SetClonedTimeGeometry (const TimeGeometry *geometry)
	Set a clone of the provided TimeGeometry as TimeGeometry of the data. More...

virtual void	SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
	Set a clone of the provided geometry as BaseGeometry of a given time step. More...

mitk::PropertyList::Pointer	GetPropertyList () const
	Get the data's property list. More...

void	SetPropertyList (PropertyList *propertyList)
	Set the data's property list. More...

mitk::BaseProperty::Pointer	GetProperty (const char *propertyKey) const
	Get the property (instance of BaseProperty) with key propertyKey from the PropertyList, and set it to this, respectively;. More...

void	SetProperty (const char propertyKey, BaseProperty property)

virtual void	SetOrigin (const Point3D &origin)
	Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...

itk::SmartPointer< mitk::BaseDataSource >	GetSource () const
	Get the process object that generated this data object. More...

unsigned int	GetTimeSteps () const
	Get the number of time steps from the TimeGeometry As the base data has not a data vector given by itself, the number of time steps is defined over the time sliced geometry. In sub classes, a better implementation could be over the length of the data vector. More...

itk::ModifiedTimeType	GetMTime () const override
	Get the modified time of the last change of the contents this data object or its geometry. More...

void	Graft (const DataObject *) override

Public Member Functions inherited from mitk::OperationActor
	itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()

Public Member Functions inherited from mitk::Identifiable
	Identifiable ()

	Identifiable (const UIDType &uid)

	Identifiable (const Identifiable &)=delete

	Identifiable (Identifiable &&) noexcept

virtual	~Identifiable ()

Identifiable &	operator= (const Identifiable &)=delete

Identifiable &	operator= (Identifiable &&other) noexcept

virtual UIDType	GetUID () const
	Get unique ID of an object. More...

Public Member Functions inherited from mitk::IPropertyOwner
	~IPropertyOwner () override

Public Member Functions inherited from mitk::IPropertyProvider
virtual	~IPropertyProvider ()

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

	~NavigationDataSet () override

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

	BaseData (const BaseData &other)

	~BaseData () override

virtual void	InitializeTimeGeometry (unsigned int timeSteps=1)
	Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...

virtual void	ClearData ()
	reset to non-initialized state, release memory More...

virtual void	InitializeEmpty ()
	Pure virtual; Must be used in subclasses to get a data object to a valid state. Should at least create one empty object and call Superclass::InitializeTimeGeometry() to ensure an existing valid geometry. More...

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Protected Member Functions inherited from mitk::Identifiable
virtual void	SetUID (const UIDType &uid)

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

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

Protected Attributes inherited from mitk::BaseData
bool	m_LastRequestedRegionWasOutsideOfTheBufferedRegion

unsigned int	m_SourceOutputIndexDuplicate

bool	m_Initialized

Additional Inherited Members
Static Public Member Functions inherited from mitk::BaseData
static const char *	GetStaticNameOfClass ()

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

typedef 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

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

◆ ~NavigationDataSet()

mitk::NavigationDataSet::~NavigationDataSet ( )

overrideprotected

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

◆ Begin()

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

virtual

Returns an iterator pointing to the first TimeStep.

Returns: Returns an iterator pointing to the first TimeStep.

◆ ConvertNavigationDataToPointSet()

void mitk::NavigationDataSet::ConvertNavigationDataToPointSet ( ) const

◆ End()

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

◆ GetDataStreamForTool()

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

◆ GetNavigationDataForIndex()

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.

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

◆ GetTimeStep()

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

◆ IsEmpty()

bool mitk::NavigationDataSet::IsEmpty ( ) const

overridevirtual

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

Reimplemented from mitk::BaseData.

◆ mitkClassMacro()

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

◆ mitkNewMacro1Param()

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

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::NavigationDataSet::RequestedRegionIsOutsideOfTheBufferedRegion ( )

overridevirtual

Determine whether the RequestedRegion is outside of the BufferedRegion.

This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Implements mitk::BaseData.

◆ SetRequestedRegion()

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

overridevirtual

Set the requested region from this data object to match the requested region of the data object passed in as a parameter.

This method is implemented in the concrete subclasses of BaseData.

Implements mitk::BaseData.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::NavigationDataSet::SetRequestedRegionToLargestPossibleRegion ( )

overridevirtual

Set the RequestedRegion to the LargestPossibleRegion.

This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Implements mitk::BaseData.

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

◆ VerifyRequestedRegion()

bool mitk::NavigationDataSet::VerifyRequestedRegion ( )

overridevirtual

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion.

Implements mitk::BaseData.

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

mitkNavigationDataSet.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

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