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

Navigation Data source. More...

#include <mitkNavigationDataSource.h>

Inheritance diagram for mitk::NavigationDataSource:
MyNavigationDataSourceTest MyNavigationDataSourceTest mitk::IGTLMessageToNavigationDataFilter mitk::NavigationDataPlayerBase mitk::NavigationDataToNavigationDataFilter mitk::TrackingDeviceSource mitk::NavigationDataCSVSequentialPlayer mitk::NavigationDataPlayer mitk::NavigationDataSequentialPlayer NavigationDataToNavigationDataFilterTestClass mitk::CameraVisualization mitk::NavigationDataDelayFilter mitk::NavigationDataDisplacementFilter mitk::NavigationDataEvaluationFilter mitk::NavigationDataHandEyeCalibrationFilter mitk::NavigationDataLandmarkTransformFilter mitk::NavigationDataObjectVisualizationFilter mitk::NavigationDataPassThroughFilter mitk::NavigationDataRecorder mitk::NavigationDataSliceVisualization mitk::NavigationDataSmoothingFilter mitk::NavigationDataToMessageFilter mitk::NavigationDataTransformFilter mitk::NavigationDataVisualizationFilter

Public Member Functions

 mitkClassMacroItkParent (NavigationDataSource, itk::ProcessObject)
 
 itkGetMacro (Name, std::string)
 
 itkSetMacro (Name, std::string)
 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.
 
NavigationData * GetOutput (void)
 return the output (output with id 0) of the filter
 
NavigationData * GetOutput (DataObjectPointerArraySizeType idx)
 return the output with id idx of the filter
 
NavigationData * GetOutput (const std::string &navDataName)
 return the output with name navDataName of the filter
 
NavigationTool::Pointer GetToolMetaData (DataObjectPointerArraySizeType idx)
 
NavigationTool::Pointer GetToolMetaData (const std::string &navDataName)
 
 itkGetMacro (ToolMetaDataCollection, mitk::NavigationToolStorage::Pointer)
 
 itkSetMacro (ToolMetaDataCollection, mitk::NavigationToolStorage::Pointer)
 
DataObjectPointerArraySizeType GetOutputIndex (std::string navDataName)
 return the index of the output with name navDataName, -1 if no output with that name was found
 
virtual void RegisterAsMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice().
 
virtual void UnRegisterMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin.
 
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().
 
virtual void GraftNthOutput (unsigned int idx, itk::DataObject *graft)
 Graft the specified DataObject onto this ProcessObject's output.
 
virtual void GraftOutput (itk::DataObject *graft)
 Graft the specified DataObject onto this ProcessObject's output.
 
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.
 
virtual mitk::PropertyList::ConstPointer GetParameters () const
 Get all filter parameters as a PropertyList.
 
virtual void Freeze ()
 
virtual void UnFreeze ()
 
 itkGetMacro (IsFrozen, bool)
 

Static Public Attributes

static const std::string US_INTERFACE_NAME = "org.mitk.services.NavigationDataSource"
 These Constants are used in conjunction with Microservices.
 
static const std::string US_PROPKEY_DEVICENAME = US_INTERFACE_NAME + ".devicename"
 
static const std::string US_PROPKEY_ID = US_INTERFACE_NAME + ".id"
 
static const std::string US_PROPKEY_ISACTIVE = US_INTERFACE_NAME + ".isActive"
 

Protected Member Functions

 NavigationDataSource ()
 
 ~NavigationDataSource () override
 

Protected Attributes

std::string m_Name
 
bool m_IsFrozen
 
NavigationToolStorage::Pointer m_ToolMetaDataCollection
 

Detailed Description

Navigation Data source.

Documentation

Base class for all navigation filters that produce NavigationData objects as output. This class defines the output-interface for NavigationDataFilters.

Warning
: if Update() is called on any output object, all NavigationData filters will generate new output data for all outputs, not just the one on which Update() was called.

Definition at line 40 of file mitkNavigationDataSource.h.

Constructor & Destructor Documentation

◆ NavigationDataSource()

mitk::NavigationDataSource::NavigationDataSource ( )
protected

Definition at line 28 of file mitkNavigationDataSource.cpp.

◆ ~NavigationDataSource()

mitk::NavigationDataSource::~NavigationDataSource ( )
overrideprotected

Definition at line 33 of file mitkNavigationDataSource.cpp.

Member Function Documentation

◆ Freeze()

void mitk::NavigationDataSource::Freeze ( )
virtual

Freezes the navigation data source which means the current state is frozen and the output navigation data stays at it is. Calling Update() does not have any effect until UnFreeze() is called. This also means that the data source is not updated any more.

Definition at line 144 of file mitkNavigationDataSource.cpp.

◆ GetMicroserviceID()

std::string mitk::NavigationDataSource::GetMicroserviceID ( )

Returns the id that this device is registered with. The id will only be valid, if the NavigationDataSource has been registered using RegisterAsMicroservice().

Definition at line 90 of file mitkNavigationDataSource.cpp.

◆ GetOutput() [1/3]

mitk::NavigationData * mitk::NavigationDataSource::GetOutput ( const std::string & navDataName)

return the output with name navDataName of the filter

Definition at line 55 of file mitkNavigationDataSource.cpp.

◆ GetOutput() [2/3]

mitk::NavigationData * mitk::NavigationDataSource::GetOutput ( DataObjectPointerArraySizeType idx)

return the output with id idx of the filter

Definition at line 45 of file mitkNavigationDataSource.cpp.

◆ GetOutput() [3/3]

mitk::NavigationData * mitk::NavigationDataSource::GetOutput ( void )

return the output (output with id 0) of the filter

Definition at line 37 of file mitkNavigationDataSource.cpp.

◆ GetOutputIndex()

itk::ProcessObject::DataObjectPointerArraySizeType mitk::NavigationDataSource::GetOutputIndex ( std::string navDataName)

return the index of the output with name navDataName, -1 if no output with that name was found

Warning
if a subclass has outputs that have different data type than mitk::NavigationData, they have to overwrite this method

Definition at line 64 of file mitkNavigationDataSource.cpp.

◆ GetParameters()

mitk::PropertyList::ConstPointer mitk::NavigationDataSource::GetParameters ( ) const
virtual

Get all filter parameters as a PropertyList.

This method allows to get all parameters of a filter with one method call. The returned PropertyList must be assigned to a SmartPointer immediately, or else it will get destroyed. Every filter must overwrite this method to create a filter-specific PropertyList. Note that property names must be unique over all MITK-IGT filters. Therefore each filter should use its name as a prefix for each property name. Secondly, each filter should list the property names and data types in the method documentation.

Reimplemented in mitk::CameraVisualization, and mitk::NavigationDataDisplacementFilter.

Definition at line 136 of file mitkNavigationDataSource.cpp.

◆ GetToolMetaData() [1/2]

mitk::NavigationTool::Pointer mitk::NavigationDataSource::GetToolMetaData ( const std::string & navDataName)
Returns
Returns the metadata of the navigation tool with the given name. Returns an empty object if no metadata is available.

Definition at line 160 of file mitkNavigationDataSource.cpp.

◆ GetToolMetaData() [2/2]

mitk::NavigationTool::Pointer mitk::NavigationDataSource::GetToolMetaData ( DataObjectPointerArraySizeType idx)
Returns
Returns the metadata of the navigation tool at the given idx. Returns an empty object if no metadata is available.

Definition at line 154 of file mitkNavigationDataSource.cpp.

◆ GraftNthOutput()

void mitk::NavigationDataSource::GraftNthOutput ( unsigned int idx,
itk::DataObject * graft )
virtual

Graft the specified DataObject onto this ProcessObject's output.

See itk::ImageSource::GraftNthOutput for details

Definition at line 99 of file mitkNavigationDataSource.cpp.

◆ GraftOutput()

void mitk::NavigationDataSource::GraftOutput ( itk::DataObject * graft)
virtual

Graft the specified DataObject onto this ProcessObject's output.

See itk::ImageSource::Graft Output for details

Definition at line 94 of file mitkNavigationDataSource.cpp.

◆ itkGetMacro() [1/3]

mitk::NavigationDataSource::itkGetMacro ( IsFrozen ,
bool  )
Returns
Returns whether the data source is currently frozen.

◆ itkGetMacro() [2/3]

mitk::NavigationDataSource::itkGetMacro ( Name ,
std::string  )
Returns
Returns a human readable name of this source. There will be a default name, or you can set the name with the method SetName() if you want to change it.

◆ itkGetMacro() [3/3]

