PlusLib  2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes
vtkPlusUSDigitalEncodersTracker Class Reference
DataCollection

Interface for multiple US Digital A2, A2T, A4, HBA2, HBA4 or HD25A encoders to generate pose information of a target object. More...

#include <src/PlusDataCollection/USDigitalEncodersTracking/vtkPlusUSDigitalEncodersTracker.h>

Inheritance diagram for vtkPlusUSDigitalEncodersTracker:
Inheritance graph
[legend]
Collaboration diagram for vtkPlusUSDigitalEncodersTracker:
Collaboration graph
[legend]

Public Types

typedef vtkPlusDevice Superclass
 
- Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
PlusStatus GetUSDigitalA2EncoderModeWithID (long id, long *mode)
 
PlusStatus GetUSDigitalA2EncoderPositionWithID (long id, long *pos)
 
PlusStatus GetUSDigitalA2EncoderResoultionWithID (long id, long *res)
 
PlusStatus InternalConnect ()
 
virtual PlusStatus InternalDisconnect ()
 
PlusStatus InternalUpdate ()
 
virtual int IsA (const char *type)
 
virtual PlusStatus IsStepperAlive ()
 
bool IsTracker () const override
 
void operator= (const vtkPlusUSDigitalEncodersTracker &)=delete
 
void PrintSelf (ostream &os, vtkIndent indent)
 
PlusStatus Probe ()
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *config)
 
PlusStatus SetAllUSDigitalA2EncoderOrigin ()
 
PlusStatus SetUSDigitalA2EncoderModeWithID (long id, long mode)
 
PlusStatus SetUSDigitalA2EncoderOriginWithID (long id)
 
PlusStatus SetUSDigitalA2EncoderPositionWithID (long id, long pos)
 
PlusStatus SetUSDigitalA2EncoderResoultionWithID (long id, long res)
 
PlusStatus SetUSDigitalA2EncodersSleep ()
 
PlusStatus SetUSDigitalA2EncodersStrobeMode ()
 
PlusStatus SetUSDigitalA2EncodersWakeup ()
 
 vtkPlusUSDigitalEncodersTracker (const vtkPlusUSDigitalEncodersTracker &)=delete
 
virtual PlusStatus WriteConfiguration (vtkXMLDataElement *config)
 
- Public Member Functions inherited from vtkPlusDevice
PlusStatus AddFieldDataSource (vtkPlusDataSource *aSource)
 
PlusStatus AddInputChannel (vtkPlusChannel *aChannel)
 
PlusStatus AddOutputChannel (vtkPlusChannel *aChannel)
 
PlusStatus AddTool (vtkPlusDataSource *tool, bool requireUniquePortName=true)
 
PlusStatus AddVideoSource (vtkPlusDataSource *anImage)
 
void ClearAllBuffers ()
 
virtual PlusStatus Connect ()
 
virtual PlusStatus CreateDefaultOutputChannel (const char *channelId=NULL, bool addSource=true)
 
void DeepCopy (const vtkPlusDevice &device)
 
virtual PlusStatus Disconnect ()
 
virtual PlusStatus ForceUpdate ()
 
virtual double GetAcquisitionRate () const
 
virtual PlusStatus GetBufferSize (vtkPlusChannel &aChannel, int &outVal, const std::string &aSourceId=std::string(""))
 
virtual int GetConnected () const
 
virtual bool GetCorrectlyConfigured () const
 
PlusStatus GetDataSource (const char *aSourceId, vtkPlusDataSource *&aSource)
 
PlusStatus GetDataSource (const std::string &aSourceId, vtkPlusDataSource *&aSource)
 
virtual double GetDesiredTimestamp ()
 
virtual std::string GetDeviceId () const
 
PlusStatus GetFieldDataSource (const char *aSourceId, vtkPlusDataSource *&aSource) const
 
PlusStatus GetFieldDataSource (const std::string &aSourceId, vtkPlusDataSource *&aSource) const
 
DataSourceContainerConstIterator GetFieldDataSourcessIteratorBegin () const
 
DataSourceContainerConstIterator GetFieldDataSourcessIteratorEnd () const
 
PlusStatus GetFirstActiveOutputVideoSource (vtkPlusDataSource *&aVideoSource)
 
PlusStatus GetFirstActiveTool (vtkPlusDataSource *&aTool) const
 
PlusStatus GetFirstOutputChannel (vtkPlusChannel *&aChannel)
 
PlusStatus GetFirstVideoSource (vtkPlusDataSource *&anImage)
 
virtual unsigned long GetFrameNumber () const
 
virtual double GetFrameTimeStamp () const
 
virtual PlusStatus GetImage (const std::string &requestedImageId, std::string &assignedImageId, const std::string &imageReferencFrameName, vtkImageData *imageData, vtkMatrix4x4 *ijkToReferenceTransform)
 
virtual PlusStatus GetImageMetaData (igsioCommon::ImageMetaDataList &imageMetaDataItems)
 
virtual US_IMAGE_TYPE GetImageType (vtkPlusChannel &aChannel)
 
PlusStatus GetInputDevices (std::vector< vtkPlusDevice * > &outDeviceList) const
 
PlusStatus GetInputDevicesRecursive (std::vector< vtkPlusDevice * > &outDeviceList) const
 
virtual PlusStatus GetInputFrameSize (vtkPlusChannel &aChannel, unsigned int &x, unsigned int &y, unsigned int &z) const
 
virtual PlusStatus GetInputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const
 
double GetInternalUpdateRate () const
 
virtual double GetLocalTimeOffsetSec () const
 
double GetMissingInputGracePeriodSec () const
 
virtual int GetNumberOfFieldDataSources () const
 
virtual int GetNumberOfTools () const
 
virtual int GetNumberOfVideoSources () const
 
PlusStatus GetOutputChannelByName (vtkPlusChannel *&aChannel, const char *aChannelId)
 
PlusStatus GetOutputChannelByName (vtkPlusChannel *&aChannel, const std::string &aChannelId)
 
ChannelContainerConstIterator GetOutputChannelsEnd () const
 
ChannelContainerIterator GetOutputChannelsEnd ()
 
ChannelContainerConstIterator GetOutputChannelsStart () const
 
ChannelContainerIterator GetOutputChannelsStart ()
 
virtual PlusStatus GetOutputFrameSize (vtkPlusChannel &aChannel, unsigned int &x, unsigned int &y, unsigned int &z) const
 
virtual PlusStatus GetOutputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const
 
virtual std::string GetParameter (const std::string &key) const
 
virtual PlusStatus GetParameter (const std::string &key, std::string &outValue) const
 
virtual igsioCommon::VTKScalarPixelType GetPixelType (vtkPlusChannel &aChannel)
 
virtual std::string GetSdkVersion ()
 
virtual double GetStartTime ()
 
virtual double GetTimestampClosestToDesired ()
 
PlusStatus GetTool (const char *aToolSourceId, vtkPlusDataSource *&aTool) const
 
PlusStatus GetTool (const std::string &aToolSourceId, vtkPlusDataSource *&aTool) const
 
PlusStatus GetToolByPortName (const char *aPortName, vtkPlusDataSource *&aSource)
 
PlusStatus GetToolByPortName (const std::string &aPortName, vtkPlusDataSource *&aSource)
 
DataSourceContainerConstIterator GetToolIteratorBegin () const
 
DataSourceContainerConstIterator GetToolIteratorEnd () const
 
std::string GetToolReferenceFrameName () const
 
virtual int GetUpdateWithDesiredTimestamp ()
 
PlusStatus GetVideoSource (const char *aSourceId, vtkPlusDataSource *&aVideoSource)
 
PlusStatus GetVideoSourceByIndex (const unsigned int index, vtkPlusDataSource *&aVideoSource)
 
DataSourceContainerConstIterator GetVideoSourceIteratorBegin () const
 
