IGSTK
|
Provides support for the Ascension 3D Guidance trackers. More...
#include <igstkAscension3DGTracker.h>
Public Member Functions | |
igstkStandardClassTraitsMacro (Ascension3DGTracker, Tracker) virtual unsigned int GetNumberOfTools() | |
Macro with standard traits declarations. | |
void | RequestSensorAttached (int sensorID) |
Request whether the particular sensor (0 based), is attached. | |
void | RequestTransmitterAttached () |
Request whether a transmitter, is attached. | |
void | RequestSensorSaturated (int sensorID) |
Request whether the particular sensor (0 based), is too close to the magnetic transmitter and is saturated. | |
void | RequestSensorInMotionBox (int sensorID) |
Request whether the particular sensor (0 based), is outside of the tracking motion box. | |
Protected Types | |
typedef Tracker::ResultType | ResultType |
typedef for internal boolean return type | |
Protected Member Functions | |
Ascension3DGTracker (void) | |
protected constructor | |
virtual | ~Ascension3DGTracker (void) |
virtual ResultType | InternalOpen (void) |
Open communication with the tracking device. | |
virtual ResultType | InternalClose (void) |
Close communication with the tracking device. | |
virtual ResultType | InternalStartTracking (void) |
Put the tracking device into tracking mode. | |
virtual ResultType | InternalStopTracking (void) |
Take the tracking device out of tracking mode. | |
virtual ResultType | InternalUpdateStatus (void) |
Update the status and the transforms for all TrackerTools. | |
virtual ResultType | InternalThreadedUpdateStatus (void) |
Update the status and the transforms. | |
virtual ResultType | VerifyTrackerToolInformation (const TrackerToolType *trackerTool) |
Verify tracker tool information. | |
virtual ResultType | ValidateSpecifiedFrequency (double frequencyInHz) |
Verify the specified tracker measurement frequency. | |
virtual ResultType | AddTrackerToolToInternalDataContainers (const TrackerToolType *trackerTool) |
Add tracker tool entry from internal containers. | |
virtual ResultType | RemoveTrackerToolFromInternalDataContainers (const TrackerToolType *trackerTool) |
Remove tracker tool from internal containers. | |
virtual ResultType | InternalReset (void) |
Reset the tracking device to put it back to its original state. | |
virtual void | PrintSelf (std::ostream &os,::itk::Indent indent) const |
Print object information. |
Provides support for the Ascension 3D Guidance trackers.
This class provides an interface to Ascension Technology Corporation's 3D Guidance family of magnetic trackers.
Events are provided that can be used to monitor the status of the tracker. These include notifications when sensors are attached or detached, when a sensor is too close or too far away from the magnetic transmitter, and if the magnetic transmitter is unplugged. At startup the state of the system can be querried with the Request methods. After the initial state is learned, changes can be monitored by setting up an observer for Ascension3DGToolEvent events.
Definition at line 86 of file igstkAscension3DGTracker.h.
typedef Tracker::ResultType igstk::Ascension3DGTracker::ResultType [protected] |
typedef for internal boolean return type
Reimplemented from igstk::Tracker.
Definition at line 135 of file igstkAscension3DGTracker.h.
igstk::Ascension3DGTracker::Ascension3DGTracker | ( | void | ) | [protected] |
protected constructor
virtual igstk::Ascension3DGTracker::~Ascension3DGTracker | ( | void | ) | [protected, virtual] |
igstk::Ascension3DGTracker::igstkStandardClassTraitsMacro | ( | Ascension3DGTracker | , |
Tracker | |||
) |
Macro with standard traits declarations.
Get the number of tools that have been detected.
void igstk::Ascension3DGTracker::RequestSensorAttached | ( | int | sensorID | ) |
Request whether the particular sensor (0 based), is attached.
An Ascension3DGToolEvent event will be sent. The tracker must have already been initialized with RequestOpen(). It is intended that this method be called on application startup to learn the initial state of the tracker system. After that, an observer can be set up to monitor Ascension3DGToolEvents for changes to the system.
void igstk::Ascension3DGTracker::RequestTransmitterAttached | ( | ) |
Request whether a transmitter, is attached.
An Ascension3DGToolEvent event will be sent. The tracker must have already been initialized with RequestOpen(). It is intended that this method be called on application startup to learn the initial state of the tracker system. After that, an observer can be set up to monitor Ascension3DGToolEvents for changes to the system.
void igstk::Ascension3DGTracker::RequestSensorSaturated | ( | int | sensorID | ) |
Request whether the particular sensor (0 based), is too close to the magnetic transmitter and is saturated.
An Ascension3DGToolEvent event will be sent. The tracker must have already been initialized with RequestOpen(). It is intended that this method be called on application startup to learn the initial state of the tracker system. After that, an observer can be set up to monitor Ascension3DGToolEvents for changes to the system.
void igstk::Ascension3DGTracker::RequestSensorInMotionBox | ( | int | sensorID | ) |
Request whether the particular sensor (0 based), is outside of the tracking motion box.
An Ascension3DGToolEvent event will be sent. The tracker must have already been initialized with RequestOpen(). It is intended that this method be called on application startup to learn the initial state of the tracker system. After that, an observer can be set up to monitor Ascension3DGToolEvents for changes to the system.
virtual ResultType igstk::Ascension3DGTracker::InternalOpen | ( | void | ) | [protected, virtual] |
Open communication with the tracking device.
Implements igstk::Tracker.
virtual ResultType igstk::Ascension3DGTracker::InternalClose | ( | void | ) | [protected, virtual] |
Close communication with the tracking device.
Implements igstk::Tracker.
virtual ResultType igstk::Ascension3DGTracker::InternalStartTracking | ( | void | ) | [protected, virtual] |
Put the tracking device into tracking mode.
Implements igstk::Tracker.
virtual ResultType igstk::Ascension3DGTracker::InternalStopTracking | ( | void | ) | [protected, virtual] |
Take the tracking device out of tracking mode.
Implements igstk::Tracker.
virtual ResultType igstk::Ascension3DGTracker::InternalUpdateStatus | ( | void | ) | [protected, virtual] |
Update the status and the transforms for all TrackerTools.
Implements igstk::Tracker.
virtual ResultType igstk::Ascension3DGTracker::InternalThreadedUpdateStatus | ( | void | ) | [protected, virtual] |
Update the status and the transforms.
This function is called by a separate thread.
Implements igstk::Tracker.
virtual ResultType igstk::Ascension3DGTracker::VerifyTrackerToolInformation | ( | const TrackerToolType * | trackerTool | ) | [protected, virtual] |
Verify tracker tool information.
Implements igstk::Tracker.
virtual ResultType igstk::Ascension3DGTracker::ValidateSpecifiedFrequency | ( | double | frequencyInHz | ) | [protected, virtual] |
Verify the specified tracker measurement frequency.
Reimplemented from igstk::Tracker.
virtual ResultType igstk::Ascension3DGTracker::AddTrackerToolToInternalDataContainers | ( | const TrackerToolType * | trackerTool | ) | [protected, virtual] |
Add tracker tool entry from internal containers.
Implements igstk::Tracker.
virtual ResultType igstk::Ascension3DGTracker::RemoveTrackerToolFromInternalDataContainers | ( | const TrackerToolType * | trackerTool | ) | [protected, virtual] |
Remove tracker tool from internal containers.
Implements igstk::Tracker.
virtual ResultType igstk::Ascension3DGTracker::InternalReset | ( | void | ) | [protected, virtual] |
Reset the tracking device to put it back to its original state.
Implements igstk::Tracker.
virtual void igstk::Ascension3DGTracker::PrintSelf | ( | std::ostream & | os, |
::itk::Indent | indent | ||
) | const [protected, virtual] |
Print object information.