Medical Imaging Interaction Toolkit  2021.02.99-00f000b3
Medical Imaging Interaction Toolkit
mitk::NavigationDataToMessageFilter Class Reference

NavigationDataToMessageFilter emits multiple mitk::Message messages when the input NavigationData values change. More...

#include <mitkNavigationDataToMessageFilter.h>

Inheritance diagram for mitk::NavigationDataToMessageFilter:
Collaboration diagram for mitk::NavigationDataToMessageFilter:

Public Member Functions

 mitkClassMacro (NavigationDataToMessageFilter, NavigationDataToNavigationDataFilter)
 
Pointer Clone () const
 
 mitkNewMessage2Macro (PositionChanged, mitk::NavigationData::PositionType, unsigned int)
 Sends the message PositionChangedMessage whenever the position of the input changes. First parameter is the new position, second parameter is the index of the input that changed. More...
 
 mitkNewMessage2Macro (OrientationChanged, mitk::NavigationData::OrientationType, unsigned int)
 Sends the message OrientationChangedMessage whenever the orientation of the input changes. First parameter is the new orientation, second parameter is the index of the input that changed. More...
 
 mitkNewMessage2Macro (ErrorChanged, mitk::NavigationData::CovarianceMatrixType, unsigned int)
 Sends the message ErrorChangedMessage whenever the error covariance matrix of the input changes. First parameter is the new error covariance matrix, second parameter is the index of the input that changed. More...
 
 mitkNewMessage2Macro (TimeStampChanged, mitk::NavigationData::TimeStampType, unsigned int)
 Sends the message TimeStampChangedMessage whenever the timestamp of the input changes. First parameter is the new timestamp, second parameter is the index of the input that changed. More...
 
 mitkNewMessage2Macro (DataValidChanged, bool, unsigned int)
 Sends the message DataValidChangedMessage whenever the DataValid flag of the input changes. First parameter is the new DataValid value, second parameter is the index of the input that changed. More...
 
virtual void SetPositionEpsilon (double _arg)
 sets the nth input of the filter. Warning: this filter only has input #0! More...
 
virtual void SetOrientationEpsilon (double _arg)
 
virtual void SetCovErrorEpsilon (double _arg)
 
virtual void SetTimeStampEpsilon (double _arg)
 
virtual double GetPositionEpsilon ()
 
virtual double GetOrientationEpsilon ()
 
virtual double GetCovErrorEpsilon ()
 
virtual double GetTimeStampEpsilon ()
 
- 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 ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 NavigationDataToMessageFilter ()
 
 ~NavigationDataToMessageFilter () override
 
void GenerateData () override
 filter execute method More...
 
- 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

double m_PositionEpsilon
 
double m_OrientationEpsilon
 
double m_CovErrorEpsilon
 
double m_TimeStampEpsilon
 
- 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

NavigationDataToMessageFilter emits multiple mitk::Message messages when the input NavigationData values change.

Documentation This filter can have multiple inputs. It emits the following Messages if an input navigation data values changed since the last Update()

  • PositionChangedMessage
  • OrientationChangedMessage
  • ErrorChangedMessage
  • TimeStampChangedMessage
  • DataValidChangedMessage

The first parameter of these messages is the new value, the second is the index of the input that has changed The filter has as many outputs as it has inputs. It copies the inputs to the outputs after sending the messages.

Definition at line 37 of file mitkNavigationDataToMessageFilter.h.

Constructor & Destructor Documentation

◆ NavigationDataToMessageFilter()

mitk::NavigationDataToMessageFilter::NavigationDataToMessageFilter ( )
protected

◆ ~NavigationDataToMessageFilter()

mitk::NavigationDataToMessageFilter::~NavigationDataToMessageFilter ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::NavigationDataToMessageFilter::Clone ( ) const

◆ GenerateData()

void mitk::NavigationDataToMessageFilter::GenerateData ( )
overrideprotected

filter execute method

Documentation emits the Messages

◆ GetCovErrorEpsilon()

virtual double mitk::NavigationDataToMessageFilter::GetCovErrorEpsilon ( )
virtual

◆ GetOrientationEpsilon()

virtual double mitk::NavigationDataToMessageFilter::GetOrientationEpsilon ( )
virtual

