Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
Protected Attributes |
List of all members
mitk::NavigationDataDisplacementFilter Class Reference
NavigationDataDisplacementFilter adds an offset to navigation data objects. More...
#include <mitkNavigationDataDisplacementFilter.h>
Inheritance diagram for mitk::NavigationDataDisplacementFilter:
Collaboration diagram for mitk::NavigationDataDisplacementFilter:
Public Member Functions | |
| mitkClassMacro (NavigationDataDisplacementFilter, NavigationDataToNavigationDataFilter) | |
| Pointer | Clone () const |
| mitkSetVectorMacro (Offset, mitk::Vector3D) | |
| Get Offset parameter. More... | |
| mitkGetVectorMacro (Offset, mitk::Vector3D) | |
| Set Offset parameter. More... | |
| virtual void | SetTransform6DOF (bool _arg) |
| virtual bool | GetTransform6DOF () |
| void | SetTransformation (mitk::AffineTransform3D::Pointer transform) |
| void | SetParameters (const mitk::PropertyList *p) override |
| Set all filter parameters (Offset) as the PropertyList p. More... | |
| mitk::PropertyList::ConstPointer | GetParameters () const override |
| Get all filter parameters (offset) as a PropertyList. More... | |
 Public Member Functions inherited from mitk::NavigationDataToNavigationDataFilter | |
| 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 NavigationData * | GetInput (void) const |
| Get the input of this filter. More... | |
| const NavigationData * | GetInput (unsigned int idx) const |
| Get the input with id idx of this filter. More... | |
| const NavigationData * | GetInput (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... | |
| NavigationData * | GetOutput (void) |
| return the output (output with id 0) of the filter More... | |
| NavigationData * | GetOutput (DataObjectPointerArraySizeType idx) |
| return the output with id idx of the filter More... | |
| NavigationData * | GetOutput (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 | Freeze () |
| virtual void | UnFreeze () |
| virtual bool | GetIsFrozen () |
Static Public Member Functions | |
| static Pointer | New () |
Protected Member Functions | |
| NavigationDataDisplacementFilter () | |
| ~NavigationDataDisplacementFilter () override | |
| void | GenerateData () override |
| filter execute method More... | |
| Protected Member Functions inherited from mitk::NavigationDataToNavigationDataFilter | |
| NavigationDataToNavigationDataFilter () | |
| ~NavigationDataToNavigationDataFilter () override | |
| void | CreateOutputsForAllInputs () |
| Create an output for each input. More... | |
| Protected Member Functions inherited from mitk::NavigationDataSource | |
| NavigationDataSource () | |
| ~NavigationDataSource () override | |
Protected Attributes | |
| mitk::Vector3D | m_Offset |
| offset that is added to all inputs More... | |
| bool | m_Transform6DOF |
| mitk::NavigationData::Pointer | m_Transformation |
| Protected Attributes inherited from mitk::NavigationDataSource | |
| std::string | m_Name |
| bool | m_IsFrozen |
| NavigationToolStorage::Pointer | m_ToolMetaDataCollection |
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 |
Detailed Description
NavigationDataDisplacementFilter adds an offset to navigation data objects.
Documentation Example class that shows how to write a navigation filter. This filter adds a offset that can be specified as a parameter to each input navigation data.
Definition at line 29 of file mitkNavigationDataDisplacementFilter.h.
Constructor & Destructor Documentation
◆ NavigationDataDisplacementFilter()
|
protected |
◆ ~NavigationDataDisplacementFilter()
|
overrideprotected |
Member Function Documentation
◆ Clone()
| Pointer mitk::NavigationDataDisplacementFilter::Clone | ( | ) | const |
◆ GenerateData()
|
overrideprotected |
filter execute method
Documentation adds the offset m_Offset to all inputs
◆ GetParameters()
|
overridevirtual |
Get all filter parameters (offset) as a PropertyList.
This method returns a PropertyList containing the following properties (name : data type):
- "NavigationDataDisplacementFilter_Offset" : mitk::Vector3DProperty The returned PropertyList must be assigned to a SmartPointer immediately, or else it will get destroyed.
Reimplemented from mitk::NavigationDataSource.
◆ GetTransform6DOF()
|
virtual |
◆ mitkClassMacro()
| mitk::NavigationDataDisplacementFilter::mitkClassMacro | ( | NavigationDataDisplacementFilter | , |
| NavigationDataToNavigationDataFilter | |||
| ) |
◆ mitkGetVectorMacro()
| mitk::NavigationDataDisplacementFilter::mitkGetVectorMacro | ( | Offset | , |
| mitk::Vector3D | |||
| ) |
Set Offset parameter.
◆ mitkSetVectorMacro()
| mitk::NavigationDataDisplacementFilter::mitkSetVectorMacro | ( | Offset | , |
| mitk::Vector3D | |||
| ) |
Get Offset parameter.
◆ New()
|
static |
◆ SetParameters()
|
overridevirtual |
Set all filter parameters (Offset) as the PropertyList p.
This method reads the following properties from the PropertyList (name : data type):
- "NavigationDataDisplacementFilter_Offset" : mitk::Vector3DProperty
Reimplemented from mitk::NavigationDataSource.
◆ SetTransform6DOF()
|
virtual |
◆ SetTransformation()
| void mitk::NavigationDataDisplacementFilter::SetTransformation | ( | mitk::AffineTransform3D::Pointer | transform | ) |
Member Data Documentation
◆ m_Offset
|
protected |
offset that is added to all inputs
Definition at line 72 of file mitkNavigationDataDisplacementFilter.h.
◆ m_Transform6DOF
|
protected |
Definition at line 74 of file mitkNavigationDataDisplacementFilter.h.
◆ m_Transformation
|
protected |
Definition at line 76 of file mitkNavigationDataDisplacementFilter.h.
The documentation for this class was generated from the following file:
