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 | Protected Attributes | Friends
vtkPlusIntuitiveDaVinciTracker Class Reference

#include <src/PlusDataCollection/IntuitiveDaVinci/vtkPlusIntuitiveDaVinciTracker.h>

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

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
 
IntuitiveDaVinci * GetDaVinci () const
 
virtual unsigned int GetPort ()
 
virtual std::string GetSdkVersion ()
 
virtual int IsA (const char *type)
 
virtual bool IsTracker () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
virtual PlusStatus Probe ()
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *rootConfigElement)
 
virtual void SetPort (unsigned int)
 
 vtkGetStdStringMacro (IpAddr)
 
 vtkGetStdStringMacro (Password)
 
 vtkSetStdStringMacro (IpAddr)
 
 vtkSetStdStringMacro (Password)
 
virtual PlusStatus WriteConfiguration (vtkXMLDataElement *rootConfigElement)
 
- 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 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 PlusStatus InternalUpdate ()
 
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 vtkPlusIntuitiveDaVinciTracker * New ()
 
static vtkPlusIntuitiveDaVinciTracker * 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

virtual PlusStatus InternalConnect ()
 
virtual PlusStatus InternalDisconnect ()
 
virtual PlusStatus InternalStartRecording ()
 
virtual PlusStatus InternalStopRecording ()
 
 vtkPlusIntuitiveDaVinciTracker ()
 
 ~vtkPlusIntuitiveDaVinciTracker ()
 
- 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

IntuitiveDaVinci * DaVinci
 
unsigned int FrameNumber
 
std::string IpAddr
 
double LastFrameNumber
 
std::string Password
 
unsigned int Port
 
- 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
 

Friends

void vtkPlusIntuitiveDaVinciTrackerUtilities::eventCB (ISI_MANIP_INDEX mid, ISI_EVENT_ID event_id, ISI_INT args[ISI_NUM_EVENT_ARGS], void *userdata)
 
void vtkPlusIntuitiveDaVinciTrackerUtilities::streamCB (void *userData)
 

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

Definition at line 32 of file vtkPlusIntuitiveDaVinciTracker.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusDevice vtkPlusIntuitiveDaVinciTracker::Superclass

Definition at line 36 of file vtkPlusIntuitiveDaVinciTracker.h.

Constructor & Destructor Documentation

◆ vtkPlusIntuitiveDaVinciTracker()

vtkPlusIntuitiveDaVinciTracker::vtkPlusIntuitiveDaVinciTracker ( )
protected

Definition at line 35 of file vtkPlusIntuitiveDaVinciTracker.cxx.

◆ ~vtkPlusIntuitiveDaVinciTracker()

vtkPlusIntuitiveDaVinciTracker::~vtkPlusIntuitiveDaVinciTracker ( )
protected

Definition at line 54 of file vtkPlusIntuitiveDaVinciTracker.cxx.

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPlusIntuitiveDaVinciTracker::GetClassName ( )
virtual

Reimplemented from vtkPlusDevice.

◆ GetDaVinci()

IntuitiveDaVinci * vtkPlusIntuitiveDaVinciTracker::GetDaVinci ( ) const

Definition at line 248 of file vtkPlusIntuitiveDaVinciTracker.cxx.

◆ GetPort()

virtual unsigned int vtkPlusIntuitiveDaVinciTracker::GetPort ( )
virtual

◆ GetSdkVersion()

std::string vtkPlusIntuitiveDaVinciTracker::GetSdkVersion ( )
virtual

Hardware device SDK version.

Reimplemented from vtkPlusDevice.

Definition at line 74 of file vtkPlusIntuitiveDaVinciTracker.cxx.

◆ InternalConnect()

PlusStatus vtkPlusIntuitiveDaVinciTracker::InternalConnect ( )
protectedvirtual

Connect to the tracker hardware

Reimplemented from vtkPlusDevice.

Definition at line 187 of file vtkPlusIntuitiveDaVinciTracker.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusIntuitiveDaVinciTracker::InternalDisconnect ( )
protectedvirtual

Disconnect from the tracker hardware

Reimplemented from vtkPlusDevice.

Definition at line 240 of file vtkPlusIntuitiveDaVinciTracker.cxx.

◆ InternalStartRecording()

PlusStatus vtkPlusIntuitiveDaVinciTracker::InternalStartRecording ( )
protectedvirtual

Start the tracking system.

Reimplemented from vtkPlusDevice.

Definition at line 118 of file vtkPlusIntuitiveDaVinciTracker.cxx.

◆ InternalStopRecording()

PlusStatus vtkPlusIntuitiveDaVinciTracker::InternalStopRecording ( )
protectedvirtual

