niftk::NDITracker Class Reference

Base class for NifTK interfaces to NDI trackers. More...

Inheritance diagram for niftk::NDITracker:

Collaboration diagram for niftk::NDITracker:

Public Member Functions
	mitkClassMacroItkParent (NDITracker, itk::Object) virtual int GetPreferredFramesPerSecond()
virtual std::map< std::string, vtkSmartPointer< vtkMatrix4x4 > >	GetTrackingData ()=0
	Retrives the current tracking data. More...
void	SetVisibilityOfTrackingVolume (bool isVisible)
	Set the tracking volume visible or invisible. More...
bool	GetVisibilityOfTrackingVolume () const
	Get the visibility flag for the tracking volume. More...

Protected Member Functions
	NDITracker (mitk::DataStorage::Pointer dataStorage, std::string portName, mitk::TrackingDeviceData deviceData, std::string toolConfigFileName, int preferredFramesPerSecond)
virtual	~NDITracker ()
	NDITracker (const NDITracker &)
NDITracker &	operator= (const NDITracker &)

Protected Attributes
mitk::DataStorage::Pointer	m_DataStorage
std::string	m_PortName
mitk::TrackingDeviceData	m_DeviceData
std::string	m_ToolConfigFileName
int	m_PreferredFramesPerSecond
mitk::NavigationToolStorage::Pointer	m_NavigationToolStorage
mitk::TrackingVolumeGenerator::Pointer	m_TrackingVolumeGenerator
mitk::DataNode::Pointer	m_TrackingVolumeNode

Detailed Description

Base class for NifTK interfaces to NDI trackers.

The main design point is that tracking starts during the constructor, and stops during the destructor. All errors are thrown as mitk::Exception. Then you repeatedly call GetTrackingData(). This class does not do threading. It is assumed that the calling client can manage buffers of matrices, threading etc. This thing just grabs the latest tracking matrices each time you you call GetTrackingData().

Constructor & Destructor Documentation

niftk::NDITracker::NDITracker ( mitk::DataStorage::Pointer  dataStorage, std::string  portName, mitk::TrackingDeviceData  deviceData, std::string  toolConfigFileName, int  preferredFramesPerSecond  )

protected

niftk::NDITracker::~NDITracker ( )

protectedvirtual

niftk::NDITracker::NDITracker ( const NDITracker &  )

protected

Member Function Documentation

virtual std::map<std::string, vtkSmartPointer<vtkMatrix4x4> > niftk::NDITracker::GetTrackingData ( )

pure virtual

Retrives the current tracking data.

Returns

map of tool-name and tracking matrix.

Given that errors are thrown during construction, (like RAII pattern), then once the constructor is complete we can assume that the tracker is valid.

Therefore we repeated call this method. If a tool is not visible, nothing for that tool will be returned. So, this will return a varying number of items, depending on how many tools are visible to the tracker. So zero items returned is a valid output.

bool niftk::NDITracker::GetVisibilityOfTrackingVolume

(

)

const

Get the visibility flag for the tracking volume.

niftk::NDITracker::mitkClassMacroItkParent	(	NDITracker	,
		itk::Object
	)

NDITracker& niftk::NDITracker::operator= ( const NDITracker &  )

protected

void niftk::NDITracker::SetVisibilityOfTrackingVolume

(

bool

isVisible

)

Set the tracking volume visible or invisible.

Each tracker loads a tracking volume for visualisation purposes.

Member Data Documentation

mitk::DataStorage::Pointer niftk::NDITracker::m_DataStorage

protected

mitk::TrackingDeviceData niftk::NDITracker::m_DeviceData

protected

mitk::NavigationToolStorage::Pointer niftk::NDITracker::m_NavigationToolStorage

protected

std::string niftk::NDITracker::m_PortName

protected

int niftk::NDITracker::m_PreferredFramesPerSecond

protected

std::string niftk::NDITracker::m_ToolConfigFileName

protected

mitk::TrackingVolumeGenerator::Pointer niftk::NDITracker::m_TrackingVolumeGenerator

protected

mitk::DataNode::Pointer niftk::NDITracker::m_TrackingVolumeNode

protected

---

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

• niftkNDITracker.h
• niftkNDITracker.cxx