IGSTK
Public Member Functions | List of all members
igstk::PolarisTracker Class Reference

Provides support for the Polaris optical tracker. More...

#include <igstkPolarisTracker.h>

Inheritance diagram for igstk::PolarisTracker:
Inheritance graph
[legend]
Collaboration diagram for igstk::PolarisTracker:
Collaboration graph
[legend]

Public Member Functions

virtual ResultType VerifyTrackerToolInformation (const TrackerToolType *)
 Verify tracker tool information. More...
 
virtual ResultType ValidateSpecifiedFrequency (double frequencyInHz)
 The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the tracking device that is being used. More...
 
virtual void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print object information. More...
 
- Public Member Functions inherited from igstk::Tracker
void RequestOpen (void)
 The "RequestOpen" method attempts to open communication with the tracking device. More...
 
void RequestClose (void)
 The "RequestClose" method closes communication with the device. More...
 
void RequestReset (void)
 The "RequestReset" tracker method should be used to bring the tracker to some defined default state. More...
 
void RequestStartTracking (void)
 The "RequestStartTracking" method readies the tracker for tracking the tools connected to the tracker. More...
 
void RequestStopTracking (void)
 The "RequestStopTracking" stops tracker from tracking the tools. More...
 
void RequestSetFrequency (double frequencyInHz)
 The "RequestSetFrequency" method defines the frequency at which the Transform information will be queried from the Tracker device. More...
 
void RequestSetReferenceTool (TrackerToolType *trackerTool)
 Set a reference tracker tool. More...
 
virtual void SetThreadingEnabled (bool _arg)
 SetThreadingEnabled(bool) : set m_ThreadingEnabled value. More...
 
virtual bool GetThreadingEnabled ()
 GetThreadingEnabled(bool) : get m_ThreadingEnabled value. More...
 
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
 
void SetLogger (LoggerType *logger)
 Connect the Logger for this class. More...
 
void RemoveObserver (unsigned long tag) const
 

Additional Inherited Members

- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs. More...
 
typedef ::itk::Object Superclass
 
typedef ::itk::SmartPointer< SelfPointer
 
typedef ::itk::SmartPointer
< const Self
ConstPointer
 
typedef igstk::Logger LoggerType
 
- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
 
- Public Attributes inherited from igstk::Tracker
igstkStandardAbstractClassTraitsMacro(Tracker,
Object) public typedef
TrackerTool 
TrackerToolType
 Macro with standard traits declarations. More...
 
- Protected Types inherited from igstk::NDITracker
typedef
igstk::NDICommandInterpreter 
CommandInterpreterType
 typedef for command interpreter More...
 
typedef Tracker::ResultType ResultType
 typedef for internal boolean return type More...
 
- Protected Types inherited from igstk::Tracker
enum  ResultType { FAILURE =0, SUCCESS }
 
typedef Transform::TimePeriodType TimePeriodType
 typedef for times used by the tracker More...
 
typedef Transform TransformType
 typedefs from Transform class More...
 
typedef std::map< std::string,
TrackerToolType * > 
TrackerToolsContainerType
 typedefs from TrackerTool class More...
 
- Protected Member Functions inherited from igstk::NDITracker
 NDITracker (void)
 
virtual ~NDITracker (void)
 
virtual ResultType InternalOpen (void)
 Open communication with the tracking device. More...
 
virtual ResultType InternalClose (void)
 Close communication with the tracking device. More...
 
virtual ResultType InternalStartTracking (void)
 Put the tracking device into tracking mode. More...
 
virtual ResultType InternalStopTracking (void)
 Take the tracking device out of tracking mode. More...
 
virtual ResultType InternalUpdateStatus (void)
 Update the status and the transforms for all TrackerTools. More...
 
virtual ResultType InternalThreadedUpdateStatus (void)
 Update the status and the transforms. More...
 
virtual ResultType InternalReset (void)
 Reset the tracking device to put it back to its original state. More...
 
virtual ResultType RemoveTrackerToolFromInternalDataContainers (const TrackerToolType *trackerTool)
 Remove tracker tool entry from internal containers. More...
 
virtual ResultType AddTrackerToolToInternalDataContainers (const TrackerToolType *trackerTool)
 Add tracker tool entry to internal containers. More...
 
CommandInterpreterType::Pointer GetCommandInterpreter () const
 Get method for the command interpreter This will method will be used by the derived classes. More...
 
ResultType CheckError (CommandInterpreterType *) const
 Helper function for reporting interpreter errors. More...
 
virtual void SetPortHandleToBeAdded (int _arg)
 Set port handle to be added. More...
 
- Protected Member Functions inherited from igstk::Tracker
 Tracker (void)
 
virtual ~Tracker (void)
 
virtual TimePeriodType GetValidityTime ()
 Get the validity time. More...
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream. More...
 
const TrackerToolsContainerTypeGetTrackerToolContainer () const
 Access method for the tracker tool container. More...
 
void ReportTrackingToolNotAvailable (TrackerToolType *trackerTool) const
 Report to tracker tool that it is not available for tracking. More...
 
void ReportTrackingToolVisible (TrackerToolType *trackerTool) const
 Report to tracker tool that it is visible. More...
 
void SetTrackerToolRawTransform (TrackerToolType *trackerTool, const TransformType transform)
 Set tracker tool raw transform. More...
 
void SetTrackerToolTransformUpdate (TrackerToolType *trackerTool, bool flag) const
 Turn on/off update flag of the tracker tool. More...
 
void ExitTrackingStateProcessing (void)
 Depending on the tracker type, the tracking thread should be terminated or left untouched when we stop tracking. More...
 
void ExitTrackingWithoutTerminatingTrackingThread ()
 Exit tracking without terminating tracking thread. More...
 
void ExitTrackingTerminatingTrackingThread ()
 Exit tracking after terminating tracking thread. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
virtual ~Object (void)
 
void RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
 Register observed objects in an internal array so that they can be disconnected upon destruction. More...
 
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects. More...
 

Detailed Description

Provides support for the Polaris optical tracker.

This class provides an interface to the Polaris line of optical tracking systems, including the Vicra and the Spectra. These devices are manufactured by Northern Digital Inc. of Waterloo, Ontario, Canada.

Tracking of the silvered markers individually is not possible, the markers must be configured as a tool before they can be tracked.

Definition at line 43 of file igstkPolarisTracker.h.

Member Function Documentation

virtual ResultType igstk::PolarisTracker::VerifyTrackerToolInformation ( const TrackerToolType )
virtual

Verify tracker tool information.

Implements igstk::NDITracker.

virtual ResultType igstk::PolarisTracker::ValidateSpecifiedFrequency ( double  frequencyInHz)
virtual

The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the tracking device that is being used.

Reimplemented from igstk::NDITracker.

virtual void igstk::PolarisTracker::PrintSelf ( std::ostream &  os,
::itk::Indent  indent 
) const
virtual

Print object information.

Reimplemented from igstk::NDITracker.


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