vtkPlusBrachyTracker Class Reference

Interface to brachytherapy steppers. More...

#include <src/PlusDataCollection/BrachyTracking/vtkPlusBrachyTracker.h>

Inheritance diagram for vtkPlusBrachyTracker:

Collaboration diagram for vtkPlusBrachyTracker:

Public Types
enum	BRACHY_STEPPER_TOOL { PROBEHOME_TO_PROBE_TRANSFORM = 0, TEMPLATEHOME_TO_TEMPLATE_TRANSFORM, RAW_ENCODER_VALUES, NUMBER_OF_BRACHY_TOOLS }
enum	ENCODER_MATRIX_ROW { ROW_PROBE_POSITION = 0, ROW_PROBE_ROTATION = 1, ROW_TEMPLATE_POSITION = 2 }
typedef vtkPlusDevice	Superclass
Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm	Superclass

Public Member Functions
virtual void	CompensationEnabledOff ()
virtual void	CompensationEnabledOn ()
virtual unsigned long	GetBaudRate ()
PlusBrachyStepper::BRACHY_STEPPER_TYPE	GetBrachyStepperType ()
virtual char *	GetCalibrationAlgorithmVersion ()
virtual char *	GetCalibrationDate ()
virtual const char *	GetClassName ()
virtual bool	GetCompensationEnabled ()
PlusStatus	GetLatestStepperEncoderValues (double &probePosition, double &probeRotation, double &templatePosition, ToolStatus &status)
virtual char *	GetModelNumber ()
virtual char *	GetModelSerialNumber ()
virtual char *	GetModelVersion ()
PlusStatus	GetProbeHomeToProbeTransform (BufferItemUidType uid, vtkMatrix4x4 *probeHomeToProbeMatrix, ToolStatus &status)
PlusStatus	GetProbeHomeToProbeTransform (double timestamp, vtkMatrix4x4 *probeHomeToProbeMatrix, ToolStatus &status)
virtual double *	GetProbeRotationAxisOrientation ()
virtual void	GetProbeRotationAxisOrientation (double &, double &, double &)
virtual void	GetProbeRotationAxisOrientation (double [3])
virtual double	GetProbeRotationEncoderScale ()
virtual void	GetProbeTranslationAxisOrientation (double &, double &, double &)
virtual double *	GetProbeTranslationAxisOrientation ()
virtual void	GetProbeTranslationAxisOrientation (double [3])
PlusStatus	GetRawEncoderValuesTransform (BufferItemUidType uid, vtkMatrix4x4 *rawEncoderValuesTransform, ToolStatus &status)
PlusStatus	GetRawEncoderValuesTransform (double timestamp, vtkMatrix4x4 *rawEncoderValuesTransform, ToolStatus &status)
virtual unsigned long	GetSerialPort ()
PlusStatus	GetStepperEncoderValues (BufferItemUidType uid, double &probePosition, double &probeRotation, double &templatePosition, ToolStatus &status)
PlusStatus	GetStepperEncoderValues (double timestamp, double &probePosition, double &probeRotation, double &templatePosition, ToolStatus &status)
PlusStatus	GetTemplateHomeToTemplateTransform (BufferItemUidType uid, vtkMatrix4x4 *templateHomeToTemplateMatrix, ToolStatus &status)
PlusStatus	GetTemplateHomeToTemplateTransform (double timestamp, vtkMatrix4x4 *templateHomeToTemplateMatrix, ToolStatus &status)
virtual double *	GetTemplateTranslationAxisOrientation ()
virtual void	GetTemplateTranslationAxisOrientation (double [3])
virtual void	GetTemplateTranslationAxisOrientation (double &, double &, double &)
virtual PlusStatus	GetTrackedFrame (double timestamp, igsioTrackedFrame *aTrackedFrame)
PlusStatus	InitializeStepper (std::string &calibMsg)
PlusStatus	InternalConnect ()
virtual PlusStatus	InternalDisconnect ()
PlusStatus	InternalUpdate ()
virtual int	IsA (const char *type)
virtual bool	IsTracker () const
virtual PlusStatus	NotifyConfigured ()
virtual void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
PlusStatus	Probe ()
virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *config)
PlusStatus	ResetStepper ()
virtual void	SetBaudRate (unsigned long)
virtual void	SetCalibrationAlgorithmVersion (const char *)
virtual void	SetCalibrationDate (const char *)
virtual void	SetCompensationEnabled (bool)
virtual void	SetProbeRotationAxisOrientation (double [3])
virtual void	SetProbeRotationAxisOrientation (double, double, double)
virtual void	SetProbeRotationEncoderScale (double)
virtual void	SetProbeTranslationAxisOrientation (double [3])
virtual void	SetProbeTranslationAxisOrientation (double, double, double)
virtual void	SetSerialPort (unsigned long)
virtual void	SetTemplateTranslationAxisOrientation (double [3])
virtual void	SetTemplateTranslationAxisOrientation (double, double, double)
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 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 vtkPlusBrachyTracker *	New ()
static vtkPlusBrachyTracker *	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)

Protected Member Functions
std::string	GetBrachyToolSourceId (BRACHY_STEPPER_TOOL tool)
PlusStatus	InitBrachyTracker ()
PlusStatus	InternalStartRecording ()
PlusStatus	InternalStopRecording ()
virtual void	SetModelNumber (const char *)
virtual void	SetModelSerialNumber (const char *)
virtual void	SetModelVersion (const char *)
	vtkPlusBrachyTracker ()
	~vtkPlusBrachyTracker ()
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
unsigned long	BaudRate
PlusBrachyStepper::BRACHY_STEPPER_TYPE	BrachyStepperType
char *	CalibrationAlgorithmVersion
char *	CalibrationDate
bool	CompensationEnabled
PlusBrachyStepper *	Device
char *	ModelNumber
char *	ModelSerialNumber
char *	ModelVersion
double	ProbeRotationAxisOrientation [3]
double	ProbeRotationEncoderScale
double	ProbeTranslationAxisOrientation [3]
unsigned long	SerialPort
double	TemplateTranslationAxisOrientation [3]
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 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"
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 to brachytherapy steppers.

This class talks with CMS and CIVCO brachy steppers

Definition at line 24 of file vtkPlusBrachyTracker.h.

Member Typedef Documentation

Superclass

typedef vtkPlusDevice vtkPlusBrachyTracker::Superclass

Definition at line 46 of file vtkPlusBrachyTracker.h.

Member Enumeration Documentation

BRACHY_STEPPER_TOOL

enum vtkPlusBrachyTracker::BRACHY_STEPPER_TOOL

Brachy stepper tool types

Enumerator
PROBEHOME_TO_PROBE_TRANSFORM
TEMPLATEHOME_TO_TEMPLATE_TRANSFORM
RAW_ENCODER_VALUES
NUMBER_OF_BRACHY_TOOLS

Definition at line 29 of file vtkPlusBrachyTracker.h.

ENCODER_MATRIX_ROW

enum vtkPlusBrachyTracker::ENCODER_MATRIX_ROW

Row numbers used for storing stepper encoder positions in a 4x4 matrix

Enumerator
ROW_PROBE_POSITION
ROW_PROBE_ROTATION
ROW_TEMPLATE_POSITION

Definition at line 38 of file vtkPlusBrachyTracker.h.

Constructor & Destructor Documentation

vtkPlusBrachyTracker()

vtkPlusBrachyTracker::vtkPlusBrachyTracker ( )

protected

Definition at line 29 of file vtkPlusBrachyTracker.cxx.

~vtkPlusBrachyTracker()

vtkPlusBrachyTracker::~vtkPlusBrachyTracker ( )

protected

Definition at line 82 of file vtkPlusBrachyTracker.cxx.

Member Function Documentation

CompensationEnabledOff()

virtual void vtkPlusBrachyTracker::CompensationEnabledOff ( )

virtual

CompensationEnabledOn()

virtual void vtkPlusBrachyTracker::CompensationEnabledOn ( )

virtual

Enable/disable stepper calibration compensation

GetBaudRate()

virtual unsigned long vtkPlusBrachyTracker::GetBaudRate ( )

virtual

Get the desired baud rate. Default: 9600.

GetBrachyStepperType()

PlusBrachyStepper::BRACHY_STEPPER_TYPE vtkPlusBrachyTracker::GetBrachyStepperType ( )

inline

Get brachy stepper type

See also

BrachyStepper::BRACHY_STEPPER_TYPE

Definition at line 169 of file vtkPlusBrachyTracker.h.

GetBrachyToolSourceId()

std::string vtkPlusBrachyTracker::GetBrachyToolSourceId ( BRACHY_STEPPER_TOOL  tool )

protected

Definition at line 171 of file vtkPlusBrachyTracker.cxx.

GetCalibrationAlgorithmVersion()

virtual char* vtkPlusBrachyTracker::GetCalibrationAlgorithmVersion ( )

virtual

Get stepper calibration algorithm version

GetCalibrationDate()

virtual char* vtkPlusBrachyTracker::GetCalibrationDate ( )

virtual

Get stepper calibration date

GetClassName()

virtual const char* vtkPlusBrachyTracker::GetClassName ( )

virtual

Reimplemented from vtkPlusDevice.

GetCompensationEnabled()

virtual bool vtkPlusBrachyTracker::GetCompensationEnabled ( )

virtual

Enable/disable stepper calibration compensation

GetLatestStepperEncoderValues()

PlusStatus vtkPlusBrachyTracker::GetLatestStepperEncoderValues	(	double &	probePosition,
		double &	probeRotation,
		double &	templatePosition,
		ToolStatus &	status
	)

Get latest stepper encoder values from the buffer

Definition at line 588 of file vtkPlusBrachyTracker.cxx.

GetModelNumber()

virtual char* vtkPlusBrachyTracker::GetModelNumber ( )

virtual

Get stepper model number

GetModelSerialNumber()

virtual char* vtkPlusBrachyTracker::GetModelSerialNumber ( )

virtual

Get stepper serial number

GetModelVersion()

virtual char* vtkPlusBrachyTracker::GetModelVersion ( )

virtual

Get the a string (perhaps a long one) describing the type and version of the device.

GetProbeHomeToProbeTransform() [1/2]

PlusStatus vtkPlusBrachyTracker::GetProbeHomeToProbeTransform	(	BufferItemUidType	uid,
		vtkMatrix4x4 *	probeHomeToProbeMatrix,
		ToolStatus &	status
	)

Get probe home to probe transform from the buffer by UID

Definition at line 685 of file vtkPlusBrachyTracker.cxx.

GetProbeHomeToProbeTransform() [2/2]

PlusStatus vtkPlusBrachyTracker::GetProbeHomeToProbeTransform	(	double	timestamp,
		vtkMatrix4x4 *	probeHomeToProbeMatrix,
		ToolStatus &	status
	)

Get probe home to probe transform in a particular timestamp

Definition at line 725 of file vtkPlusBrachyTracker.cxx.

GetProbeRotationAxisOrientation() [1/3]

virtual double* vtkPlusBrachyTracker::GetProbeRotationAxisOrientation ( )

virtual

Get probe rotation axis orientation vector[Trx, Try, 1]

GetProbeRotationAxisOrientation() [2/3]

virtual void vtkPlusBrachyTracker::GetProbeRotationAxisOrientation ( double &  , double &  , double &    )

virtual

GetProbeRotationAxisOrientation() [3/3]

virtual void vtkPlusBrachyTracker::GetProbeRotationAxisOrientation ( double  [3] )

virtual

GetProbeRotationEncoderScale()

virtual double vtkPlusBrachyTracker::GetProbeRotationEncoderScale ( )

virtual

Get probe rotation encoder scale

GetProbeTranslationAxisOrientation() [1/3]

virtual double* vtkPlusBrachyTracker::GetProbeTranslationAxisOrientation ( )

virtual

Get probe translation axis orientation vector[Tx, Ty, 1]

GetProbeTranslationAxisOrientation() [2/3]

virtual void vtkPlusBrachyTracker::GetProbeTranslationAxisOrientation ( double &  , double &  , double &    )

virtual

GetProbeTranslationAxisOrientation() [3/3]

virtual void vtkPlusBrachyTracker::GetProbeTranslationAxisOrientation ( double  [3] )

virtual

GetRawEncoderValuesTransform() [1/2]

PlusStatus vtkPlusBrachyTracker::GetRawEncoderValuesTransform	(	BufferItemUidType	uid,
		vtkMatrix4x4 *	rawEncoderValuesTransform,
		ToolStatus &	status
	)

Get raw encoder values transform from the buffer

Definition at line 819 of file vtkPlusBrachyTracker.cxx.

GetRawEncoderValuesTransform() [2/2]

PlusStatus vtkPlusBrachyTracker::GetRawEncoderValuesTransform	(	double	timestamp,
		vtkMatrix4x4 *	rawEncoderValuesTransform,
		ToolStatus &	status
	)

Get raw encoder values transform in a particular timestamp

Definition at line 860 of file vtkPlusBrachyTracker.cxx.

GetSerialPort()

virtual unsigned long vtkPlusBrachyTracker::GetSerialPort ( )

virtual

Get which serial port to use, COM1 through COM4.

GetStepperEncoderValues() [1/2]

PlusStatus vtkPlusBrachyTracker::GetStepperEncoderValues	(	BufferItemUidType	uid,
		double &	probePosition,
		double &	probeRotation,
		double &	templatePosition,
		ToolStatus &	status
	)

Get stepper encoder values from the buffer by UID

Definition at line 619 of file vtkPlusBrachyTracker.cxx.

GetStepperEncoderValues() [2/2]

PlusStatus vtkPlusBrachyTracker::GetStepperEncoderValues	(	double	timestamp,
		double &	probePosition,
		double &	probeRotation,
		double &	templatePosition,
		ToolStatus &	status
	)

Get stepper encoder values in a particular timestamp

Definition at line 658 of file vtkPlusBrachyTracker.cxx.

GetTemplateHomeToTemplateTransform() [1/2]

PlusStatus vtkPlusBrachyTracker::GetTemplateHomeToTemplateTransform	(	BufferItemUidType	uid,
		vtkMatrix4x4 *	templateHomeToTemplateMatrix,
		ToolStatus &	status
	)

Get template home to template transform from the buffer by UID

Definition at line 752 of file vtkPlusBrachyTracker.cxx.

GetTemplateHomeToTemplateTransform() [2/2]

PlusStatus vtkPlusBrachyTracker::GetTemplateHomeToTemplateTransform	(	double	timestamp,
		vtkMatrix4x4 *	templateHomeToTemplateMatrix,
		ToolStatus &	status
	)

Get template home to template transform in a particular timestamp

Definition at line 792 of file vtkPlusBrachyTracker.cxx.

GetTemplateTranslationAxisOrientation() [1/3]

virtual double* vtkPlusBrachyTracker::GetTemplateTranslationAxisOrientation ( )

virtual

Get template translation axis orientation vector[Tx, Ty, 1]

GetTemplateTranslationAxisOrientation() [2/3]

virtual void vtkPlusBrachyTracker::GetTemplateTranslationAxisOrientation ( double &  , double &  , double &    )

virtual

GetTemplateTranslationAxisOrientation() [3/3]

virtual void vtkPlusBrachyTracker::GetTemplateTranslationAxisOrientation ( double  [3] )

virtual

GetTrackedFrame()

PlusStatus vtkPlusBrachyTracker::GetTrackedFrame ( double  timestamp, igsioTrackedFrame *  aTrackedFrame  )

virtual

Get all transforms from buffer element values of each tool by timestamp.

Definition at line 466 of file vtkPlusBrachyTracker.cxx.

InitBrachyTracker()

PlusStatus vtkPlusBrachyTracker::InitBrachyTracker ( )

protected

Initialize the tracking device

Definition at line 293 of file vtkPlusBrachyTracker.cxx.

InitializeStepper()

PlusStatus vtkPlusBrachyTracker::InitializeStepper

(

std::string &

calibMsg

)

Initialize the stepper with the factory specified init process.

Definition at line 460 of file vtkPlusBrachyTracker.cxx.

InternalConnect()

PlusStatus vtkPlusBrachyTracker::InternalConnect ( )

virtual

Connect to device

Reimplemented from vtkPlusDevice.

Definition at line 110 of file vtkPlusBrachyTracker.cxx.

InternalDisconnect()

PlusStatus vtkPlusBrachyTracker::InternalDisconnect ( )

virtual

Disconnect from device

Reimplemented from vtkPlusDevice.

Definition at line 122 of file vtkPlusBrachyTracker.cxx.

InternalStartRecording()

PlusStatus vtkPlusBrachyTracker::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 148 of file vtkPlusBrachyTracker.cxx.

InternalStopRecording()

PlusStatus vtkPlusBrachyTracker::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 165 of file vtkPlusBrachyTracker.cxx.

InternalUpdate()

PlusStatus vtkPlusBrachyTracker::InternalUpdate ( )

virtual

Get an update from the tracking system and push the new transforms to the tools.

Reimplemented from vtkPlusDevice.

Definition at line 186 of file vtkPlusBrachyTracker.cxx.

IsA()

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

virtual

Reimplemented from vtkPlusDevice.

IsTracker()

virtual bool vtkPlusBrachyTracker::IsTracker ( ) const

inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 97 of file vtkPlusBrachyTracker.h.

IsTypeOf()

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

static

New()

static vtkPlusBrachyTracker* vtkPlusBrachyTracker::New ( )

static

NotifyConfigured()

PlusStatus vtkPlusBrachyTracker::NotifyConfigured ( )

virtual

Perform any post configuration actions

Reimplemented from vtkPlusDevice.

Definition at line 887 of file vtkPlusBrachyTracker.cxx.

PrintSelf()

void vtkPlusBrachyTracker::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Reimplemented from vtkPlusDevice.

Definition at line 104 of file vtkPlusBrachyTracker.cxx.

Probe()

PlusStatus vtkPlusBrachyTracker::Probe ( )

virtual

Probe to see if the tracking system is present on the specified serial port.

Reimplemented from vtkPlusDevice.

Definition at line 129 of file vtkPlusBrachyTracker.cxx.

ReadConfiguration()

PlusStatus vtkPlusBrachyTracker::ReadConfiguration ( vtkXMLDataElement *  config )

virtual

Read BrachyStepper configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 319 of file vtkPlusBrachyTracker.cxx.

ResetStepper()

PlusStatus vtkPlusBrachyTracker::ResetStepper

(

)

Reset the stepper. After this call, you should call InitializeStepper()

Definition at line 454 of file vtkPlusBrachyTracker.cxx.

SafeDownCast()

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

static

SetBaudRate()

virtual void vtkPlusBrachyTracker::SetBaudRate ( unsigned long  )

virtual

Set the desired baud rate. Default: 9600.

SetCalibrationAlgorithmVersion()

virtual void vtkPlusBrachyTracker::SetCalibrationAlgorithmVersion ( const char *  )

virtual

Set stepper calibration algorithm version

SetCalibrationDate()

virtual void vtkPlusBrachyTracker::SetCalibrationDate ( const char *  )

virtual

Set stepper calibration date

SetCompensationEnabled()

virtual void vtkPlusBrachyTracker::SetCompensationEnabled ( bool  )

virtual

Enable/disable stepper calibration compensation

SetModelNumber()

virtual void vtkPlusBrachyTracker::SetModelNumber ( const char *  )

protectedvirtual

Set the stepper model number

SetModelSerialNumber()

virtual void vtkPlusBrachyTracker::SetModelSerialNumber ( const char *  )

protectedvirtual

Set the stepper serial number

SetModelVersion()

virtual void vtkPlusBrachyTracker::SetModelVersion ( const char *  )

protectedvirtual

Set the stepper model version information.

SetProbeRotationAxisOrientation() [1/2]

virtual void vtkPlusBrachyTracker::SetProbeRotationAxisOrientation ( double  , double  , double    )

virtual

Set probe rotation axis orientation vector[Trx, Try, 1]

SetProbeRotationAxisOrientation() [2/2]

virtual void vtkPlusBrachyTracker::SetProbeRotationAxisOrientation ( double  [3] )

virtual

SetProbeRotationEncoderScale()

virtual void vtkPlusBrachyTracker::SetProbeRotationEncoderScale ( double  )

virtual

Set probe rotation encoder scale

SetProbeTranslationAxisOrientation() [1/2]

virtual void vtkPlusBrachyTracker::SetProbeTranslationAxisOrientation ( double  , double  , double    )

