Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::NavigationDataDelayFilter Class Reference

NavigationDataDelayFilter. More...

#include <mitkNavigationDataDelayFilter.h>

Inheritance diagram for mitk::NavigationDataDelayFilter:
Collaboration diagram for mitk::NavigationDataDelayFilter:

Public Member Functions

 mitkClassMacro (NavigationDataDelayFilter, NavigationDataToNavigationDataFilter)
 
 mitkNewMacro1Param (NavigationDataDelayFilter, unsigned int)
 
virtual void SetDelay (unsigned int _arg)
 
- Public Member Functions inherited from mitk::NavigationDataToNavigationDataFilter
 mitkClassMacro (NavigationDataToNavigationDataFilter, NavigationDataSource)
 
virtual void SetInput (const NavigationData *nd)
 Set the input of this filter. More...
 
virtual void SetInput (unsigned int idx, const NavigationData *nd)
 Set input with id idx of this filter. More...
 
const NavigationDataGetInput (void) const
 Get the input of this filter. More...
 
const NavigationDataGetInput (unsigned int idx) const
 Get the input with id idx of this filter. More...
 
const NavigationDataGetInput (std::string navDataName) const
 Get the input with name navDataName of this filter. More...
 
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 More...
 
virtual void ConnectTo (mitk::NavigationDataSource *UpstreamFilter)
 Connects the input of this filter to the outputs of the given NavigationDataSource. More...
 
- Public Member Functions inherited from mitk::NavigationDataSource
 mitkClassMacroItkParent (NavigationDataSource, itk::ProcessObject)
 
virtual std::string GetName ()
 
virtual void SetName (std::string _arg)
 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. More...
 
NavigationDataGetOutput (void)
 return the output (output with id 0) of the filter More...
 
NavigationDataGetOutput (DataObjectPointerArraySizeType idx)
 return the output with id idx of the filter More...
 
NavigationDataGetOutput (const std::string &navDataName)
 return the output with name navDataName of the filter More...
 
NavigationTool::Pointer GetToolMetaData (DataObjectPointerArraySizeType idx)
 
NavigationTool::Pointer GetToolMetaData (const std::string &navDataName)
 
virtual mitk::NavigationToolStorage::Pointer GetToolMetaDataCollection ()
 
virtual void SetToolMetaDataCollection (mitk::NavigationToolStorage::Pointer _arg)
 
DataObjectPointerArraySizeType GetOutputIndex (std::string navDataName)
 return the index of the output with name navDataName, -1 if no output with that name was found More...
 
virtual void RegisterAsMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice(). More...
 
virtual void UnRegisterMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. More...
 
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(). More...
 
virtual void GraftNthOutput (unsigned int idx, itk::DataObject *graft)
 Graft the specified DataObject onto this ProcessObject's output. More...
 
virtual void GraftOutput (itk::DataObject *graft)
 Graft the specified DataObject onto this ProcessObject's output. More...
 
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. More...
 
virtual mitk::PropertyList::ConstPointer GetParameters () const
 Get all filter parameters as a PropertyList. More...
 
virtual void Freeze ()
 
virtual void UnFreeze ()
 
virtual bool GetIsFrozen ()
 

Protected Member Functions

 NavigationDataDelayFilter (unsigned int delay)
 
 ~NavigationDataDelayFilter () override
 
void GenerateData () override
 
- Protected Member Functions inherited from mitk::NavigationDataToNavigationDataFilter
 NavigationDataToNavigationDataFilter ()
 
 ~NavigationDataToNavigationDataFilter () override
 
void CreateOutputsForAllInputs ()
 Create an output for each input. More...
 
- Protected Member Functions inherited from mitk::NavigationDataSource
 NavigationDataSource ()
 
 ~NavigationDataSource () override
 

Protected Attributes

std::queue< BufferType > m_Buffer
 This field containes the buffered navigation datas. It is a queue of (pair of (time and vector of (several navigation datas from one point in time)) In more clarity: The top level queue contains (one Navigation Data for each inout and the time these NDs have been recorded at). More...
 
unsigned int m_Delay
 The amount of time by which the Navigationdatas are delayed in milliseconds. More...
 
unsigned int m_Tolerance
 
- 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
 These Constants are used in conjunction with Microservices. More...
 
static const std::string US_PROPKEY_DEVICENAME
 
static const std::string US_PROPKEY_ID
 
static const std::string US_PROPKEY_ISACTIVE
 

Detailed Description

NavigationDataDelayFilter.

Documentation This Filter is used to delay Navigationdata by a certain amount of time. It is used to synchronize TRacking data with other sources.

Definition at line 36 of file mitkNavigationDataDelayFilter.h.

Constructor & Destructor Documentation

◆ NavigationDataDelayFilter()

mitk::NavigationDataDelayFilter::NavigationDataDelayFilter ( unsigned int  delay)
protected

Definition at line 15 of file mitkNavigationDataDelayFilter.cpp.

References m_Tolerance.

◆ ~NavigationDataDelayFilter()

mitk::NavigationDataDelayFilter::~NavigationDataDelayFilter ( )
overrideprotected

Definition at line 19 of file mitkNavigationDataDelayFilter.cpp.

Member Function Documentation

◆ GenerateData()

◆ mitkClassMacro()

mitk::NavigationDataDelayFilter::mitkClassMacro ( NavigationDataDelayFilter  ,
NavigationDataToNavigationDataFilter   
)

◆ mitkNewMacro1Param()

mitk::NavigationDataDelayFilter::mitkNewMacro1Param ( NavigationDataDelayFilter  ,
unsigned  int 
)

◆ SetDelay()

virtual void mitk::NavigationDataDelayFilter::SetDelay ( unsigned int  _arg)
virtual

Member Data Documentation

◆ m_Buffer

std::queue<BufferType> mitk::NavigationDataDelayFilter::m_Buffer
protected

This field containes the buffered navigation datas. It is a queue of (pair of (time and vector of (several navigation datas from one point in time)) In more clarity: The top level queue contains (one Navigation Data for each inout and the time these NDs have been recorded at).

Definition at line 59 of file mitkNavigationDataDelayFilter.h.

Referenced by GenerateData().

◆ m_Delay

unsigned int mitk::NavigationDataDelayFilter::m_Delay
protected

The amount of time by which the Navigationdatas are delayed in milliseconds.

Definition at line 64 of file mitkNavigationDataDelayFilter.h.

Referenced by GenerateData().

◆ m_Tolerance

unsigned int mitk::NavigationDataDelayFilter::m_Tolerance
protected

Definition at line 65 of file mitkNavigationDataDelayFilter.h.

Referenced by GenerateData(), and NavigationDataDelayFilter().


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