DataSourceContainerConstIterator GetVideoSourceIteratorEnd () const
 
std::vector< vtkPlusDataSource * > GetVideoSources () const
 
PlusStatus GetVideoSourcesByPortName (const char *aPortName, std::vector< vtkPlusDataSource * > &sources)
 
PlusStatus GetVideoSourcesByPortName (const std::string &aPortName, std::vector< vtkPlusDataSource * > &sources)
 
virtual bool IsConnected () const
 
virtual bool IsRecording () const
 
virtual bool IsResettable ()
 
virtual bool IsVirtual () const
 
virtual PlusStatus NotifyConfigured ()
 
virtual int OutputChannelCount () const
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual PlusStatus Reset ()
 
virtual PlusStatus SendText (const std::string &textToSend, std::string *textReceived=NULL)
 
PlusStatus SetAcquisitionRate (double aRate)
 
virtual PlusStatus SetBufferSize (vtkPlusChannel &aChannel, int FrameBufferSize, const std::string &aSourceId=std::string(""))
 
virtual void SetDataCollector (vtkPlusDataCollector *_arg)
 
virtual void SetDesiredTimestamp (double)
 
void SetDeviceId (const std::string &id)
 
void SetFieldDataSourcesBufferSize (int aBufferSize)
 
virtual PlusStatus SetImageType (vtkPlusChannel &aChannel, US_IMAGE_TYPE imageType)
 
virtual PlusStatus SetInputFrameSize (vtkPlusDataSource &aSource, unsigned int x, unsigned int y, unsigned int z)
 
virtual void SetLocalTimeOffsetSec (double aTimeOffsetSec)
 
virtual void SetMissingInputGracePeriodSec (double)
 
virtual PlusStatus SetParameter (const std::string &key, const std::string &value)
 
virtual PlusStatus SetPixelType (vtkPlusChannel &aChannel, igsioCommon::VTKScalarPixelType pixelType)
 
virtual void SetStartTime (double startTime)
 
void SetToolReferenceFrameName (const std::string &frameName)
 
void SetToolsBufferSize (int aBufferSize)
 
virtual void SetUpdateWithDesiredTimestamp (int)
 
virtual PlusStatus StartRecording ()
 
virtual PlusStatus StopRecording ()
 
virtual void UpdateWithDesiredTimestampOff ()
 
virtual void UpdateWithDesiredTimestampOn ()
 
virtual PlusStatus WriteToolsToSequenceFile (const std::string &filename, bool useCompression=false)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPlusUSDigitalEncodersTracker * New ()
 
static vtkPlusUSDigitalEncodersTracker * SafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPlusDevice
static PlusStatus GetToolReferenceFrameFromTrackedFrame (igsioTrackedFrame &aFrame, std::string &aToolReferenceFrameName)
 
static int IsTypeOf (const char *type)
 
static vtkPlusDevice * New ()
 
static vtkPlusDevice * SafeDownCast (vtkObject *o)
 

Static Public Attributes

static const long INVALID_SEI_ADDRESS = -1
 
static const char * USDIGITALENCODER_COMMAND_GET_POSITION = "GetPosition"
 
static const char * USDIGITALENCODER_COMMAND_SET_ALL_ORIGIN = "SetAllOrigin"
 
static const char * USDIGITALENCODER_COMMAND_SET_ORIGIN = "SetOrigin"
 
- Static Public Attributes inherited from vtkPlusDevice
static const std::string BMODE_PORT_NAME = "B"
 
static const std::string PARAMETER_XML_ELEMENT_TAG = "Parameter"
 
static const std::string PARAMETERS_XML_ELEMENT_TAG = "Parameters"
 
static const std::string RFMODE_PORT_NAME = "Rf"
 

Protected Types

typedef std::map< long, vtkPlusUSDigitalEncoderInfo * > EncoderInfoMapType
 
typedef std::list< vtkPlusUSDigitalEncoderInfo > EncoderListType
 
