MITK-IGT
IGT Extension of MITK
Loading...
Searching...
No Matches
mitk::TrackingVolumeGenerator Class Reference

An instance of this class represents a generator wich generates the tracking volume of a given tracking device as a mitk:Surface. More...

#include <mitkTrackingVolumeGenerator.h>

Inheritance diagram for mitk::TrackingVolumeGenerator:

Public Member Functions

 mitkClassMacro (TrackingVolumeGenerator, mitk::SurfaceSource)
 
 itkFactorylessNewMacro (Self)
 
 itkCloneMacro (Self)
 
void SetTrackingDeviceType (mitk::TrackingDeviceType deviceType)
 Deprecated! Use set DeviceData instead. Sets the tracking device type of the volume. Warning: there are different possible volumes for some device types. In this case a default volume is chosen automatically. All tracking volumes are defined by TrackingDeviceData objects (see file mitkTrackingTypes.h) for a list.
 
mitk::TrackingDeviceType GetTrackingDeviceType () const
 
void SetTrackingDeviceData (mitk::TrackingDeviceData deviceData)
 Sets the tracking device data object which will be used to generate the volume. Each tracking device data object has an unambiguous assignment to a tracking volume. See file mitkTrackingTypes.h for a list of all availiable object.
 
mitk::TrackingDeviceData GetTrackingDeviceData () const
 
void SetTrackingDevice (mitk::TrackingDevice::Pointer tracker)
 Deprecated! Use set DeviceData instead. Sets the tracking device type of the volume. After doing this the tracking volume gets generated and is set to the correct dimensions in the correct coordinate system. The TV of a VirtualTrackingDevice is always a 400*400 cube.
 

Protected Member Functions

 TrackingVolumeGenerator ()
 
void GenerateData () override
 

Protected Attributes

mitk::TrackingDeviceData m_Data
 Holds the current tracking device data object, which is used to generate the volume.
 

Detailed Description

An instance of this class represents a generator wich generates the tracking volume of a given tracking device as a mitk:Surface.

Documentation

To generate the specific dimensions of the tracking volume of a tracking device the methods SetTrackingDeviceType(trackingdevicetype) or SetTrackingDevice (tracker) have to be called first. Otherwise the TrackingDeviceType is set to "TrackingSystemNotSpecified". After setting the trackingdevice type, the update() method has to be called. Now the method GetOutput() delivers the generatet TrackingVolume as mitk:Surface

The coordinate system of die TrackingVolume is the same as the coordination system of the tracking device.

For tracking devices that have a modifiable tracking volume (e.g. VirtualTrackingDevice, this class produces a tracking volume with default values.

Definition at line 43 of file mitkTrackingVolumeGenerator.h.

Constructor & Destructor Documentation

◆ TrackingVolumeGenerator()

mitk::TrackingVolumeGenerator::TrackingVolumeGenerator ( )
protected

Definition at line 96 of file mitkTrackingVolumeGenerator.cpp.

Member Function Documentation

◆ GenerateData()

void mitk::TrackingVolumeGenerator::GenerateData ( )
overrideprotected

Definition at line 113 of file mitkTrackingVolumeGenerator.cpp.

◆ GetTrackingDeviceData()

mitk::TrackingDeviceData mitk::TrackingVolumeGenerator::GetTrackingDeviceData ( ) const
Returns
Returns the current tracking device data of the generator. See file mitkTrackingTypes.h for the definition of tracking device data objects.

Definition at line 187 of file mitkTrackingVolumeGenerator.cpp.

◆ GetTrackingDeviceType()

mitk::TrackingDeviceType mitk::TrackingVolumeGenerator::GetTrackingDeviceType ( ) const
Returns
Returns the tracking device type of the current device. Warning: there are different possible volumes for some device types. Use GetTrackingDeviceData to get a unambiguous assignment to a tracking volume.

Definition at line 177 of file mitkTrackingVolumeGenerator.cpp.

◆ itkCloneMacro()

mitk::TrackingVolumeGenerator::itkCloneMacro ( Self )

◆ itkFactorylessNewMacro()

mitk::TrackingVolumeGenerator::itkFactorylessNewMacro ( Self )

◆ mitkClassMacro()

mitk::TrackingVolumeGenerator::mitkClassMacro ( TrackingVolumeGenerator ,
mitk::SurfaceSource  )

◆ SetTrackingDevice()

void mitk::TrackingVolumeGenerator::SetTrackingDevice ( mitk::TrackingDevice::Pointer tracker)

Deprecated! Use set DeviceData instead. Sets the tracking device type of the volume. After doing this the tracking volume gets generated and is set to the correct dimensions in the correct coordinate system. The TV of a VirtualTrackingDevice is always a 400*400 cube.

Parameters
trackerThe tracking device the tracking volume has to be created for (currently supported: NDIAurora, NDIPolaris, ClaronMicron, IntuitiveDaVinci and the VirtualTracker; see file mitkTrackingTypes.h for a always up to date list).

Definition at line 101 of file mitkTrackingVolumeGenerator.cpp.

◆ SetTrackingDeviceData()

void mitk::TrackingVolumeGenerator::SetTrackingDeviceData ( mitk::TrackingDeviceData deviceData)

Sets the tracking device data object which will be used to generate the volume. Each tracking device data object has an unambiguous assignment to a tracking volume. See file mitkTrackingTypes.h for a list of all availiable object.

Definition at line 182 of file mitkTrackingVolumeGenerator.cpp.

◆ SetTrackingDeviceType()

void mitk::TrackingVolumeGenerator::SetTrackingDeviceType ( mitk::TrackingDeviceType deviceType)

Deprecated! Use set DeviceData instead. Sets the tracking device type of the volume. Warning: there are different possible volumes for some device types. In this case a default volume is chosen automatically. All tracking volumes are defined by TrackingDeviceData objects (see file mitkTrackingTypes.h) for a list.

After setting the device type the tracking volume gets generated (by a default volume for this type as mentioned above) and set to the correct dimensions in the correct coordinate system. The TV of a VirtualTrackingDevice is always a 400*400 cube.

Parameters
deviceTypeThe type of the tracking device (currently supported:NDIAurora, NDIPolaris, ClaronMicron, IntuitiveDaVinci and the VirtualTracker; see file mitkTrackingTypes.h for a always up to date list).

Definition at line 165 of file mitkTrackingVolumeGenerator.cpp.

Member Data Documentation

◆ m_Data

mitk::TrackingDeviceData mitk::TrackingVolumeGenerator::m_Data
protected

Holds the current tracking device data object, which is used to generate the volume.

Definition at line 97 of file mitkTrackingVolumeGenerator.h.


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