Medical Imaging Interaction Toolkit  2021.02.99-19049835
Medical Imaging Interaction Toolkit
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:
Collaboration diagram for mitk::TrackingVolumeGenerator:

Public Member Functions

 mitkClassMacro (TrackingVolumeGenerator, mitk::SurfaceSource)
 
Pointer Clone () const
 
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. More...
 
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. More...
 
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. More...
 
- Public Member Functions inherited from mitk::SurfaceSource
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
- Public Member Functions inherited from mitk::BaseDataSource
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Access itk::ProcessObject::m_Updating. More...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::SurfaceSource
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 TrackingVolumeGenerator ()
 
void GenerateData () override
 
- Protected Member Functions inherited from mitk::SurfaceSource
 SurfaceSource ()
 
 ~SurfaceSource () override
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Protected Attributes

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

Additional Inherited Members

- Public Types inherited from mitk::SurfaceSource
typedef SurfaceSource Self
 
typedef BaseDataSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Surface OutputType
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 
- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

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

Member Function Documentation

◆ Clone()

Pointer mitk::TrackingVolumeGenerator::Clone ( ) const

◆ GenerateData()

void mitk::TrackingVolumeGenerator::GenerateData ( )
overrideprotected

◆ 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.

◆ 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.

◆ mitkClassMacro()

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

◆ New()

static Pointer mitk::TrackingVolumeGenerator::New ( )
static

◆ 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).

◆ 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.

◆ 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).

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 file: