Medical Imaging Interaction Toolkit  2018.04.99-52adb583
Medical Imaging Interaction Toolkit
mitk::NavigationDataToPointSetFilter Class Reference

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

#include <mitkNavigationDataToPointSetFilter.h>

Inheritance diagram for mitk::NavigationDataToPointSetFilter:
Collaboration diagram for mitk::NavigationDataToPointSetFilter:

Public Types

enum  OperationMode { Mode3D, Mode3DMean, Mode4D }
 There are two different operation modes. More...
 
- Public Types inherited from mitk::PointSetSource
typedef PointSetSource Self
 
typedef BaseDataSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef PointSet OutputType
 
typedef OutputType::Pointer OutputTypePointer
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 

Public Member Functions

 mitkClassMacro (NavigationDataToPointSetFilter, PointSetSource)
 
Pointer Clone () const
 
virtual void SetRingBufferSize (unsigned int _arg)
 Sets the size for the ring buffer. More...
 
virtual void SetNumberForMean (unsigned int _arg)
 Sets the number of Navigation Data, which should be averaged. More...
 
virtual unsigned int GetNumberForMean ()
 Gets the number of Navigation Data, which should be averaged. More...
 
void GenerateData () override
 filter execute method More...
 
virtual void SetInput (const mitk::NavigationData *NavigationData)
 Sets one input NavigationData. More...
 
virtual void SetInput (unsigned int idx, const NavigationData *nd)
 Sets the input NavigationData at a specific index. More...
 
const mitk::NavigationDataGetInput ()
 Returns the input of this filter. More...
 
const mitk::NavigationDataGetInput (unsigned int idx)
 Returns the input number idx of this filter. More...
 
virtual void SetOperationMode (OperationMode mode)
 Sets the mode of this filter. More...
 
virtual OperationMode GetOperationMode () const
 returns the mode of this filter. More...
 
void GenerateOutputInformation () override
 
- Public Member Functions inherited from mitk::PointSetSource
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
- Public Member Functions inherited from mitk::BaseDataSource
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Access itk::ProcessObject::m_Updating. More...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::PointSetSource
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 

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! More...
 
 ~NavigationDataToPointSetFilter () override
 
virtual void GenerateDataMode3D ()
 Generates the output for Mode3D. More...
 
virtual void GenerateDataMode3DMean ()
 Generates the output for Mode3DMean. More...
 
virtual void GenerateDataMode4D ()
 Generates the output for Mode4D. More...
 
virtual void CreateOutputsForAllInputs ()
 create output objects according to OperationMode for all inputs More...
 
- Protected Member Functions inherited from mitk::PointSetSource
 PointSetSource ()
 
 ~PointSetSource () override
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Protected Attributes

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

Additional Inherited Members

- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

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

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!

◆ ~NavigationDataToPointSetFilter()

mitk::NavigationDataToPointSetFilter::~NavigationDataToPointSetFilter ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::NavigationDataToPointSetFilter::Clone ( ) const

◆ CreateOutputsForAllInputs()

virtual void mitk::NavigationDataToPointSetFilter::CreateOutputsForAllInputs ( )
protectedvirtual

create output objects according to OperationMode for all inputs

◆ GenerateData()

void mitk::NavigationDataToPointSetFilter::GenerateData ( )
override

filter execute method

◆ GenerateDataMode3D()

virtual void mitk::NavigationDataToPointSetFilter::GenerateDataMode3D ( )
protectedvirtual

Generates the output for Mode3D.

◆ GenerateDataMode3DMean()

virtual void mitk::NavigationDataToPointSetFilter::GenerateDataMode3DMean ( )
protectedvirtual

Generates the output for Mode3DMean.

◆ GenerateDataMode4D()

virtual void mitk::NavigationDataToPointSetFilter::GenerateDataMode4D ( )
protectedvirtual

Generates the output for Mode4D.

◆ GenerateOutputInformation()

void mitk::NavigationDataToPointSetFilter::GenerateOutputInformation ( )
inlineoverride

Definition at line 120 of file mitkNavigationDataToPointSetFilter.h.

◆ GetInput() [1/2]

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

Returns the input of this filter.

◆ GetInput() [2/2]

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

Returns the input number idx of this filter.

◆ GetNumberForMean()

virtual unsigned int mitk::NavigationDataToPointSetFilter::GetNumberForMean ( )
virtual

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

◆ GetOperationMode()

virtual OperationMode mitk::NavigationDataToPointSetFilter::GetOperationMode ( ) const
virtual

returns the mode of this filter.

See OperationMode for the behavior in the different modes

◆ mitkClassMacro()

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

◆ New()

static Pointer mitk::NavigationDataToPointSetFilter::New ( )
static

◆ SetInput() [1/2]

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

Sets one input NavigationData.

◆ SetInput() [2/2]

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

Sets the input NavigationData at a specific index.

◆ SetNumberForMean()

virtual void mitk::NavigationDataToPointSetFilter::SetNumberForMean ( unsigned int  _arg)
virtual

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

◆ SetOperationMode()

virtual 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()

◆ SetRingBufferSize()

virtual void mitk::NavigationDataToPointSetFilter::SetRingBufferSize ( unsigned int  _arg)
virtual

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

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 file: