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 | Protected Member Functions
vtkPlus3dConnexionTracker Class Reference
DataCollection

Interface for 3D Connexion 3D mouse devices. More...

#include <src/PlusDataCollection/3dConnexionTracking/vtkPlus3dConnexionTracker.h>

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

Public Types

enum  OperatingModeType { MOUSE_MODE, JOYSTICK_MODE }
 
typedef vtkPlusDevice Superclass
 
- Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
PlusStatus InternalConnect ()
 
virtual PlusStatus InternalDisconnect ()
 
PlusStatus InternalUpdate ()
 
virtual int IsA (const char *type)
 
virtual bool IsTracker () const
 
void OnCaptureWindowDestroy ()
 
PlusStatus Probe ()
 
void ProcessDeviceInputEvent (LPARAM lParam)
 
PlusStatus ReadConfiguration (vtkXMLDataElement *config)
 
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 void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
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 vtkPlus3dConnexionTracker * New ()
 
static vtkPlus3dConnexionTracker * 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

PlusStatus CreateCaptureWindow ()
 
void DestroyCaptureWindow ()
 
PlusStatus InternalStartRecording ()
 
PlusStatus InternalStopRecording ()
 
PlusStatus RegisterDevice ()
 
void UnregisterDevice ()
 
 vtkPlus3dConnexionTracker ()
 
 ~vtkPlus3dConnexionTracker ()
 
- 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 ()
 

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)
 
- 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
 
- Static Protected Attributes inherited from vtkPlusDevice
static const int VIRTUAL_DEVICE_FRAME_RATE = 50
 

Detailed Description

Interface for 3D Connexion 3D mouse devices.

This class reads transforms from 3D mouse devices.

Definition at line 25 of file vtkPlus3dConnexionTracker.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusDevice vtkPlus3dConnexionTracker::Superclass

Definition at line 30 of file vtkPlus3dConnexionTracker.h.

Member Enumeration Documentation

◆ OperatingModeType

enum vtkPlus3dConnexionTracker::OperatingModeType
Enumerator
MOUSE_MODE 
JOYSTICK_MODE 

Definition at line 62 of file vtkPlus3dConnexionTracker.h.

Constructor & Destructor Documentation

◆ vtkPlus3dConnexionTracker()

vtkPlus3dConnexionTracker::vtkPlus3dConnexionTracker ( )
protected

Definition at line 39 of file vtkPlus3dConnexionTracker.cxx.

◆ ~vtkPlus3dConnexionTracker()

vtkPlus3dConnexionTracker::~vtkPlus3dConnexionTracker ( )
protected

Definition at line 67 of file vtkPlus3dConnexionTracker.cxx.

Member Function Documentation

◆ CreateCaptureWindow()

PlusStatus vtkPlus3dConnexionTracker::CreateCaptureWindow ( )
protected

Create an invisible window that will be used to receive input messages from the device

Definition at line 295 of file vtkPlus3dConnexionTracker.cxx.

◆ DestroyCaptureWindow()

void vtkPlus3dConnexionTracker::DestroyCaptureWindow ( )
protected

Delete the capture window

Definition at line 362 of file vtkPlus3dConnexionTracker.cxx.

◆ GetClassName()

virtual const char* vtkPlus3dConnexionTracker::GetClassName ( )
virtual

Reimplemented from vtkPlusDevice.

◆ InternalConnect()

PlusStatus vtkPlus3dConnexionTracker::InternalConnect ( )
virtual

Connect to device

Reimplemented from vtkPlusDevice.

Definition at line 380 of file vtkPlus3dConnexionTracker.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlus3dConnexionTracker::InternalDisconnect ( )
virtual

Disconnect from device

Reimplemented from vtkPlusDevice.

Definition at line 403 of file vtkPlus3dConnexionTracker.cxx.

◆ InternalStartRecording()

PlusStatus vtkPlus3dConnexionTracker::InternalStartRecording ( )
protectedvirtual

Start processing data received from the device

Reimplemented from vtkPlusDevice.

Definition at line 424 of file vtkPlus3dConnexionTracker.cxx.

◆ InternalStopRecording()

PlusStatus vtkPlus3dConnexionTracker::InternalStopRecording ( )
protectedvirtual

Stop processing data received from the device

Reimplemented from vtkPlusDevice.

Definition at line 431 of file vtkPlus3dConnexionTracker.cxx.

◆ InternalUpdate()

PlusStatus vtkPlus3dConnexionTracker::InternalUpdate ( )
virtual

Get an update from the tracking system 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 438 of file vtkPlus3dConnexionTracker.cxx.

◆ IsA()

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

Reimplemented from vtkPlusDevice.

◆ IsTracker()

virtual bool vtkPlus3dConnexionTracker::IsTracker ( ) const
inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 68 of file vtkPlus3dConnexionTracker.h.

◆ IsTypeOf()

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

◆ New()

static vtkPlus3dConnexionTracker* vtkPlus3dConnexionTracker::New ( )
static

◆ OnCaptureWindowDestroy()

void vtkPlus3dConnexionTracker::OnCaptureWindowDestroy ( )

Callback function called when capture window is destroyed. For internal use only. Public to allow calling from static function.

Definition at line 355 of file vtkPlus3dConnexionTracker.cxx.

◆ Probe()

PlusStatus vtkPlus3dConnexionTracker::Probe ( )
virtual

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

Reimplemented from vtkPlusDevice.

Definition at line 416 of file vtkPlus3dConnexionTracker.cxx.

◆ ProcessDeviceInputEvent()

void vtkPlus3dConnexionTracker::ProcessDeviceInputEvent ( LPARAM  lParam)

Process input event received from the device. For internal use only. Public to allow calling from static function.

Definition at line 211 of file vtkPlus3dConnexionTracker.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlus3dConnexionTracker::ReadConfiguration ( vtkXMLDataElement *  config)
virtual

Read configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 480 of file vtkPlus3dConnexionTracker.cxx.

◆ RegisterDevice()

PlusStatus vtkPlus3dConnexionTracker::RegisterDevice ( )
protected

Register callback to get notifications from the device

Definition at line 87 of file vtkPlus3dConnexionTracker.cxx.

◆ SafeDownCast()

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

◆ UnregisterDevice()

void vtkPlus3dConnexionTracker::UnregisterDevice ( )
protected

Unregister callback function

Definition at line 174 of file vtkPlus3dConnexionTracker.cxx.

◆ WriteConfiguration()

PlusStatus vtkPlus3dConnexionTracker::WriteConfiguration ( vtkXMLDataElement *  config)
virtual

Write configuration to xml data

Reimplemented from vtkPlusDevice.

Definition at line 542 of file vtkPlus3dConnexionTracker.cxx.

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