typedef std::map< long, long > IDtoAddressType
 

Protected Member Functions

PlusStatus InternalStartRecording ()
 
PlusStatus InternalStopRecording ()
 
 vtkPlusUSDigitalEncodersTracker ()
 
 ~vtkPlusUSDigitalEncodersTracker ()
 
- Protected Member Functions inherited from vtkPlusDevice
virtual PlusStatus AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, const igsioVideoFrame &frame, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)
 
virtual PlusStatus AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, void *imageDataPtr, US_IMAGE_ORIENTATION usImageOrientation, const FrameSizeType &frameSizeInPx, igsioCommon::VTKScalarPixelType pixelType, unsigned int numberOfScalarComponents, US_IMAGE_TYPE imageType, int numberOfBytesToSkip, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)
 
PlusStatus EnsureUniqueDataSourceId (const std::string &aSourceId)
 
vtkXMLDataElement * FindInputChannelElement (vtkXMLDataElement *rootXMLElement, const char *aChannelId)
 
vtkXMLDataElement * FindOutputChannelElement (vtkXMLDataElement *rootXMLElement, const char *aChannelId)
 
vtkXMLDataElement * FindThisDeviceElement (vtkXMLDataElement *rootXMLElement)
 
virtual vtkPlusDataCollector * GetDataCollector ()
 
double GetRecordingStartTime () const
 
bool GetStartThreadForInternalUpdates () const
 
bool HasGracePeriodExpired ()
 
virtual void InternalWriteInputChannels (vtkXMLDataElement *rootXMLElement)
 
virtual void InternalWriteOutputChannels (vtkXMLDataElement *rootXMLElement)
 
virtual void SetCorrectlyConfigured (bool)
 
virtual void SetRecordingStartTime (double)
 
virtual void SetStartThreadForInternalUpdates (bool)
 
virtual PlusStatus ToolTimeStampedUpdate (const std::string &aToolSourceId, vtkMatrix4x4 *matrix, ToolStatus status, unsigned long frameNumber, double unfilteredtimestamp, const igsioFieldMapType *customFields=NULL)
 
virtual PlusStatus ToolTimeStampedUpdateWithoutFiltering (const std::string &aToolSourceId, vtkMatrix4x4 *matrix, ToolStatus status, double unfilteredtimestamp, double filteredtimestamp, const igsioFieldMapType *customFields=NULL)
 
 vtkPlusDevice ()
 
virtual ~vtkPlusDevice ()
 

Protected Attributes

bool coreXY = false
 
EncoderListType EncoderList
 
EncoderInfoMapType EncoderMap
 
IDtoAddressType IdAddress
 
vtkSmartPointer< vtkIGSIOTransformRepository > TransformRepository = vtkSmartPointer<vtkIGSIOTransformRepository>::New()
 
- Protected Attributes inherited from vtkPlusDevice
double AcquisitionRate
 
int Connected
 
bool CorrectlyConfigured
 
StreamBufferItem * CurrentStreamBufferItem
 
vtkPlusDataCollector * DataCollector
 
double DesiredTimestamp
 
std::string DeviceId
 
DataSourceContainer Fields
 
unsigned long FrameNumber
 
double FrameTimeStamp
 
ChannelContainer InputChannels
 
double LocalTimeOffsetSec
 
double MissingInputGracePeriodSec
 
ChannelContainer OutputChannels
 
int OutputNeedsInitialization
 
std::map< std::string, std::string > Parameters
 
int Recording
 
double RecordingStartTime
 
std::set< std::string > ReportedUnknownTools
 
bool RequireImageOrientationInConfiguration
 
bool RequirePortNameInDeviceSetConfiguration
 
bool StartThreadForInternalUpdates
 
bool ThreadAlive
 
vtkMultiThreader * Threader
 
int ThreadId
 
double TimestampClosestToDesired
 
std::string ToolReferenceFrameName
 
DataSourceContainer Tools
 
int UpdateWithDesiredTimestamp
 
DataSourceContainer VideoSources
 

Additional Inherited Members

- Public Attributes inherited from vtkPlusDevice
double InternalUpdateRate
 
vtkIGSIORecursiveCriticalSection * UpdateMutex
 
vtkTimeStamp UpdateTime
 
- Static Protected Member Functions inherited from vtkPlusDevice
static void * vtkDataCaptureThread (vtkMultiThreader::ThreadInfo *data)
 
- Static Protected Attributes inherited from vtkPlusDevice
static const int VIRTUAL_DEVICE_FRAME_RATE = 50
 

Detailed Description

Interface for multiple US Digital A2, A2T, A4, HBA2, HBA4 or HD25A encoders to generate pose information of a target object.

This class communicates with multiple US Digital encoders through SEI (Serial Encoder Interface Bus) provided by US Digital.

IDs are assigned to devices based on serial numbers: lower SN -> lower ID. IDs start at 0.

Definition at line 27 of file vtkPlusUSDigitalEncodersTracker.h.

Member Typedef Documentation

◆ EncoderInfoMapType

typedef std::map<long, vtkPlusUSDigitalEncoderInfo*> vtkPlusUSDigitalEncodersTracker::EncoderInfoMapType
protected

Definition at line 125 of file vtkPlusUSDigitalEncodersTracker.h.

◆ EncoderListType

typedef std::list<vtkPlusUSDigitalEncoderInfo> vtkPlusUSDigitalEncodersTracker::EncoderListType
protected

Definition at line 127 of file vtkPlusUSDigitalEncodersTracker.h.

◆ IDtoAddressType

typedef std::map<long, long> vtkPlusUSDigitalEncodersTracker::IDtoAddressType
protected

Definition at line 129 of file vtkPlusUSDigitalEncodersTracker.h.

◆ Superclass

typedef vtkPlusDevice vtkPlusUSDigitalEncodersTracker::Superclass

Definition at line 33 of file vtkPlusUSDigitalEncodersTracker.h.

Constructor & Destructor Documentation

◆ vtkPlusUSDigitalEncodersTracker() [1/2]

vtkPlusUSDigitalEncodersTracker::vtkPlusUSDigitalEncodersTracker ( )
protected

Definition at line 102 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ ~vtkPlusUSDigitalEncodersTracker()

vtkPlusUSDigitalEncodersTracker::~vtkPlusUSDigitalEncodersTracker ( )
protected

Definition at line 113 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ vtkPlusUSDigitalEncodersTracker() [2/2]

vtkPlusUSDigitalEncodersTracker::vtkPlusUSDigitalEncodersTracker ( const vtkPlusUSDigitalEncodersTracker &  )
delete

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPlusUSDigitalEncodersTracker::GetClassName ( )
virtual

Reimplemented from vtkPlusDevice.

◆ GetUSDigitalA2EncoderModeWithID()

PlusStatus vtkPlusUSDigitalEncodersTracker::GetUSDigitalA2EncoderModeWithID ( long  id,
long *  mode 
)

Gets the mode of an A2 Encoder

Definition at line 623 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ GetUSDigitalA2EncoderPositionWithID()

PlusStatus vtkPlusUSDigitalEncodersTracker::GetUSDigitalA2EncoderPositionWithID ( long  id,
long *  pos 
)

Gets the Position of an A2 Encoder

Definition at line 666 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ GetUSDigitalA2EncoderResoultionWithID()

PlusStatus vtkPlusUSDigitalEncodersTracker::GetUSDigitalA2EncoderResoultionWithID ( long  id,
long *  res 
)

Gets the resolution of an A2 Encoder

Definition at line 644 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ InternalConnect()

PlusStatus vtkPlusUSDigitalEncodersTracker::InternalConnect ( )
virtual

Connect to device

Reimplemented from vtkPlusDevice.

Definition at line 128 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusUSDigitalEncodersTracker::InternalDisconnect ( )
virtual