◆ GetPositionEpsilon()

virtual double mitk::NavigationDataToMessageFilter::GetPositionEpsilon ( )
virtual

◆ GetTimeStampEpsilon()

virtual double mitk::NavigationDataToMessageFilter::GetTimeStampEpsilon ( )
virtual

◆ mitkClassMacro()

mitk::NavigationDataToMessageFilter::mitkClassMacro ( NavigationDataToMessageFilter  ,
NavigationDataToNavigationDataFilter   
)

◆ mitkNewMessage2Macro() [1/5]

mitk::NavigationDataToMessageFilter::mitkNewMessage2Macro ( PositionChanged  ,
mitk::NavigationData::PositionType  ,
unsigned  int 
)

Sends the message PositionChangedMessage whenever the position of the input changes. First parameter is the new position, second parameter is the index of the input that changed.

◆ mitkNewMessage2Macro() [2/5]

mitk::NavigationDataToMessageFilter::mitkNewMessage2Macro ( OrientationChanged  ,
mitk::NavigationData::OrientationType  ,
unsigned  int 
)

Sends the message OrientationChangedMessage whenever the orientation of the input changes. First parameter is the new orientation, second parameter is the index of the input that changed.

◆ mitkNewMessage2Macro() [3/5]

mitk::NavigationDataToMessageFilter::mitkNewMessage2Macro ( ErrorChanged  ,
mitk::NavigationData::CovarianceMatrixType  ,
unsigned  int 
)

Sends the message ErrorChangedMessage whenever the error covariance matrix of the input changes. First parameter is the new error covariance matrix, second parameter is the index of the input that changed.

◆ mitkNewMessage2Macro() [4/5]

mitk::NavigationDataToMessageFilter::mitkNewMessage2Macro ( TimeStampChanged  ,
mitk::NavigationData::TimeStampType  ,
unsigned  int 
)

Sends the message TimeStampChangedMessage whenever the timestamp of the input changes. First parameter is the new timestamp, second parameter is the index of the input that changed.

◆ mitkNewMessage2Macro() [5/5]

mitk::NavigationDataToMessageFilter::mitkNewMessage2Macro ( DataValidChanged  ,
bool  ,
unsigned  int 
)

Sends the message DataValidChangedMessage whenever the DataValid flag of the input changes. First parameter is the new DataValid value, second parameter is the index of the input that changed.

◆ New()

static Pointer mitk::NavigationDataToMessageFilter::New ( )
static

◆ SetCovErrorEpsilon()

virtual void mitk::NavigationDataToMessageFilter::SetCovErrorEpsilon ( double  _arg)
virtual

◆ SetOrientationEpsilon()

virtual void mitk::NavigationDataToMessageFilter::SetOrientationEpsilon ( double  _arg)
virtual

◆ SetPositionEpsilon()

virtual void mitk::NavigationDataToMessageFilter::SetPositionEpsilon ( double  _arg)
virtual

sets the nth input of the filter. Warning: this filter only has input #0!

Documentation WARNING: NavigationDataToMessageFilter manages only one input. Calling this method with an idx parameter other than 0 will raise an std::invalid_argument exception! Documentation Sets the input of this filter

Sets the input navigation data object for this filter.

◆ SetTimeStampEpsilon()

virtual void mitk::NavigationDataToMessageFilter::SetTimeStampEpsilon ( double  _arg)
virtual

Member Data Documentation

◆ m_CovErrorEpsilon

double mitk::NavigationDataToMessageFilter::m_CovErrorEpsilon
protected

Definition at line 76 of file mitkNavigationDataToMessageFilter.h.

◆ m_OrientationEpsilon

double mitk::NavigationDataToMessageFilter::m_OrientationEpsilon
protected

Definition at line 75 of file mitkNavigationDataToMessageFilter.h.

◆ m_PositionEpsilon

double mitk::NavigationDataToMessageFilter::m_PositionEpsilon
protected

Definition at line 72 of file mitkNavigationDataToMessageFilter.h.

◆ m_TimeStampEpsilon

double mitk::NavigationDataToMessageFilter::m_TimeStampEpsilon
protected

Definition at line 77 of file mitkNavigationDataToMessageFilter.h.


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