Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::NavigationDataToNavigationDataFilter Class Reference

NavigationDataToNavigationDataFilter is the base class of all filters that receive NavigationDatas as input and produce NavigationDatas as output. More...

#include <mitkNavigationDataToNavigationDataFilter.h>

Inheritance diagram for mitk::NavigationDataToNavigationDataFilter:
Collaboration diagram for mitk::NavigationDataToNavigationDataFilter:

Public Member Functions

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

Protected Member Functions

 NavigationDataToNavigationDataFilter ()
 
 ~NavigationDataToNavigationDataFilter () override
 
void CreateOutputsForAllInputs ()
 Create an output for each input. More...
 
- Protected Member Functions inherited from mitk::NavigationDataSource
 NavigationDataSource ()
 
 ~NavigationDataSource () override
 

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
 
- Protected Attributes inherited from mitk::NavigationDataSource
std::string m_Name
 
bool m_IsFrozen
 
NavigationToolStorage::Pointer m_ToolMetaDataCollection
 

Detailed Description

NavigationDataToNavigationDataFilter is the base class of all filters that receive NavigationDatas as input and produce NavigationDatas as output.

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

Definition at line 32 of file mitkNavigationDataToNavigationDataFilter.h.

Constructor & Destructor Documentation

◆ NavigationDataToNavigationDataFilter()

mitk::NavigationDataToNavigationDataFilter::NavigationDataToNavigationDataFilter ( )
protected

◆ ~NavigationDataToNavigationDataFilter()

mitk::NavigationDataToNavigationDataFilter::~NavigationDataToNavigationDataFilter ( )
overrideprotected

Definition at line 25 of file mitkNavigationDataToNavigationDataFilter.cpp.

Member Function Documentation

◆ ConnectTo()

void mitk::NavigationDataToNavigationDataFilter::ConnectTo ( mitk::NavigationDataSource UpstreamFilter)
virtual

Connects the input of this filter to the outputs of the given NavigationDataSource.

This method does not support smartpointer. use FilterX.GetPointer() to retrieve a dumbpointer. E.g. calling Filter2->ConnectTo(Filter1) will result in a Pipeline where NavigationData flows from Filter1 to Filter2.

Definition at line 83 of file mitkNavigationDataToNavigationDataFilter.cpp.

References mitk::NavigationDataSource::GetOutput(), and SetInput().

◆ CreateOutputsForAllInputs()

void mitk::NavigationDataToNavigationDataFilter::CreateOutputsForAllInputs ( )
protected

Create an output for each input.

This Method sets the number of outputs to the number of inputs and creates missing outputs objects.

Warning
any additional outputs that exist before the method is called are deleted

Definition at line 92 of file mitkNavigationDataToNavigationDataFilter.cpp.

References mitk::NavigationDataSource::GetOutput(), and mitk::NavigationData::New().

Referenced by mitk::NavigationDataSmoothingFilter::GenerateData(), mitk::NavigationDataTransformFilter::GenerateData(), mitk::NavigationDataEvaluationFilter::GenerateData(), mitk::NavigationDataLandmarkTransformFilter::GenerateData(), mitk::NavigationDataVisualizationFilter::SetInput(), and SetInput().

◆ GetInput() [1/3]

◆ GetInput() [2/3]

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

Get the input with id idx of this filter.

Definition at line 55 of file mitkNavigationDataToNavigationDataFilter.cpp.

◆ GetInput() [3/3]

const mitk::NavigationData * mitk::NavigationDataToNavigationDataFilter::GetInput ( std::string  navDataName) const

Get the input with name navDataName of this filter.

Definition at line 64 of file mitkNavigationDataToNavigationDataFilter.cpp.

◆ GetInputIndex()

itk::ProcessObject::DataObjectPointerArraySizeType mitk::NavigationDataToNavigationDataFilter::GetInputIndex ( std::string  navDataName)

return the index of the input with name navDataName, throw std::invalid_argument exception if that name was not found

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

Definition at line 74 of file mitkNavigationDataToNavigationDataFilter.cpp.

◆ mitkClassMacro()

mitk::NavigationDataToNavigationDataFilter::mitkClassMacro ( NavigationDataToNavigationDataFilter  ,
NavigationDataSource   
)

◆ SetInput() [1/2]

void mitk::NavigationDataToNavigationDataFilter::SetInput ( const NavigationData nd)
virtual

Set the input of this filter.

Warning
: this will set the number of outputs to the number of inputs, deleting any extra outputs that might have been initialized. Subclasses that have a different number of outputs than inputs must overwrite the SetInput methods.

Reimplemented in mitk::NavigationDataVisualizationFilter.

Definition at line 30 of file mitkNavigationDataToNavigationDataFilter.cpp.

Referenced by ConnectTo().

◆ SetInput() [2/2]

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

Set input with id idx of this filter.

Warning
: this will set the number of outputs to the number of inputs, deleting any extra outputs that might have been initialized. Subclasses that have a different number of outputs than inputs must overwrite the SetInput methods. If the last input is set to nullptr, the number of inputs will be decreased by one (-> removing the last input). If other inputs are set to nullptr, the number of inputs will not change.

Reimplemented in mitk::NavigationDataVisualizationFilter.

Definition at line 36 of file mitkNavigationDataToNavigationDataFilter.cpp.

References CreateOutputsForAllInputs().


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