Stop the tracking system and bring it back to its initial state.

Reimplemented from vtkPlusDevice.

Definition at line 142 of file vtkPlusIntuitiveDaVinciTracker.cxx.

◆ IsA()

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

Reimplemented from vtkPlusDevice.

◆ IsTracker()

virtual bool vtkPlusIntuitiveDaVinciTracker::IsTracker ( ) const
inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 42 of file vtkPlusIntuitiveDaVinciTracker.h.

◆ IsTypeOf()

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

◆ New()

static vtkPlusIntuitiveDaVinciTracker* vtkPlusIntuitiveDaVinciTracker::New ( )
static

◆ PrintSelf()

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

Reimplemented from vtkPlusDevice.

Definition at line 68 of file vtkPlusIntuitiveDaVinciTracker.cxx.

◆ Probe()

PlusStatus vtkPlusIntuitiveDaVinciTracker::Probe ( )
virtual

Probe to see if the tracking system is present.

Reimplemented from vtkPlusDevice.

Definition at line 80 of file vtkPlusIntuitiveDaVinciTracker.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusIntuitiveDaVinciTracker::ReadConfiguration ( vtkXMLDataElement *  rootConfigElement)
virtual

Read da Vinci configuration and update the tracker settings accordingly

Reimplemented from vtkPlusDevice.

Definition at line 150 of file vtkPlusIntuitiveDaVinciTracker.cxx.

◆ SafeDownCast()

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

◆ SetPort()

virtual void vtkPlusIntuitiveDaVinciTracker::SetPort ( unsigned int  )
virtual

◆ vtkGetStdStringMacro() [1/2]

vtkPlusIntuitiveDaVinciTracker::vtkGetStdStringMacro ( IpAddr  )

◆ vtkGetStdStringMacro() [2/2]

vtkPlusIntuitiveDaVinciTracker::vtkGetStdStringMacro ( Password  )

◆ vtkSetStdStringMacro() [1/2]

vtkPlusIntuitiveDaVinciTracker::vtkSetStdStringMacro ( IpAddr  )

◆ vtkSetStdStringMacro() [2/2]

vtkPlusIntuitiveDaVinciTracker::vtkSetStdStringMacro ( Password  )

◆ WriteConfiguration()

PlusStatus vtkPlusIntuitiveDaVinciTracker::WriteConfiguration ( vtkXMLDataElement *  rootConfigElement)
virtual

Write current da Vinci configuration settings to XML

Reimplemented from vtkPlusDevice.

Definition at line 175 of file vtkPlusIntuitiveDaVinciTracker.cxx.

Friends And Related Function Documentation

◆ vtkPlusIntuitiveDaVinciTrackerUtilities::eventCB

void vtkPlusIntuitiveDaVinciTrackerUtilities::eventCB ( ISI_MANIP_INDEX  mid,
ISI_EVENT_ID  event_id,
ISI_INT  args[ISI_NUM_EVENT_ARGS],
void *  userdata 
)
friend

◆ vtkPlusIntuitiveDaVinciTrackerUtilities::streamCB

void vtkPlusIntuitiveDaVinciTrackerUtilities::streamCB ( void *  userData)
friend

Member Data Documentation

◆ DaVinci

IntuitiveDaVinci* vtkPlusIntuitiveDaVinciTracker::DaVinci
protected

Pointer to the MicronTrackerInterface class instance

Definition at line 82 of file vtkPlusIntuitiveDaVinciTracker.h.

◆ FrameNumber

unsigned int vtkPlusIntuitiveDaVinciTracker::FrameNumber
protected

Definition at line 87 of file vtkPlusIntuitiveDaVinciTracker.h.

◆ IpAddr

std::string vtkPlusIntuitiveDaVinciTracker::IpAddr
protected

Definition at line 94 of file vtkPlusIntuitiveDaVinciTracker.h.

◆ LastFrameNumber

double vtkPlusIntuitiveDaVinciTracker::LastFrameNumber
protected

Index of the last frame number. This is used for providing a frame number when the tracker doesn't return any transform

Definition at line 85 of file vtkPlusIntuitiveDaVinciTracker.h.

◆ Password

std::string vtkPlusIntuitiveDaVinciTracker::Password
protected

Definition at line 96 of file vtkPlusIntuitiveDaVinciTracker.h.

◆ Port

unsigned int vtkPlusIntuitiveDaVinciTracker::Port
protected

Definition at line 95 of file vtkPlusIntuitiveDaVinciTracker.h.

The documentation for this class was generated from the following files:
Generated on Wed Apr 24 2024 01:45:02 for PlusLib by   doxygen 1.8.15