mitk::NavigationDataSource::itkGetMacro ( ToolMetaDataCollection ,
mitk::NavigationToolStorage::Pointer  )
Returns
Returns the metadata of all tools identified by the tool name. There is no need to set the metadata of the tools, so not every tool has metadata available. Returns an empty tool storage if no metadata was set at all.

◆ itkSetMacro() [1/2]

mitk::NavigationDataSource::itkSetMacro ( Name ,
std::string  )

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.

◆ itkSetMacro() [2/2]

mitk::NavigationDataSource::itkSetMacro ( ToolMetaDataCollection ,
mitk::NavigationToolStorage::Pointer  )

Sets the tool metadata as NavigationToolStorage object.

◆ MakeOutput() [1/2]

itk::DataObject::Pointer mitk::NavigationDataSource::MakeOutput ( const DataObjectIdentifierType & name)
override

This is a default implementation to make sure we have something. Once all the subclasses of ProcessObject provide an appopriate MakeOutput(), then ProcessObject::MakeOutput() can be made pure virtual.

Definition at line 126 of file mitkNavigationDataSource.cpp.

◆ MakeOutput() [2/2]

itk::DataObject::Pointer mitk::NavigationDataSource::MakeOutput ( DataObjectPointerArraySizeType idx)
override

Allocates a new output object and returns it. Currently the index idx is not evaluated.

Parameters
idxthe index of the output for which an object should be created
Returns
the new object

Definition at line 121 of file mitkNavigationDataSource.cpp.

◆ mitkClassMacroItkParent()

mitk::NavigationDataSource::mitkClassMacroItkParent ( NavigationDataSource ,
itk::ProcessObject  )

◆ RegisterAsMicroservice()

void mitk::NavigationDataSource::RegisterAsMicroservice ( )
virtual

Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice().

Definition at line 73 of file mitkNavigationDataSource.cpp.

◆ SetParameters()

virtual void mitk::NavigationDataSource::SetParameters ( const mitk::PropertyList * )
inlinevirtual

Set all filter parameters as the PropertyList p.

This method allows to set all parameters of a filter with one method call. For the names of the parameters, take a look at the GetParameters method of the filter This method has to be overwritten by each MITK-IGT filter.

Reimplemented in mitk::CameraVisualization, and mitk::NavigationDataDisplacementFilter.

Definition at line 161 of file mitkNavigationDataSource.h.

◆ UnFreeze()

void mitk::NavigationDataSource::UnFreeze ( )
virtual

Unfreezes the data source.

Definition at line 149 of file mitkNavigationDataSource.cpp.

◆ UnRegisterMicroservice()

void mitk::NavigationDataSource::UnRegisterMicroservice ( )
virtual

Registers this object as a Microservice, making it available to every module and/or plugin.

Definition at line 85 of file mitkNavigationDataSource.cpp.

Member Data Documentation

◆ m_IsFrozen

bool mitk::NavigationDataSource::m_IsFrozen
protected

Definition at line 196 of file mitkNavigationDataSource.h.

◆ m_Name

std::string mitk::NavigationDataSource::m_Name
protected

Definition at line 194 of file mitkNavigationDataSource.h.

◆ m_ToolMetaDataCollection

NavigationToolStorage::Pointer mitk::NavigationDataSource::m_ToolMetaDataCollection
protected

Holds the metadata of all tools identified by the tool name. There is no need to set the metadata of the tools, so not every tool has metadata available.

Definition at line 201 of file mitkNavigationDataSource.h.

◆ US_INTERFACE_NAME

const std::string mitk::NavigationDataSource::US_INTERFACE_NAME = "org.mitk.services.NavigationDataSource"
static

These Constants are used in conjunction with Microservices.

Definition at line 118 of file mitkNavigationDataSource.h.

◆ US_PROPKEY_DEVICENAME

const std::string mitk::NavigationDataSource::US_PROPKEY_DEVICENAME = US_INTERFACE_NAME + ".devicename"
static

Definition at line 119 of file mitkNavigationDataSource.h.

◆ US_PROPKEY_ID

const std::string mitk::NavigationDataSource::US_PROPKEY_ID = US_INTERFACE_NAME + ".id"
static

Definition at line 120 of file mitkNavigationDataSource.h.

◆ US_PROPKEY_ISACTIVE

const std::string mitk::NavigationDataSource::US_PROPKEY_ISACTIVE = US_INTERFACE_NAME + ".isActive"
static

Definition at line 121 of file mitkNavigationDataSource.h.

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