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

#include <mitkNavigationDataToMessageFilter.h>

Inheritance diagram for mitk::NavigationDataToMessageFilter:

[legend]

Collaboration diagram for mitk::NavigationDataToMessageFilter:

[legend]

List of all members.

Public Types
typedef NavigationDataToMessageFilter	Self
typedef NavigationDataToNavigationDataFilter	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
Public Member Functions
virtual const char *	GetClassName () const
void	AddPositionChangedListener (const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::PositionType, unsigned int > &delegate)
void	RemovePositionChangedListener (const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::PositionType, unsigned int > &delegate)
void	AddOrientationChangedListener (const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::OrientationType, unsigned int > &delegate)
void	RemoveOrientationChangedListener (const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::OrientationType, unsigned int > &delegate)
void	AddErrorChangedListener (const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::CovarianceMatrixType, unsigned int > &delegate)
void	RemoveErrorChangedListener (const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::CovarianceMatrixType, unsigned int > &delegate)
void	AddTimeStampChangedListener (const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::TimeStampType, unsigned int > &delegate)
void	RemoveTimeStampChangedListener (const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::TimeStampType, unsigned int > &delegate)
void	AddDataValidChangedListener (const ::mitk::MessageAbstractDelegate2< bool, unsigned int > &delegate)
void	RemoveDataValidChangedListener (const ::mitk::MessageAbstractDelegate2< bool, unsigned int > &delegate)
virtual void	SetPositionEpsilon (double _arg)
	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.
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 ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	NavigationDataToMessageFilter ()
virtual	~NavigationDataToMessageFilter ()
virtual void	GenerateData ()
	filter execute method
Protected Attributes
double	m_PositionEpsilon
double	m_OrientationEpsilon
double	m_CovErrorEpsilon
double	m_TimeStampEpsilon

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 42 of file mitkNavigationDataToMessageFilter.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::NavigationDataToMessageFilter::ConstPointer

Reimplemented from mitk::NavigationDataToNavigationDataFilter.

Definition at line 45 of file mitkNavigationDataToMessageFilter.h.

typedef itk::SmartPointer<Self> mitk::NavigationDataToMessageFilter::Pointer

Reimplemented from mitk::NavigationDataToNavigationDataFilter.

Definition at line 45 of file mitkNavigationDataToMessageFilter.h.

typedef NavigationDataToMessageFilter mitk::NavigationDataToMessageFilter::Self

Reimplemented from mitk::NavigationDataToNavigationDataFilter.

Definition at line 45 of file mitkNavigationDataToMessageFilter.h.

typedef NavigationDataToNavigationDataFilter mitk::NavigationDataToMessageFilter::Superclass

Reimplemented from mitk::NavigationDataToNavigationDataFilter.

Definition at line 45 of file mitkNavigationDataToMessageFilter.h.

Constructor & Destructor Documentation

mitk::NavigationDataToMessageFilter::NavigationDataToMessageFilter ( ) [protected]

Definition at line 22 of file mitkNavigationDataToMessageFilter.cpp.

: mitk::NavigationDataToNavigationDataFilter(),
  m_PositionEpsilon(0.0f), m_OrientationEpsilon(0.0f), m_CovErrorEpsilon(0.0f), m_TimeStampEpsilon(0.0f)
{
  this->SetNumberOfRequiredInputs(1);
}

mitk::NavigationDataToMessageFilter::~NavigationDataToMessageFilter ( ) [protected, virtual]

Definition at line 29 of file mitkNavigationDataToMessageFilter.cpp.

{
}

Member Function Documentation

void mitk::NavigationDataToMessageFilter::AddDataValidChangedListener ( const ::mitk::MessageAbstractDelegate2< bool, unsigned int > & delegate ) [inline]

Definition at line 51 of file mitkNavigationDataToMessageFilter.h.

: this filter only has input #0!

void mitk::NavigationDataToMessageFilter::AddErrorChangedListener ( const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::CovarianceMatrixType, unsigned int > & delegate ) [inline]

Definition at line 49 of file mitkNavigationDataToMessageFilter.h.

void mitk::NavigationDataToMessageFilter::AddOrientationChangedListener ( const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::OrientationType, unsigned int > & delegate ) [inline]