virtual

Set probe translation axis orientation vector[Tx, Ty, 1]

SetProbeTranslationAxisOrientation() [2/2]

virtual void vtkPlusBrachyTracker::SetProbeTranslationAxisOrientation ( double  [3] )

virtual

SetSerialPort()

virtual void vtkPlusBrachyTracker::SetSerialPort ( unsigned long  )

virtual

Set which serial port to use, COM1 through COM4.

SetTemplateTranslationAxisOrientation() [1/2]

virtual void vtkPlusBrachyTracker::SetTemplateTranslationAxisOrientation ( double  [3] )

virtual

SetTemplateTranslationAxisOrientation() [2/2]

virtual void vtkPlusBrachyTracker::SetTemplateTranslationAxisOrientation ( double  , double  , double    )

virtual

Set template translation axis orientation vector[Tx, Ty, 1]

WriteConfiguration()

PlusStatus vtkPlusBrachyTracker::WriteConfiguration ( vtkXMLDataElement *  config )

virtual

Write BrachyStepper configuration to xml data

Reimplemented from vtkPlusDevice.

Definition at line 413 of file vtkPlusBrachyTracker.cxx.

Member Data Documentation

BaudRate

unsigned long vtkPlusBrachyTracker::BaudRate

protected

Definition at line 217 of file vtkPlusBrachyTracker.h.

BrachyStepperType

PlusBrachyStepper::BRACHY_STEPPER_TYPE vtkPlusBrachyTracker::BrachyStepperType

protected

Definition at line 210 of file vtkPlusBrachyTracker.h.

CalibrationAlgorithmVersion

char* vtkPlusBrachyTracker::CalibrationAlgorithmVersion

protected

Stepper calibration algorithm version

Definition at line 225 of file vtkPlusBrachyTracker.h.

CalibrationDate

char* vtkPlusBrachyTracker::CalibrationDate

protected

Stepper calibration data

Definition at line 228 of file vtkPlusBrachyTracker.h.

CompensationEnabled

bool vtkPlusBrachyTracker::CompensationEnabled

protected

Enable/diasable stepper compensation

Definition at line 222 of file vtkPlusBrachyTracker.h.

Device

PlusBrachyStepper* vtkPlusBrachyTracker::Device

protected

Definition at line 208 of file vtkPlusBrachyTracker.h.

ModelNumber

char* vtkPlusBrachyTracker::ModelNumber

protected

Definition at line 213 of file vtkPlusBrachyTracker.h.

ModelSerialNumber

char* vtkPlusBrachyTracker::ModelSerialNumber

protected

Definition at line 214 of file vtkPlusBrachyTracker.h.

ModelVersion

char* vtkPlusBrachyTracker::ModelVersion

protected

Definition at line 212 of file vtkPlusBrachyTracker.h.

ProbeRotationAxisOrientation

double vtkPlusBrachyTracker::ProbeRotationAxisOrientation[3]

protected

Probe rotation axis orientation vector[Trx, Try, 1]

Definition at line 234 of file vtkPlusBrachyTracker.h.

ProbeRotationEncoderScale

double vtkPlusBrachyTracker::ProbeRotationEncoderScale

protected

Probe rotation encoder scale factor

Definition at line 240 of file vtkPlusBrachyTracker.h.

ProbeTranslationAxisOrientation

double vtkPlusBrachyTracker::ProbeTranslationAxisOrientation[3]

protected

Probe translation axis orientation vector[Tx, Ty, 1]

Definition at line 231 of file vtkPlusBrachyTracker.h.

SerialPort

unsigned long vtkPlusBrachyTracker::SerialPort

protected

Definition at line 216 of file vtkPlusBrachyTracker.h.

TemplateTranslationAxisOrientation

double vtkPlusBrachyTracker::TemplateTranslationAxisOrientation[3]

protected

Template translation axis orientation vector[Tx, Ty, 1]

Definition at line 237 of file vtkPlusBrachyTracker.h.

---

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

• src/PlusDataCollection/BrachyTracking/vtkPlusBrachyTracker.h
• src/PlusDataCollection/BrachyTracking/vtkPlusBrachyTracker.cxx