Loading...
Searching...
No Matches
mitk::OpenIGTLinkTrackingTool Class Reference
An object of this class represents a OpenIGTLink tracking tool. A tool has to be added to a tracking device which will then continuously update the tool coordinates. More...
#include <mitkOpenIGTLinkTrackingTool.h>
Inheritance diagram for mitk::OpenIGTLinkTrackingTool:
Public Member Functions | |
| mitkClassMacro (OpenIGTLinkTrackingTool, TrackingTool) | |
| itkFactorylessNewMacro(Self) protected | ~OpenIGTLinkTrackingTool () override |
 Public Member Functions inherited from mitk::TrackingTool | |
| mitkClassMacroItkParent (TrackingTool, itk::Object) | |
| itkFactorylessNewMacro (Self) | |
| itkCloneMacro (Self) | |
| void | PrintSelf (std::ostream &os, itk::Indent indent) const override |
| virtual const char * | GetToolName () const |
| every tool has a name thatgit can be used to identify it. | |
| virtual void | SetToolName (const std::string _arg) |
| Sets the name of the tool. | |
| virtual void | SetToolName (const char *_arg) |
| Sets the name of the tool. | |
| Point3D | GetToolTipPosition () const |
| returns the tool tip in tool coordinates, which where set by SetToolTip | |
| Quaternion | GetToolAxisOrientation () const |
| returns the transformation of the tool axis with respect to the MITK-IGT main tool axis (0,0,-1) | |
| virtual void | SetToolTipPosition (Point3D toolTipPosition, Quaternion orientation, ScalarType eps=0.0) |
| defines a tool tip for this tool in tool coordinates. GetPosition() and GetOrientation() return the data of the tool tip if it is defined. By default no tooltip is defined. | |
| virtual bool | IsToolTipSet () const |
| returns true if a tool tip is set, false if not | |
| virtual void | GetPosition (Point3D &position) const |
| returns the current position of the tool as an array of three floats (in the tracking device coordinate system) | |
| virtual void | SetPosition (Point3D position) |
| sets the position | |
| virtual void | GetOrientation (Quaternion &orientation) const |
| returns the current orientation of the tool as a quaternion in a mitk::Point4D (in the tracking device coordinate system) | |
| virtual void | SetOrientation (Quaternion orientation) |
| sets the orientation as a quaternion | |
| virtual bool | Enable () |
| enables the tool, so that it will be tracked | |
| virtual bool | Disable () |
| disables the tool, so that it will not be tracked anymore | |
| virtual bool | IsEnabled () const |
| returns whether the tool is enabled or disabled | |
| virtual void | SetDataValid (bool isDataValid) |
| sets if the tracking data (position & orientation) is valid | |
| virtual bool | IsDataValid () const |
| returns true if the current position data is valid (no error during tracking, tracking error below threshold, ...) | |
| virtual float | GetTrackingError () const |
| returns one value that corresponds to the overall tracking error. | |
| virtual void | SetTrackingError (float error) |
| sets the tracking error | |
| virtual const char * | GetErrorMessage () const |
| if the data is not valid, ErrorMessage should contain a string explaining why it is invalid (the Set-method should be implemented in subclasses, it should not be accessible by the user) | |
| virtual void | SetErrorMessage (const char *_arg) |
| sets the error message | |
| itkSetMacro (IGTTimeStamp, double) itkGetConstMacro(IGTTimeStamp | |
Friends | |
| class | OpenIGTLinkTrackingTrackingDevice |
Additional Inherited Members | |
| Protected Member Functions inherited from mitk::TrackingTool | |
| TrackingTool () | |
| < Gets the IGT timestamp of the tracking tool object (time in milliseconds). Returns 0 if the timestamp was not set. | |
| ~TrackingTool () override | |
| Protected Attributes inherited from mitk::TrackingTool | |
| std::string | m_ToolName |
| every tool has a name that can be used to identify it. | |
| std::string | m_ErrorMessage |
| if a tool is invalid, this member should contain a human readable explanation of why it is invalid | |
| double | m_IGTTimeStamp |
| contains the time at which the tracking data was recorded | |
| std::mutex | m_MyMutex |
| mutex to control concurrent access to the tool | |
| Point3D | m_Position |
| holds the position of the tool in global tracking coordinates | |
| Quaternion | m_Orientation |
| holds the orientation of the tool´in global tracking coordinates | |
| float | m_TrackingError |
| holds the tracking error of the tool | |
| bool | m_Enabled |
| if true, tool is enabled and should receive tracking updates from the tracking device | |
| bool | m_DataValid |
| if true, data in m_Position and m_Orientation is valid, e.g. true tracking data | |
| Point3D | m_ToolTipPosition |
| holds the position of the tool tip in the coordinate system of the tracking sensor | |
| Quaternion | m_ToolAxisOrientation |
| holds the rotation of the sensor coordinate system such that the z-axis coincides with the main tool axis e.g. obtained by a tool calibration | |
| bool | m_ToolTipSet |
Detailed Description
An object of this class represents a OpenIGTLink tracking tool. A tool has to be added to a tracking device which will then continuously update the tool coordinates.
Documentation:
Definition at line 27 of file mitkOpenIGTLinkTrackingTool.h.
Constructor & Destructor Documentation
◆ ~OpenIGTLinkTrackingTool()
|
override |
Definition at line 22 of file mitkOpenIGTLinkTrackingTool.cpp.
Member Function Documentation
◆ mitkClassMacro()
| mitk::OpenIGTLinkTrackingTool::mitkClassMacro | ( | OpenIGTLinkTrackingTool | , |
| TrackingTool | ) |
Friends And Related Symbol Documentation
◆ OpenIGTLinkTrackingTrackingDevice
|
friend |
Definition at line 30 of file mitkOpenIGTLinkTrackingTool.h.
The documentation for this class was generated from the following files:
- Modules/IGT/TrackingDevices/mitkOpenIGTLinkTrackingTool.h
- Modules/IGT/TrackingDevices/mitkOpenIGTLinkTrackingTool.cpp
