Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
Protected Attributes |
List of all members
mitk::NeedleProjectionFilter Class Reference
This filter projects a needle's path onto a plane. More...
#include <mitkNeedleProjectionFilter.h>
Inheritance diagram for mitk::NeedleProjectionFilter:
Collaboration diagram for mitk::NeedleProjectionFilter:
Public Member Functions | |
| mitkClassMacro (NeedleProjectionFilter, NavigationDataPassThroughFilter) | |
| virtual void | SelectInput (int i) |
| virtual mitk::AffineTransform3D::Pointer | GetTargetPlane () |
| virtual void | SetTargetPlane (mitk::AffineTransform3D::Pointer _arg) |
| virtual mitk::PointSet::Pointer | GetProjection () |
| void | SetToolAxisForFilter (mitk::Point3D point) |
| void | ShowToolAxis (bool enabled) |
 Public Member Functions inherited from mitk::NavigationDataPassThroughFilter | |
| mitkClassMacro (NavigationDataPassThroughFilter, NavigationDataToNavigationDataFilter) | |
| 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 | 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 () |
Static Public Member Functions | |
| static Pointer | New () |
| Static Public Member Functions inherited from mitk::NavigationDataPassThroughFilter | |
| static Pointer | New () |
Protected Member Functions | |
| NeedleProjectionFilter () | |
| ~NeedleProjectionFilter () override | |
| void | GenerateData () override |
| void | InitializeOriginalPoints (mitk::Point3D toolAxis, bool showToolAxis) |
| mitk::AffineTransform3D::Pointer | NavigationDataToTransform (const mitk::NavigationData *nd) |
| Creates an Affine Transformation from a Navigation Data Object. More... | |
| mitk::Geometry3D::Pointer | TransformToGeometry (mitk::AffineTransform3D::Pointer transform) |
| Creates an Geometry 3D Object from an AffineTransformation. More... | |
| Protected Member Functions inherited from mitk::NavigationDataPassThroughFilter | |
| NavigationDataPassThroughFilter () | |
| ~NavigationDataPassThroughFilter () override | |
| void | GenerateData () override |
| Passes navigation data from all inputs to all outputs. If a subclass wants to implement its own version of the GenerateData() method it should call this method inside its implementation. 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::AffineTransform3D::Pointer | m_TargetPlane |
| mitk::PointSet::Pointer | m_Projection |
| mitk::PointSet::Pointer | m_OriginalPoints |
| bool | m_ShowToolAxis |
| mitk::Point3D | m_ToolAxis |
| int | m_SelectedInput |
| 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
This filter projects a needle's path onto a plane.
To use it, hook it up to a NavigationDataStream, select an input and set an AffineTransform 3D that represents the target plane. You can then call GetProjection to retrieve a pointset that represents the projected path. You may change the PointSet's properties, these changes will not be overwritten. If no Input is selected, the target Pointset will not update If no Target Plane is selected, The projection line will always be 40 cm long Any points you add to the pointSet will be overwritten during the next Update. The point with index zero is the Tip of the Needle. The Point with index one is the projection onto the plane.
Projection will happen onto an extension of the plane as well - the filter does not regard boundaries This Filter currently only supports projection of one needle. Extension to multiple needles / planes should be easy.
Definition at line 43 of file mitkNeedleProjectionFilter.h.
Constructor & Destructor Documentation
◆ NeedleProjectionFilter()
|
protected |
◆ ~NeedleProjectionFilter()
|
overrideprotected |
Member Function Documentation
◆ GenerateData()
|
overrideprotected |
◆ GetProjection()
|
virtual |
◆ GetTargetPlane()
|
virtual |
◆ InitializeOriginalPoints()
|
protected |
Internal method for initialization of the projection / tool axis representation by the point set m_OriginalPoints.
◆ mitkClassMacro()
| mitk::NeedleProjectionFilter::mitkClassMacro | ( | NeedleProjectionFilter | , |
| NavigationDataPassThroughFilter | |||
| ) |
◆ NavigationDataToTransform()
|
protected |
Creates an Affine Transformation from a Navigation Data Object.
◆ New()
|
static |
◆ SelectInput()
|
virtual |
◆ SetTargetPlane()
|
virtual |
◆ SetToolAxisForFilter()
| void mitk::NeedleProjectionFilter::SetToolAxisForFilter | ( | mitk::Point3D | point | ) |
Sets the tool axis for this filter. The default tool axis is along the z-axis in tool coordinates.
◆ ShowToolAxis()
| void mitk::NeedleProjectionFilter::ShowToolAxis | ( | bool | enabled | ) |
Sets whether the tool axis should be visualized. This is required if no surface is available. If disabled only the projection and not the axis is shown. It's disabled by default.
◆ TransformToGeometry()
|
protected |
Creates an Geometry 3D Object from an AffineTransformation.
Member Data Documentation
◆ m_OriginalPoints
|
protected |
Definition at line 70 of file mitkNeedleProjectionFilter.h.
◆ m_Projection
|
protected |
Definition at line 69 of file mitkNeedleProjectionFilter.h.
◆ m_SelectedInput
|
protected |
Definition at line 74 of file mitkNeedleProjectionFilter.h.
◆ m_ShowToolAxis
|
protected |
Definition at line 71 of file mitkNeedleProjectionFilter.h.
◆ m_TargetPlane
|
protected |
Definition at line 67 of file mitkNeedleProjectionFilter.h.
◆ m_ToolAxis
|
protected |
Definition at line 72 of file mitkNeedleProjectionFilter.h.
The documentation for this class was generated from the following file:
