Medical Imaging Interaction Toolkit  2018.4.99-b7f3afaa
Medical Imaging Interaction Toolkit
mitk::NavigationDataSet Class Reference

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

#include <mitkNavigationDataSet.h>

Inheritance diagram for mitk::NavigationDataSet:
Collaboration 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. 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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- 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)
 Get last mitk::Navigation object for given tool whose timestamp is less than the given timestamp. 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...
 
BasePropertyGetNonConstProperty (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::TimeGeometryGetTimeGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
const mitk::TimeGeometryGetTimeSlicedGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::TimeGeometryGetUpdatedTimeSliceGeometry ()
 Return the TimeGeometry of the data. More...
 
virtual void Expand (unsigned int timeSteps)
 Expands the TimeGeometry to a number of TimeSteps. More...
 
const mitk::BaseGeometryGetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time t. More...
 
mitk::BaseGeometryGetGeometry (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::BaseDataSourceGetSource () 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...
 
unsigned long 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 ()
 
Identifiableoperator= (const Identifiable &)=delete
 
Identifiableoperator= (Identifiable &&other) noexcept
 
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 InitializeTimeSlicedGeometry (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 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
numToolsHow 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
navigationDatasvector 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.

References m_NavigationDataVectors, m_NumberOfTools, and MITK_WARN.

◆ Begin()

mitk::NavigationDataSet::NavigationDataSetConstIterator mitk::NavigationDataSet::Begin ( void  ) 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.

References m_NavigationDataVectors.

◆ ConvertNavigationDataToPointSet()

◆ End()

mitk::NavigationDataSet::NavigationDataSetConstIterator mitk::NavigationDataSet::End ( void  ) 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.

References m_NavigationDataVectors.

◆ GetDataStreamForTool()

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

Get last mitk::Navigation object for given tool whose timestamp is less than the given timestamp.

Parameters
toolIndexIndex of the tool from which mitk::NavigationData should be returned.
timestampTimestamp for selecting last object before.
Returns
Last mitk::NavigationData with timestamp less than given timestamp, 0 if there is no adequate object. 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
toolIndexIndex 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.

References m_NavigationDataVectors, m_NumberOfTools, and MITK_WARN.

◆ 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
toolIndexIndex of the tool from which mitk::NavigationData should be returned.
indexIndex 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.

References m_NavigationDataVectors, and MITK_WARN.

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

References m_NumberOfTools.

Referenced by ConvertNavigationDataToPointSet().

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

References m_NavigationDataVectors.

◆ IsEmpty()

bool mitk::NavigationDataSet::IsEmpty ( ) const
overridevirtual

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

Reimplemented from mitk::BaseData.

Definition at line 148 of file mitkNavigationDataSet.cpp.

References Size().

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

Definition at line 134 of file mitkNavigationDataSet.cpp.

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

Definition at line 144 of file mitkNavigationDataSet.cpp.

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

Definition at line 130 of file mitkNavigationDataSet.cpp.

◆ Size()

unsigned int mitk::NavigationDataSet::Size ( void  ) 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.

References m_NavigationDataVectors.

Referenced by IsEmpty().

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

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 161 of file mitkNavigationDataSet.h.

Referenced by AddNavigationDatas(), Begin(), ConvertNavigationDataToPointSet(), End(), GetDataStreamForTool(), GetNavigationDataForIndex(), GetTimeStep(), and Size().

◆ m_NumberOfTools

unsigned int mitk::NavigationDataSet::m_NumberOfTools
protected

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

Definition at line 166 of file mitkNavigationDataSet.h.

Referenced by AddNavigationDatas(), GetDataStreamForTool(), and GetNumberOfTools().


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