Definition at line 48 of file mitkNavigationDataToMessageFilter.h.

void mitk::NavigationDataToMessageFilter::AddPositionChangedListener ( const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::PositionType, unsigned int > & delegate ) [inline]

Definition at line 47 of file mitkNavigationDataToMessageFilter.h.

void mitk::NavigationDataToMessageFilter::AddTimeStampChangedListener ( const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::TimeStampType, unsigned int > & delegate ) [inline]

Definition at line 50 of file mitkNavigationDataToMessageFilter.h.

: this filter only has input #0!

void mitk::NavigationDataToMessageFilter::GenerateData ( ) [protected, virtual]

filter execute method

Documentation emits the Messages

Definition at line 52 of file mitkNavigationDataToMessageFilter.cpp.

References mitk::NavigationData::GetCovErrorMatrix(), mitk::NavigationData::GetOrientation(), mitk::NavigationData::GetPosition(), mitk::NavigationData::GetTimeStamp(), mitk::NavigationData::Graft(), and mitk::NavigationData::IsDataValid().

{
  /* update outputs with tracking data from tools */
  for (unsigned int i = 0; i < this->GetNumberOfOutputs() ; ++i)
  {
    mitk::NavigationData* output = this->GetOutput(i);
    assert(output);
    const mitk::NavigationData* input = this->GetInput(i);
    assert(input);

    /* check for differences, then send message. */
    if ((output->GetPosition() - input->GetPosition()).GetNorm() > m_PositionEpsilon)
      m_PositionChangedMessage.Send(input->GetPosition(), i);

    if ((output->GetOrientation() - input->GetOrientation()).magnitude() > m_OrientationEpsilon)
      m_OrientationChangedMessage.Send(input->GetOrientation(), i);

    if ((output->GetCovErrorMatrix().GetVnlMatrix() - input->GetCovErrorMatrix().GetVnlMatrix()).absolute_value_max() > m_CovErrorEpsilon)
      m_ErrorChangedMessage.Send(input->GetCovErrorMatrix(), i);

    if (fabs(output->GetTimeStamp() - input->GetTimeStamp()) > m_TimeStampEpsilon)
      m_TimeStampChangedMessage.Send(input->GetTimeStamp(), i);

    if (input->IsDataValid() != output->IsDataValid())
      m_DataValidChangedMessage.Send(input->IsDataValid(), i);

    output->Graft(input); // Because this is a NavigationDataToNavigationData Filter, we need to copy the input to the output to provide up to date navigation data objects
  }
}

virtual const char* mitk::NavigationDataToMessageFilter::GetClassName ( ) const [virtual]

Reimplemented from mitk::NavigationDataToNavigationDataFilter.

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

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

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

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

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

Referenced by mitkNavigationDataToMessageFilterTest(), QmitkIGTExampleView::OnShowErrorPlot(), and QmitkIGTRecorderView::SetupIGTPipeline().

void mitk::NavigationDataToMessageFilter::RemoveDataValidChangedListener ( const ::mitk::MessageAbstractDelegate2< bool, unsigned int > & delegate ) [inline]

Definition at line 51 of file mitkNavigationDataToMessageFilter.h.

: this filter only has input #0!

void mitk::NavigationDataToMessageFilter::RemoveErrorChangedListener ( const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::CovarianceMatrixType, unsigned int > & delegate ) [inline]

Definition at line 49 of file mitkNavigationDataToMessageFilter.h.

void mitk::NavigationDataToMessageFilter::RemoveOrientationChangedListener ( const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::OrientationType, unsigned int > & delegate ) [inline]

Definition at line 48 of file mitkNavigationDataToMessageFilter.h.

void mitk::NavigationDataToMessageFilter::RemovePositionChangedListener ( const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::PositionType, unsigned int > & delegate ) [inline]

Definition at line 47 of file mitkNavigationDataToMessageFilter.h.

void mitk::NavigationDataToMessageFilter::RemoveTimeStampChangedListener ( const ::mitk::MessageAbstractDelegate2< mitk::NavigationData::TimeStampType, unsigned int > & delegate ) [inline]

Definition at line 50 of file mitkNavigationDataToMessageFilter.h.

: this filter only has input #0!

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

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

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

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.

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

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.

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