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
vtkPlusOpenIGTLinkVideoSource Class Reference

VTK interface for video input from OpenIGTLink image message. More...

#include <src/PlusDataCollection/OpenIGTLink/vtkPlusOpenIGTLinkVideoSource.h>

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

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
 
PlusStatus InternalUpdate ()
 
virtual int IsA (const char *type)
 
virtual bool IsTracker () const
 
virtual PlusStatus NotifyConfigured ()
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *config)
 
virtual PlusStatus WriteConfiguration (vtkXMLDataElement *config)
 
- Public Member Functions inherited from vtkPlusOpenIGTLinkDevice
virtual int GetIgtlMessageCrcCheckEnabled ()
 
virtual igsioTransformName GetImageMessageEmbeddedTransformName ()
 
virtual double GetReceiveTimeoutSec ()
 
virtual bool GetReconnectOnReceiveTimeout ()
 
virtual std::string GetSdkVersion ()
 
virtual double GetSendTimeoutSec ()
 
virtual int GetServerPort ()
 
virtual PlusStatus InternalConnect ()
 
virtual PlusStatus InternalDisconnect ()
 
virtual PlusStatus Probe ()
 
bool SendMessage (igtl::MessageBase::Pointer packedMessage)
 
virtual void SetIgtlMessageCrcCheckEnabled (int)
 
virtual void SetImageMessageEmbeddedTransformName (igsioTransformName)
 
virtual void SetImageMessageEmbeddedTransformName (std::string)
 
virtual void SetReceiveTimeoutSec (double)
 
virtual void SetSendTimeoutSec (double)
 
virtual void SetServerPort (int)
 
 vtkGetStdStringMacro (MessageType)
 
 vtkGetStdStringMacro (ServerAddress)
 
 vtkSetStdStringMacro (MessageType)
 
 vtkSetStdStringMacro (ServerAddress)
 
- 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 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 vtkPlusOpenIGTLinkVideoSourceNew ()
 
static vtkPlusOpenIGTLinkVideoSourceSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPlusOpenIGTLinkDevice
static int IsTypeOf (const char *type)
 
static vtkPlusOpenIGTLinkDeviceSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPlusDevice
static PlusStatus GetToolReferenceFrameFromTrackedFrame (igsioTrackedFrame &aFrame, std::string &aToolReferenceFrameName)
 
static int IsTypeOf (const char *type)
 
static vtkPlusDeviceNew ()
 
static vtkPlusDeviceSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPlusOpenIGTLinkVideoSource ()
 
virtual ~vtkPlusOpenIGTLinkVideoSource ()
 
- Protected Member Functions inherited from vtkPlusOpenIGTLinkDevice
virtual PlusStatus ClientSocketReconnect ()
 
void OnReceiveTimeout ()
 
virtual PlusStatus ReceiveMessageHeader (igtl::MessageHeader::Pointer &headerMsg)
 
void ReceiveMessageHeaderWithErrorHandling (igtl::MessageHeader::Pointer &headerMsg)
 
virtual PlusStatus SendRequestedMessageTypes ()
 
virtual void SetReconnectOnReceiveTimeout (bool)
 
virtual void SetUseReceivedTimestamps (bool)
 
 vtkPlusOpenIGTLinkDevice ()
 
virtual ~vtkPlusOpenIGTLinkDevice ()
 
- 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 vtkPlusDataCollectorGetDataCollector ()
 
double GetRecordingStartTime () const
 
bool GetStartThreadForInternalUpdates () const
 
bool HasGracePeriodExpired ()
 
virtual PlusStatus InternalStartRecording ()
 
virtual PlusStatus InternalStopRecording ()
 
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 vtkPlusOpenIGTLinkDevice
igtl::ClientSocket::Pointer ClientSocket
 
double DelayBetweenRetryAttemptsSec
 
int IgtlMessageCrcCheckEnabled
 
igsioTransformName ImageMessageEmbeddedTransformName
 