Disconnect from device

Reimplemented from vtkPlusDevice.

Definition at line 229 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ InternalStartRecording()

PlusStatus vtkPlusUSDigitalEncodersTracker::InternalStartRecording ( )
protectedvirtual

Start the tracking system. The tracking system is brought from its ground state into full tracking mode. The device will only be reset if communication cannot be established without a reset.

Reimplemented from vtkPlusDevice.

Definition at line 267 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ InternalStopRecording()

PlusStatus vtkPlusUSDigitalEncodersTracker::InternalStopRecording ( )
protectedvirtual

Stop the tracking system and bring it back to its ground state: Initialized, not tracking, at 9600 Baud.

Reimplemented from vtkPlusDevice.

Definition at line 274 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ InternalUpdate()

PlusStatus vtkPlusUSDigitalEncodersTracker::InternalUpdate ( )
virtual

Get an update from the multiple USDigital encoders and push the new transforms to the tools. This should only be used within vtkTracker.cxx. This method is called by the tracker thread.

Reimplemented from vtkPlusDevice.

Definition at line 281 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ IsA()

virtual int vtkPlusUSDigitalEncodersTracker::IsA ( const char *  type)
virtual

Reimplemented from vtkPlusDevice.

◆ IsStepperAlive()

PlusStatus vtkPlusUSDigitalEncodersTracker::IsStepperAlive ( )
virtual

Return whether stepper is alive

Definition at line 552 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ IsTracker()

bool vtkPlusUSDigitalEncodersTracker::IsTracker ( ) const
inlineoverridevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 40 of file vtkPlusUSDigitalEncodersTracker.h.

◆ IsTypeOf()

static int vtkPlusUSDigitalEncodersTracker::IsTypeOf ( const char *  type)
static

◆ New()

static vtkPlusUSDigitalEncodersTracker* vtkPlusUSDigitalEncodersTracker::New ( )
static

◆ operator=()

void vtkPlusUSDigitalEncodersTracker::operator= ( const vtkPlusUSDigitalEncodersTracker &  )
delete

◆ PrintSelf()

void vtkPlusUSDigitalEncodersTracker::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkPlusDevice.

Definition at line 122 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ Probe()

PlusStatus vtkPlusUSDigitalEncodersTracker::Probe ( )
virtual

Probe to see if the tracking system is present on the specified serial port. If the SerialPort is set to -1, then all serial ports will be checked.

Reimplemented from vtkPlusDevice.

Definition at line 246 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusUSDigitalEncodersTracker::ReadConfiguration ( vtkXMLDataElement *  config)
virtual

Read main configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 362 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ SafeDownCast()

static vtkPlusUSDigitalEncodersTracker* vtkPlusUSDigitalEncodersTracker::SafeDownCast ( vtkObject *  o)
static

◆ SetAllUSDigitalA2EncoderOrigin()

PlusStatus vtkPlusUSDigitalEncodersTracker::SetAllUSDigitalA2EncoderOrigin ( )

Sets the absolute zero to the current position of all connected US Digital A2 Encoders

Definition at line 591 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ SetUSDigitalA2EncoderModeWithID()

PlusStatus vtkPlusUSDigitalEncodersTracker::SetUSDigitalA2EncoderModeWithID ( long  id,
long  mode 
)

Sets the mode of an A2 Encoder

Definition at line 613 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ SetUSDigitalA2EncoderOriginWithID()

PlusStatus vtkPlusUSDigitalEncodersTracker::SetUSDigitalA2EncoderOriginWithID ( long  id)

Sets the absolute zero to the current position, in single-turn mode the new position is stored in EEPROM

Definition at line 581 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ SetUSDigitalA2EncoderPositionWithID()

PlusStatus vtkPlusUSDigitalEncodersTracker::SetUSDigitalA2EncoderPositionWithID ( long  id,
long  pos 
)

Sets the Position of an A2 Encoder

Definition at line 655 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ SetUSDigitalA2EncoderResoultionWithID()

