MITK-IGT
IGT Extension of MITK
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::NavigationDataToPointSetFilter Class Reference

This filter creates mitk::PointSet objects from mitk::NavigaitionData objects. More...

#include <mitkNavigationDataToPointSetFilter.h>

Inheritance diagram for mitk::NavigationDataToPointSetFilter:

Public Types

enum  OperationMode { Mode3D , Mode3DMean , Mode4D }
 There are two different operation modes. More...
 

Public Member Functions

 mitkClassMacro (NavigationDataToPointSetFilter, PointSetSource)
 
 itkFactorylessNewMacro (Self)
 
 itkCloneMacro (Self)
 
 itkSetMacro (RingBufferSize, unsigned int)
 Sets the size for the ring buffer.
 
 itkSetMacro (NumberForMean, unsigned int)
 Sets the number of Navigation Data, which should be averaged.
 
 itkGetMacro (NumberForMean, unsigned int)
 Gets the number of Navigation Data, which should be averaged.
 
void GenerateData () override
 filter execute method
 
virtual void SetInput (const mitk::NavigationData *NavigationData)
 Sets one input NavigationData.
 
virtual void SetInput (unsigned int idx, const NavigationData *nd)
 Sets the input NavigationData at a specific index.
 
const mitk::NavigationData * GetInput ()
 Returns the input of this filter.
 
const mitk::NavigationData * GetInput (unsigned int idx)
 Returns the input number idx of this filter.
 
virtual void SetOperationMode (OperationMode mode)
 Sets the mode of this filter.
 
 itkGetConstMacro (OperationMode, OperationMode)
 returns the mode of this filter.
 
void GenerateOutputInformation () override
 

Protected Member Functions

 NavigationDataToPointSetFilter ()
 empty implementation to prevent calling of the superclass method that would try to copy information from the input NavigationData to the output PointSet, which makes no sense!
 
 ~NavigationDataToPointSetFilter () override
 
virtual void GenerateDataMode3D ()
 Generates the output for Mode3D.
 
virtual void GenerateDataMode3DMean ()
 Generates the output for Mode3DMean.
 
virtual void GenerateDataMode4D ()
 Generates the output for Mode4D.
 
virtual void CreateOutputsForAllInputs ()
 create output objects according to OperationMode for all inputs
 

Protected Attributes

OperationMode m_OperationMode
 Stores the mode. See enum OperationMode.
 
unsigned int m_RingBufferSize
 Stores the ringbuffer size.
 
unsigned int m_CurrentTimeStep
 Indicates the current timestamp.
 
unsigned int m_NumberForMean
 Number of Navigation Data, which should be averaged.
 

Detailed Description

This filter creates mitk::PointSet objects from mitk::NavigaitionData objects.

Documentation

This filter has two modes that can be set with SetOperationMode().

  • Mode3D: every input NavigationData is processed into one output pointset. For each call to Update() a point with the ND position will be added to the PointSet
  • Mode4D: one output pointset is generated that contains one point for each input NavigationData. Each call to Update() adds a new timestep to the PointSet that contains new positions for the points.

Definition at line 35 of file mitkNavigationDataToPointSetFilter.h.

Member Enumeration Documentation

◆ OperationMode

enum mitk::NavigationDataToPointSetFilter::OperationMode

There are two different operation modes.

Documentation

  • Mode3D: every input NavigationData is processed into one output pointset that contains a point with the ND position for each Update()
  • Mode3DMean: a defined number of input NavigationData is used to generate a mean position and processed into one output pointset that contains a point with the ND position for each Update()
  • Mode4D: one output pointset is generated that contains one point for each input NavigationData. Each call to Update() adds a new timestep to the PointSet that contains new positions for the points. The RingBufferSize limits the number of timesteps in the 4D mode. It currently does not limit the number of points in the 3D mode.
Enumerator
Mode3D 
Mode3DMean 
Mode4D 

Definition at line 50 of file mitkNavigationDataToPointSetFilter.h.

Constructor & Destructor Documentation

◆ NavigationDataToPointSetFilter()

mitk::NavigationDataToPointSetFilter::NavigationDataToPointSetFilter ( )
protected

empty implementation to prevent calling of the superclass method that would try to copy information from the input NavigationData to the output PointSet, which makes no sense!

Definition at line 19 of file mitkNavigationDataToPointSetFilter.cpp.

◆ ~NavigationDataToPointSetFilter()

mitk::NavigationDataToPointSetFilter::~NavigationDataToPointSetFilter ( )
overrideprotected

Definition at line 33 of file mitkNavigationDataToPointSetFilter.cpp.

Member Function Documentation

◆ CreateOutputsForAllInputs()

void mitk::NavigationDataToPointSetFilter::CreateOutputsForAllInputs ( )
protectedvirtual

create output objects according to OperationMode for all inputs

Definition at line 88 of file mitkNavigationDataToPointSetFilter.cpp.

◆ GenerateData()

void mitk::NavigationDataToPointSetFilter::GenerateData ( )
override

filter execute method

Definition at line 37 of file mitkNavigationDataToPointSetFilter.cpp.

◆ GenerateDataMode3D()

void mitk::NavigationDataToPointSetFilter::GenerateDataMode3D ( )
protectedvirtual

Generates the output for Mode3D.

Definition at line 118 of file mitkNavigationDataToPointSetFilter.cpp.

◆ GenerateDataMode3DMean()

void mitk::NavigationDataToPointSetFilter::GenerateDataMode3DMean ( )
protectedvirtual

Generates the output for Mode3DMean.

read n times all connected inputs and sum them into outputs. Finish with dividing each output by n.

Definition at line 137 of file mitkNavigationDataToPointSetFilter.cpp.

◆ GenerateDataMode4D()

void mitk::NavigationDataToPointSetFilter::GenerateDataMode4D ( )
protectedvirtual

Generates the output for Mode4D.

Definition at line 221 of file mitkNavigationDataToPointSetFilter.cpp.

◆ GenerateOutputInformation()

void mitk::NavigationDataToPointSetFilter::GenerateOutputInformation ( )
inlineoverride

Definition at line 120 of file mitkNavigationDataToPointSetFilter.h.

◆ GetInput() [1/2]

const mitk::NavigationData * mitk::NavigationDataToPointSetFilter::GetInput ( void )

Returns the input of this filter.

Definition at line 72 of file mitkNavigationDataToPointSetFilter.cpp.

◆ GetInput() [2/2]

const mitk::NavigationData * mitk::NavigationDataToPointSetFilter::GetInput ( unsigned int idx)

Returns the input number idx of this filter.

Definition at line 80 of file mitkNavigationDataToPointSetFilter.cpp.

◆ itkCloneMacro()

mitk::NavigationDataToPointSetFilter::itkCloneMacro ( Self )

◆ itkFactorylessNewMacro()

mitk::NavigationDataToPointSetFilter::itkFactorylessNewMacro ( Self )

◆ itkGetConstMacro()

mitk::NavigationDataToPointSetFilter::itkGetConstMacro ( OperationMode ,
OperationMode  )

returns the mode of this filter.

See OperationMode for the behavior in the different modes

◆ itkGetMacro()

mitk::NavigationDataToPointSetFilter::itkGetMacro ( NumberForMean ,
unsigned int  )

Gets the number of Navigation Data, which should be averaged.

◆ itkSetMacro() [1/2]

mitk::NavigationDataToPointSetFilter::itkSetMacro ( NumberForMean ,
unsigned int  )

Sets the number of Navigation Data, which should be averaged.

◆ itkSetMacro() [2/2]

mitk::NavigationDataToPointSetFilter::itkSetMacro ( RingBufferSize ,
unsigned int  )

Sets the size for the ring buffer.

Documentation

The size determines the maximum number of timesteps in 4D mode and the number of points in 3D mode of the output PointSet

◆ mitkClassMacro()

mitk::NavigationDataToPointSetFilter::mitkClassMacro ( NavigationDataToPointSetFilter ,
PointSetSource  )

◆ SetInput() [1/2]

void mitk::NavigationDataToPointSetFilter::SetInput ( const mitk::NavigationData * NavigationData)
virtual

Sets one input NavigationData.

Definition at line 56 of file mitkNavigationDataToPointSetFilter.cpp.

◆ SetInput() [2/2]

void mitk::NavigationDataToPointSetFilter::SetInput ( unsigned int idx,
const NavigationData * nd )
virtual

Sets the input NavigationData at a specific index.

Definition at line 64 of file mitkNavigationDataToPointSetFilter.cpp.

◆ SetOperationMode()

void mitk::NavigationDataToPointSetFilter::SetOperationMode ( OperationMode mode)
virtual

Sets the mode of this filter.

See OperationMode for the behavior in the different modes

Warning
A call to this method will change the number of outputs of the filter. After calling this method, all previously acquired pointers to outputs are invalid Always set the operation mode first, then get the outputs with GetOutput()

Definition at line 239 of file mitkNavigationDataToPointSetFilter.cpp.

Member Data Documentation

◆ m_CurrentTimeStep

unsigned int mitk::NavigationDataToPointSetFilter::m_CurrentTimeStep
protected

Indicates the current timestamp.

Definition at line 151 of file mitkNavigationDataToPointSetFilter.h.

◆ m_NumberForMean

unsigned int mitk::NavigationDataToPointSetFilter::m_NumberForMean
protected

Number of Navigation Data, which should be averaged.

Definition at line 152 of file mitkNavigationDataToPointSetFilter.h.

◆ m_OperationMode

OperationMode mitk::NavigationDataToPointSetFilter::m_OperationMode
protected

Stores the mode. See enum OperationMode.

Definition at line 149 of file mitkNavigationDataToPointSetFilter.h.

◆ m_RingBufferSize

unsigned int mitk::NavigationDataToPointSetFilter::m_RingBufferSize
protected

Stores the ringbuffer size.

Definition at line 150 of file mitkNavigationDataToPointSetFilter.h.

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