vtkSmartPointer< vtkPlusIgtlMessageFactoryMessageFactory
 
std::string MessageType
 
int NumberOfRetryAttempts
 
double ReceiveTimeoutSec
 
bool ReconnectOnReceiveTimeout
 
double SendTimeoutSec
 
std::string ServerAddress
 
int ServerPort
 
vtkSmartPointer< vtkIGSIORecursiveCriticalSection > SocketMutex
 
bool UseReceivedTimestamps
 
- Protected Attributes inherited from vtkPlusDevice
double AcquisitionRate
 
int Connected
 
bool CorrectlyConfigured
 
StreamBufferItemCurrentStreamBufferItem
 
vtkPlusDataCollectorDataCollector
 
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

VTK interface for video input from OpenIGTLink image message.

vtkPlusOpenIGTLinkVideoSource is a class for providing video input interfaces between VTK and OpenIGTLink ready video device.

Definition at line 23 of file vtkPlusOpenIGTLinkVideoSource.h.

Member Typedef Documentation

◆ Superclass

Definition at line 27 of file vtkPlusOpenIGTLinkVideoSource.h.

Constructor & Destructor Documentation

◆ vtkPlusOpenIGTLinkVideoSource()

vtkPlusOpenIGTLinkVideoSource::vtkPlusOpenIGTLinkVideoSource ( )
protected

Definition at line 24 of file vtkPlusOpenIGTLinkVideoSource.cxx.

◆ ~vtkPlusOpenIGTLinkVideoSource()

vtkPlusOpenIGTLinkVideoSource::~vtkPlusOpenIGTLinkVideoSource ( )
protectedvirtual

Definition at line 30 of file vtkPlusOpenIGTLinkVideoSource.cxx.

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPlusOpenIGTLinkVideoSource::GetClassName ( )
virtual

Reimplemented from vtkPlusOpenIGTLinkDevice.

◆ InternalUpdate()

PlusStatus vtkPlusOpenIGTLinkVideoSource::InternalUpdate ( )
virtual

Get an update from the tracking system and push the new transforms to the tools. This function is called by the tracker thread.

Reimplemented from vtkPlusDevice.

Definition at line 41 of file vtkPlusOpenIGTLinkVideoSource.cxx.

◆ IsA()

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

Reimplemented from vtkPlusOpenIGTLinkDevice.

◆ IsTracker()

virtual bool vtkPlusOpenIGTLinkVideoSource::IsTracker ( ) const
inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 39 of file vtkPlusOpenIGTLinkVideoSource.h.

◆ IsTypeOf()

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

◆ New()

static vtkPlusOpenIGTLinkVideoSource* vtkPlusOpenIGTLinkVideoSource::New ( )
static

◆ NotifyConfigured()

PlusStatus vtkPlusOpenIGTLinkVideoSource::NotifyConfigured ( )
virtual

Verify the device is correctly configured

Reimplemented from vtkPlusDevice.

Definition at line 167 of file vtkPlusOpenIGTLinkVideoSource.cxx.

◆ PrintSelf()

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

Reimplemented from vtkPlusOpenIGTLinkDevice.

Definition at line 35 of file vtkPlusOpenIGTLinkVideoSource.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusOpenIGTLinkVideoSource::ReadConfiguration ( vtkXMLDataElement *  config)
virtual

Read configuration from xml data

Reimplemented from vtkPlusOpenIGTLinkDevice.

Definition at line 151 of file vtkPlusOpenIGTLinkVideoSource.cxx.

◆ SafeDownCast()

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

◆ WriteConfiguration()

PlusStatus vtkPlusOpenIGTLinkVideoSource::WriteConfiguration ( vtkXMLDataElement *  config)
virtual

Write configuration to xml data

Reimplemented from vtkPlusOpenIGTLinkDevice.

Definition at line 159 of file vtkPlusOpenIGTLinkVideoSource.cxx.


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