PlusStatus vtkPlusUSDigitalEncodersTracker::SetUSDigitalA2EncoderResoultionWithID ( long  id,
long  res 
)

Sets the resolution of an A2 Encoder

Definition at line 633 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ SetUSDigitalA2EncodersSleep()

PlusStatus vtkPlusUSDigitalEncodersTracker::SetUSDigitalA2EncodersSleep ( )

Makes all A2's on the SEI bus go to sleep, the current consumption then drops below 0.6 mA / device

Definition at line 567 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ SetUSDigitalA2EncodersStrobeMode()

PlusStatus vtkPlusUSDigitalEncodersTracker::SetUSDigitalA2EncodersStrobeMode ( )

If the A2 is in strobe mode, it will take a position reading after receiving this command.

Definition at line 560 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ SetUSDigitalA2EncodersWakeup()

PlusStatus vtkPlusUSDigitalEncodersTracker::SetUSDigitalA2EncodersWakeup ( )

Function: wakes up all A2's on the SEI bus, wait at least 5mSec before sending the next command

Definition at line 574 of file vtkPlusUSDigitalEncodersTracker.cxx.

◆ WriteConfiguration()

PlusStatus vtkPlusUSDigitalEncodersTracker::WriteConfiguration ( vtkXMLDataElement *  config)
virtual

Write main configuration to xml data

Reimplemented from vtkPlusDevice.

Definition at line 545 of file vtkPlusUSDigitalEncodersTracker.cxx.

Member Data Documentation

◆ coreXY

bool vtkPlusUSDigitalEncodersTracker::coreXY = false
protected

Definition at line 131 of file vtkPlusUSDigitalEncodersTracker.h.

◆ EncoderList

EncoderListType vtkPlusUSDigitalEncodersTracker::EncoderList
protected

Definition at line 128 of file vtkPlusUSDigitalEncodersTracker.h.

◆ EncoderMap

EncoderInfoMapType vtkPlusUSDigitalEncodersTracker::EncoderMap
protected

Definition at line 126 of file vtkPlusUSDigitalEncodersTracker.h.

◆ IdAddress

IDtoAddressType vtkPlusUSDigitalEncodersTracker::IdAddress
protected

Definition at line 130 of file vtkPlusUSDigitalEncodersTracker.h.

◆ INVALID_SEI_ADDRESS

const long vtkPlusUSDigitalEncodersTracker::INVALID_SEI_ADDRESS = -1
static

Definition at line 30 of file vtkPlusUSDigitalEncodersTracker.h.

◆ TransformRepository

vtkSmartPointer<vtkIGSIOTransformRepository> vtkPlusUSDigitalEncodersTracker::TransformRepository = vtkSmartPointer<vtkIGSIOTransformRepository>::New()
protected

Definition at line 123 of file vtkPlusUSDigitalEncodersTracker.h.

◆ USDIGITALENCODER_COMMAND_GET_POSITION

const char * vtkPlusUSDigitalEncodersTracker::USDIGITALENCODER_COMMAND_GET_POSITION = "GetPosition"
static

Definition at line 38 of file vtkPlusUSDigitalEncodersTracker.h.

◆ USDIGITALENCODER_COMMAND_SET_ALL_ORIGIN

const char * vtkPlusUSDigitalEncodersTracker::USDIGITALENCODER_COMMAND_SET_ALL_ORIGIN = "SetAllOrigin"
static

Definition at line 37 of file vtkPlusUSDigitalEncodersTracker.h.

◆ USDIGITALENCODER_COMMAND_SET_ORIGIN

const char * vtkPlusUSDigitalEncodersTracker::USDIGITALENCODER_COMMAND_SET_ORIGIN = "SetOrigin"
static

Definition at line 36 of file vtkPlusUSDigitalEncodersTracker.h.

The documentation for this class was generated from the following files:
Generated on Fri Nov 15 2024 01:48:24 for PlusLib by   doxygen 1.8.15