Abstract interface for tracker and video devices. More...

#include <src/PlusDataCollection/vtkPlusDevice.h>

Inheritance diagram for vtkPlusDevice:

[legend]

Collaboration diagram for vtkPlusDevice:

[legend]

Public Types
typedef vtkImageAlgorithm	Superclass

Public Member Functions
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 const char *	GetClassName ()

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 PlusStatus	InternalUpdate ()

virtual int	IsA (const char *type)

virtual bool	IsConnected () const

virtual bool	IsRecording () const

virtual bool	IsResettable ()

virtual bool	IsTracker () const

virtual bool	IsVirtual () const

virtual PlusStatus	NotifyConfigured ()

virtual int	OutputChannelCount () const

virtual void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

virtual PlusStatus	Probe ()

virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *)

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	WriteConfiguration (vtkXMLDataElement *)

virtual PlusStatus	WriteToolsToSequenceFile (const std::string &filename, bool useCompression=false)

Static Public Member Functions
static PlusStatus	GetToolReferenceFrameFromTrackedFrame (igsioTrackedFrame &aFrame, std::string &aToolReferenceFrameName)

static int	IsTypeOf (const char *type)

static vtkPlusDevice *	New ()

static vtkPlusDevice *	SafeDownCast (vtkObject *o)

Public Attributes
double	InternalUpdateRate

vtkIGSIORecursiveCriticalSection *	UpdateMutex

vtkTimeStamp	UpdateTime

Static Public Attributes
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 Member Functions
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 PlusStatus	InternalConnect ()

virtual PlusStatus	InternalDisconnect ()

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 ()

Static Protected Member Functions
static void *	vtkDataCaptureThread (vtkMultiThreader::ThreadInfo *data)

Protected Attributes
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
static const int	VIRTUAL_DEVICE_FRAME_RATE = 50

Detailed Description

Abstract interface for tracker and video devices.

vtkPlusDevice is an abstract VTK interface to real-time tracking and imaging systems. Derived classes should override the InternalConnect(), InternalDisconnect(), GetSdkVersion(), ReadConfiguration(), WriteConfiguration() methods.

Definition at line 60 of file vtkPlusDevice.h.

Member Typedef Documentation

◆ Superclass

typedef vtkImageAlgorithm vtkPlusDevice::Superclass

Definition at line 64 of file vtkPlusDevice.h.

Constructor & Destructor Documentation

◆ vtkPlusDevice()

vtkPlusDevice::vtkPlusDevice ( )

protected

Definition at line 123 of file vtkPlusDevice.cxx.

◆ ~vtkPlusDevice()

vtkPlusDevice::~vtkPlusDevice ( )

protectedvirtual

Definition at line 154 of file vtkPlusDevice.cxx.

Member Function Documentation

◆ AddFieldDataSource()

PlusStatus vtkPlusDevice::AddFieldDataSource ( vtkPlusDataSource * aSource )

Add field data to the device

Definition at line 364 of file vtkPlusDevice.cxx.

◆ AddInputChannel()

PlusStatus vtkPlusDevice::AddInputChannel ( vtkPlusChannel * aChannel )

Add an input channel

Definition at line 2034 of file vtkPlusDevice.cxx.

◆ AddOutputChannel()

PlusStatus vtkPlusDevice::AddOutputChannel ( vtkPlusChannel * aChannel )

Add an output channel

Definition at line 2360 of file vtkPlusDevice.cxx.

◆ AddTool()

PlusStatus vtkPlusDevice::AddTool	(	vtkPlusDataSource *	tool,
		bool	requireUniquePortName = `true`
	)

Add tool to the device

Definition at line 282 of file vtkPlusDevice.cxx.

◆ AddVideoItemToVideoSources() [1/2]

PlusStatus vtkPlusDevice::AddVideoItemToVideoSources	(	const std::vector< vtkPlusDataSource * > &	videoSources,
		const igsioVideoFrame &	frame,
		long	frameNumber,
		double	unfilteredTimestamp = `UNDEFINED_TIMESTAMP`,
		double	filteredTimestamp = `UNDEFINED_TIMESTAMP`,
		const igsioFieldMapType *	customFields = `NULL`
	)

protectedvirtual

This function can be called to add a video item to the specified video data sources

Reimplemented in vtkPlusUsDevice.

Definition at line 1648 of file vtkPlusDevice.cxx.

◆ AddVideoItemToVideoSources() [2/2]

PlusStatus vtkPlusDevice::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`
	)

protectedvirtual

This function can be called to add a video item to the specified video data sources

Reimplemented in vtkPlusUsDevice.

Definition at line 1663 of file vtkPlusDevice.cxx.

◆ AddVideoSource()

PlusStatus vtkPlusDevice::AddVideoSource ( vtkPlusDataSource * anImage )

Add image to the device

Definition at line 2159 of file vtkPlusDevice.cxx.

◆ ClearAllBuffers()

void vtkPlusDevice::ClearAllBuffers ( )

Clear all tool buffers

Definition at line 1581 of file vtkPlusDevice.cxx.

◆ Connect()

PlusStatus vtkPlusDevice::Connect ( )

virtual

Connect to device. Connection is needed for recording or single frame acquisition

Definition at line 1224 of file vtkPlusDevice.cxx.

◆ CreateDefaultOutputChannel()

PlusStatus vtkPlusDevice::CreateDefaultOutputChannel	(	const char *	channelId = `NULL`,
		bool	addSource = `true`
	)

virtual

Creates a default output channel for the device with the name channelId or "OutputChannel".

Parameters

addSource If true then for imaging devices a default 'Video' source is added to the output.

Definition at line 2395 of file vtkPlusDevice.cxx.

◆ DeepCopy()

void vtkPlusDevice::DeepCopy ( const vtkPlusDevice & device )

Make this device into a copy of another device.

Definition at line 601 of file vtkPlusDevice.cxx.

◆ Disconnect()

PlusStatus vtkPlusDevice::Disconnect ( )

virtual

Disconnect from device. This method must be called before application exit, or else the application might hang during exit.

Definition at line 1249 of file vtkPlusDevice.cxx.

◆ EnsureUniqueDataSourceId()

PlusStatus vtkPlusDevice::EnsureUniqueDataSourceId ( const std::string & aSourceId )

protected

Ensure uniqueness of given ID

Definition at line 2095 of file vtkPlusDevice.cxx.

◆ FindInputChannelElement()

vtkXMLDataElement * vtkPlusDevice::FindInputChannelElement	(	vtkXMLDataElement *	rootXMLElement,
		const char *	aChannelId
	)

protected

Helper function used during configuration to locate the correct XML element for an input stream

Definition at line 900 of file vtkPlusDevice.cxx.

◆ FindOutputChannelElement()

vtkXMLDataElement * vtkPlusDevice::FindOutputChannelElement	(	vtkXMLDataElement *	rootXMLElement,
		const char *	aChannelId
	)

protected

Helper function used during configuration to locate the correct XML element for an output stream

Definition at line 869 of file vtkPlusDevice.cxx.

◆ FindThisDeviceElement()

vtkXMLDataElement * vtkPlusDevice::FindThisDeviceElement ( vtkXMLDataElement * rootXMLElement )

protected

Helper function used during configuration to locate the correct XML element for a device

Definition at line 836 of file vtkPlusDevice.cxx.

◆ ForceUpdate()

PlusStatus vtkPlusDevice::ForceUpdate ( )

virtual

Force the hardware to device to acquire a frame It requires overriding of the InternalUpdate() function in the child class.

Definition at line 1598 of file vtkPlusDevice.cxx.

◆ GetAcquisitionRate()

double vtkPlusDevice::GetAcquisitionRate ( ) const

virtual

Set the acquisition rate

Reimplemented in vtkPlusVirtualVolumeReconstructor, vtkPlusVirtualDeinterlacer, vtkPlusVirtualMixer, and vtkPlusVirtualSwitcher.

Definition at line 2063 of file vtkPlusDevice.cxx.

◆ GetBufferSize()

PlusStatus vtkPlusDevice::GetBufferSize	(	vtkPlusChannel &	aChannel,
		int &	outVal,
		const std::string &	aSourceId = `std::string("")`
	)

virtual

Get size of the internal frame buffer.

Definition at line 1425 of file vtkPlusDevice.cxx.

◆ GetClassName()

virtual const char* vtkPlusDevice::GetClassName ( )

virtual

Reimplemented in vtkPlusNDITracker, vtkPlusSonixVideoSource, vtkPlusVirtualTextRecognizer, vtkPlusPhidgetSpatialTracker, vtkPlusMmfVideoSource, vtkPlusBkProFocusCameraLinkVideoSource, vtkPlusWin32VideoSource2, vtkPlusBrachyTracker, vtkPlusFakeTracker, vtkPlusV4L2VideoSource, vtkPlusOptimetConoProbeMeasurer, vtkPlusIntersonArraySDKCxxVideoSource, vtkPlusIntersonSDKCxxVideoSource, vtkPlusVirtualDeinterlacer, vtkPlusAgilentScopeTracker, vtkPlusNDICertusTracker, vtkPlusICCapturingSource, vtkPlusIntuitiveDaVinciTracker, vtkPlusOpenCVCaptureVideoSource, vtkPlusSavedDataSource, vtkPlusUSDigitalEncodersTracker, vtkPlusDeckLinkVideoSource, vtkPlusTelemedVideoSource, vtkPlusUsDevice, vtkPlusChRoboticsTracker, vtkPlusInfraredTEEV2Cam, vtkInfraredTEQ1Cam, vtkPlus3dConnexionTracker, vtkPlusAndorVideoSource, vtkPlusClariusOEM, vtkInfraredSeekCam, vtkPlusLeapMotion, vtkPlusOpticalMarkerTracker, vtkPlusStealthLinkTracker, vtkPlusGenericSerialDevice, vtkPlusWinProbeVideoSource, vtkPlusOpenHapticsDevice, vtkPlusOpenIGTLinkDevice, vtkPlusBkProFocusOemVideoSource, vtkPlusCapistranoVideoSource, vtkPlusImageProcessorVideoSource, vtkPlusNvidiaDVPVideoSource, vtkPlusOvrvisionProVideoSource, vtkPlusUsSimulatorVideoSource, vtkPlusClarius, vtkPlusEpiphanVideoSource, vtkPlusGenericSensorTracker, vtkPlusOpenIGTLinkVideoSource, vtkPlusVirtualCapture, vtkPlusVirtualVolumeReconstructor, vtkPlusAtracsysTracker, vtkPlusDAQVideoSource, vtkPlusIntersonVideoSource, vtkPlusMicronTracker, vtkPlusPhilips3DProbeVideoSource, vtkPlusThorLabsVideoSource, vtkPlusUltravioletPCOUVCam, vtkPlusVirtualMixer, vtkPlusMicrochipTracker, vtkPlusOpenIGTLinkTracker, vtkPlusSpinnakerVideoSource, vtkPlusVirtualSwitcher, vtkPlusAscension3DGTrackerBase, vtkPlusAzureKinect, vtkPlusIntelRealSense, vtkPlusOptiTrack, vtkPlusPicoScopeDataSource, vtkPlusSteamVRTracker, vtkPlusNvidiaDVPVideoSource, vtkPlusRevopoint3DCamera, and vtkPlusWitMotionTracker.

◆ GetConnected()

int vtkPlusDevice::GetConnected ( ) const

virtual

Are we connected?

Definition at line 1824 of file vtkPlusDevice.cxx.

◆ GetCorrectlyConfigured()

bool vtkPlusDevice::GetCorrectlyConfigured ( ) const

virtual

Is the device correctly configured?

Definition at line 830 of file vtkPlusDevice.cxx.

◆ GetDataCollector()

vtkPlusDataCollector * vtkPlusDevice::GetDataCollector ( )

protectedvirtual

Reimplemented in vtkPlusVirtualVolumeReconstructor, and vtkPlusVirtualCapture.

Definition at line 2135 of file vtkPlusDevice.cxx.

◆ GetDataSource() [1/2]

PlusStatus vtkPlusDevice::GetDataSource	(	const char *	aSourceId,
		vtkPlusDataSource *&	aSource
	)

Get the data source object for the specified Id name, checks both video and tools

Definition at line 2262 of file vtkPlusDevice.cxx.

◆ GetDataSource() [2/2]

PlusStatus vtkPlusDevice::GetDataSource	(	const std::string &	aSourceId,
		vtkPlusDataSource *&	aSource
	)

Definition at line 2283 of file vtkPlusDevice.cxx.

◆ GetDesiredTimestamp()

virtual double vtkPlusDevice::GetDesiredTimestamp ( )

virtual

Get the desired timestamp

◆ GetDeviceId()

std::string vtkPlusDevice::GetDeviceId ( ) const

virtual

Definition at line 691 of file vtkPlusDevice.cxx.

◆ GetFieldDataSource() [1/2]

PlusStatus vtkPlusDevice::GetFieldDataSource	(	const char *	aSourceId,
		vtkPlusDataSource *&	aSource
	)		const

Get the field data source for the specified field data id

Definition at line 328 of file vtkPlusDevice.cxx.

◆ GetFieldDataSource() [2/2]

PlusStatus vtkPlusDevice::GetFieldDataSource	(	const std::string &	aSourceId,
		vtkPlusDataSource *&	aSource
	)		const

Definition at line 340 of file vtkPlusDevice.cxx.

◆ GetFieldDataSourcessIteratorBegin()

DataSourceContainerConstIterator vtkPlusDevice::GetFieldDataSourcessIteratorBegin ( ) const

Get the beginning of the field data iterator

Definition at line 352 of file vtkPlusDevice.cxx.

◆ GetFieldDataSourcessIteratorEnd()

DataSourceContainerConstIterator vtkPlusDevice::GetFieldDataSourcessIteratorEnd ( ) const

Get the end of the field data iterator

Definition at line 358 of file vtkPlusDevice.cxx.

◆ GetFirstActiveOutputVideoSource()

PlusStatus vtkPlusDevice::GetFirstActiveOutputVideoSource ( vtkPlusDataSource *& aVideoSource )

Convenience function for getting the first available video source in the output channels

Definition at line 2439 of file vtkPlusDevice.cxx.

◆ GetFirstActiveTool()

PlusStatus vtkPlusDevice::GetFirstActiveTool ( vtkPlusDataSource *& aTool ) const

Get the first active tool among all the source tools

Definition at line 398 of file vtkPlusDevice.cxx.

◆ GetFirstOutputChannel()

PlusStatus vtkPlusDevice::GetFirstOutputChannel ( vtkPlusChannel *& aChannel )

Access the available output channels

Definition at line 1986 of file vtkPlusDevice.cxx.

◆ GetFirstVideoSource()

PlusStatus vtkPlusDevice::GetFirstVideoSource ( vtkPlusDataSource *& anImage )

Get the first active image object

Definition at line 2200 of file vtkPlusDevice.cxx.

◆ GetFrameNumber()

unsigned long vtkPlusDevice::GetFrameNumber ( ) const

virtual

Get the frame number (some devices has frame numbering, otherwise just increment if new frame received)

Definition at line 703 of file vtkPlusDevice.cxx.

◆ GetFrameTimeStamp()

double vtkPlusDevice::GetFrameTimeStamp ( ) const

virtual

Get a time stamp in seconds (resolution of milliseconds) for the most recent frame. Time began on Jan 1, 1970. This timestamp is only valid after the Output has been Updated. Usually set to the timestamp for the output if UpdateWithDesiredTimestamp is off, otherwise it is the timestamp for the most recent frame, which is not necessarily the output

Definition at line 709 of file vtkPlusDevice.cxx.

◆ GetImage()

PlusStatus vtkPlusDevice::GetImage	(	const std::string &	requestedImageId,
		std::string &	assignedImageId,
		const std::string &	imageReferencFrameName,
		vtkImageData *	imageData,
		vtkMatrix4x4 *	ijkToReferenceTransform
	)

virtual

Return the specified volume from the corresponding device. The assignedImageId and requestedImageId should be the same If requestedImageId is empty then GetImage will return the default image and set assignedImageId to the ID of this default image. If requestedImageId is not empty then assignedImageId is the same as the requestedImageId.

Reimplemented in vtkPlusStealthLinkTracker.

Definition at line 2468 of file vtkPlusDevice.cxx.

◆ GetImageMetaData()

PlusStatus vtkPlusDevice::GetImageMetaData ( igsioCommon::ImageMetaDataList & imageMetaDataItems )

virtual

Return a list of items that describe what image volumes this device can provide

Reimplemented in vtkPlusStealthLinkTracker.

Definition at line 2461 of file vtkPlusDevice.cxx.

◆ GetImageType()

US_IMAGE_TYPE vtkPlusDevice::GetImageType ( vtkPlusChannel & aChannel )

virtual

Get the image pixel type (B-mode, RF, ...)

Definition at line 1961 of file vtkPlusDevice.cxx.

◆ GetInputDevices()

PlusStatus vtkPlusDevice::GetInputDevices ( std::vector< vtkPlusDevice * > & outDeviceList ) const

Build a list of all of the input devices directly connected to this device (if any)

Definition at line 546 of file vtkPlusDevice.cxx.

◆ GetInputDevicesRecursive()

PlusStatus vtkPlusDevice::GetInputDevicesRecursive ( std::vector< vtkPlusDevice * > & outDeviceList ) const

Recursively assemble all devices that feed into this device (if any)

Definition at line 558 of file vtkPlusDevice.cxx.

◆ GetInputFrameSize() [1/2]

PlusStatus vtkPlusDevice::GetInputFrameSize	(	vtkPlusChannel &	aChannel,
		unsigned int &	x,
		unsigned int &	y,
		unsigned int &	z
	)		const

virtual

Get the full-frame size

Definition at line 1897 of file vtkPlusDevice.cxx.

◆ GetInputFrameSize() [2/2]

PlusStatus vtkPlusDevice::GetInputFrameSize	(	vtkPlusChannel &	aChannel,
		FrameSizeType &	dim
	)		const

virtual

Get the full-frame size

Definition at line 1915 of file vtkPlusDevice.cxx.

◆ GetInternalUpdateRate()

double vtkPlusDevice::GetInternalUpdateRate ( ) const

Get the internal update rate for this tracking system. This is the number of buffer entry items sent by the device per second (per tool).

Definition at line 663 of file vtkPlusDevice.cxx.

◆ GetLocalTimeOffsetSec()

double vtkPlusDevice::GetLocalTimeOffsetSec ( ) const

virtual

Definition at line 534 of file vtkPlusDevice.cxx.

◆ GetMissingInputGracePeriodSec()

double vtkPlusDevice::GetMissingInputGracePeriodSec ( ) const

Definition at line 2389 of file vtkPlusDevice.cxx.

◆ GetNumberOfFieldDataSources()

int vtkPlusDevice::GetNumberOfFieldDataSources ( ) const

virtual

Get number of field data sources

Definition at line 392 of file vtkPlusDevice.cxx.

◆ GetNumberOfTools()

int vtkPlusDevice::GetNumberOfTools ( ) const

virtual

Get number of images

Definition at line 276 of file vtkPlusDevice.cxx.

◆ GetNumberOfVideoSources()

int vtkPlusDevice::GetNumberOfVideoSources ( ) const

virtual

Get number of images

Definition at line 2153 of file vtkPlusDevice.cxx.

◆ GetOutputChannelByName() [1/2]

PlusStatus vtkPlusDevice::GetOutputChannelByName	(	vtkPlusChannel *&	aChannel,
		const char *	aChannelId
	)

Definition at line 2000 of file vtkPlusDevice.cxx.

◆ GetOutputChannelByName() [2/2]

PlusStatus vtkPlusDevice::GetOutputChannelByName	(	vtkPlusChannel *&	aChannel,
		const std::string &	aChannelId
	)

Definition at line 2022 of file vtkPlusDevice.cxx.

◆ GetOutputChannelsEnd() [1/2]

ChannelContainerConstIterator vtkPlusDevice::GetOutputChannelsEnd ( ) const

Definition at line 2301 of file vtkPlusDevice.cxx.

◆ GetOutputChannelsEnd() [2/2]

ChannelContainerIterator vtkPlusDevice::GetOutputChannelsEnd ( )

Definition at line 2307 of file vtkPlusDevice.cxx.

◆ GetOutputChannelsStart() [1/2]

ChannelContainerConstIterator vtkPlusDevice::GetOutputChannelsStart ( ) const

Definition at line 2289 of file vtkPlusDevice.cxx.

◆ GetOutputChannelsStart() [2/2]

ChannelContainerIterator vtkPlusDevice::GetOutputChannelsStart ( )

Definition at line 2295 of file vtkPlusDevice.cxx.

◆ GetOutputFrameSize() [1/2]

PlusStatus vtkPlusDevice::GetOutputFrameSize	(	vtkPlusChannel &	aChannel,
		unsigned int &	x,
		unsigned int &	y,
		unsigned int &	z
	)		const

virtual

Get the full-frame size

Definition at line 1863 of file vtkPlusDevice.cxx.

◆ GetOutputFrameSize() [2/2]

PlusStatus vtkPlusDevice::GetOutputFrameSize	(	vtkPlusChannel &	aChannel,
		FrameSizeType &	dim
	)		const

virtual

Get the full-frame size

Definition at line 1881 of file vtkPlusDevice.cxx.

◆ GetParameter() [1/2]

std::string vtkPlusDevice::GetParameter ( const std::string & key ) const

virtual

Reimplemented in vtkPlusUsDevice.

Definition at line 578 of file vtkPlusDevice.cxx.

◆ GetParameter() [2/2]

PlusStatus vtkPlusDevice::GetParameter	(	const std::string &	key,
		std::string &	outValue
	)		const

virtual

Reimplemented in vtkPlusUsDevice.

Definition at line 589 of file vtkPlusDevice.cxx.

◆ GetPixelType()

igsioCommon::VTKScalarPixelType vtkPlusDevice::GetPixelType ( vtkPlusChannel & aChannel )

virtual

Get the pixel type (char, unsigned short, ...)

Definition at line 1946 of file vtkPlusDevice.cxx.

◆ GetRecordingStartTime()

double vtkPlusDevice::GetRecordingStartTime ( ) const

protected

Definition at line 2129 of file vtkPlusDevice.cxx.

◆ GetSdkVersion()

std::string vtkPlusDevice::GetSdkVersion ( )

virtual

Hardware device SDK version. This method should be overridden in subclasses.

Reimplemented in vtkPlusNDITracker, vtkPlusTelemedVideoSource, vtkPlusSonixVideoSource, vtkPlusCapistranoVideoSource, vtkPlusICCapturingSource, vtkPlusIntersonArraySDKCxxVideoSource, vtkPlusIntersonSDKCxxVideoSource, vtkPlusAndorVideoSource, vtkPlusClarius, vtkPlusNDICertusTracker, vtkPlusIntuitiveDaVinciTracker, vtkPlusClariusOEM, vtkPlusIntersonVideoSource, vtkPlusOpenIGTLinkDevice, vtkPlusOpenHapticsDevice, vtkPlusAtracsysTracker, and vtkPlusMicronTracker.

Definition at line 241 of file vtkPlusDevice.cxx.

◆ GetStartThreadForInternalUpdates()

bool vtkPlusDevice::GetStartThreadForInternalUpdates ( ) const

protected

Definition at line 2123 of file vtkPlusDevice.cxx.

◆ GetStartTime()

double vtkPlusDevice::GetStartTime ( )

virtual

Get recording start time

Definition at line 1535 of file vtkPlusDevice.cxx.

◆ GetTimestampClosestToDesired()

virtual double vtkPlusDevice::GetTimestampClosestToDesired ( )

virtual

Get the timestamp for the video frame returned with desired timestamping

◆ GetTool() [1/2]

PlusStatus vtkPlusDevice::GetTool	(	const char *	aToolSourceId,
		vtkPlusDataSource *&	aTool
	)		const

Get the tool object for the specified tool name

Definition at line 413 of file vtkPlusDevice.cxx.

◆ GetTool() [2/2]

PlusStatus vtkPlusDevice::GetTool	(	const std::string &	aToolSourceId,
		vtkPlusDataSource *&	aTool
	)		const

Definition at line 431 of file vtkPlusDevice.cxx.

◆ GetToolByPortName() [1/2]

PlusStatus vtkPlusDevice::GetToolByPortName	(	const char *	aPortName,
		vtkPlusDataSource *&	aSource
	)

Get the tool object for the specified tool port name

Definition at line 437 of file vtkPlusDevice.cxx.

◆ GetToolByPortName() [2/2]

PlusStatus vtkPlusDevice::GetToolByPortName	(	const std::string &	aPortName,
		vtkPlusDataSource *&	aSource
	)

Definition at line 449 of file vtkPlusDevice.cxx.

◆ GetToolIteratorBegin()

DataSourceContainerConstIterator vtkPlusDevice::GetToolIteratorBegin ( ) const

Get the beginning of the tool iterator

Definition at line 264 of file vtkPlusDevice.cxx.

◆ GetToolIteratorEnd()

DataSourceContainerConstIterator vtkPlusDevice::GetToolIteratorEnd ( ) const

Get the end of the tool iterator

Definition at line 270 of file vtkPlusDevice.cxx.

◆ GetToolReferenceFrameFromTrackedFrame()

PlusStatus vtkPlusDevice::GetToolReferenceFrameFromTrackedFrame	(	igsioTrackedFrame &	aFrame,
		std::string &	aToolReferenceFrameName
	)

static

Return the reference frame

Definition at line 2313 of file vtkPlusDevice.cxx.

◆ GetToolReferenceFrameName()

std::string vtkPlusDevice::GetToolReferenceFrameName ( ) const

Get Reference name of the tools

Definition at line 824 of file vtkPlusDevice.cxx.

◆ GetUpdateWithDesiredTimestamp()

virtual int vtkPlusDevice::GetUpdateWithDesiredTimestamp ( )

virtual

The result of GetOutput() will be the frame closest to DesiredTimestamp if it is set and if UpdateWithDesiredTimestamp is set on (default off)

◆ GetVideoSource()

PlusStatus vtkPlusDevice::GetVideoSource	(	const char *	aSourceId,
		vtkPlusDataSource *&	aVideoSource
	)

Get the video source for the specified source name

Definition at line 2214 of file vtkPlusDevice.cxx.

◆ GetVideoSourceByIndex()

PlusStatus vtkPlusDevice::GetVideoSourceByIndex	(	const unsigned int	index,
		vtkPlusDataSource *&	aVideoSource
	)

Get the video source for the specified source index

Definition at line 2243 of file vtkPlusDevice.cxx.

◆ GetVideoSourceIteratorBegin()

DataSourceContainerConstIterator vtkPlusDevice::GetVideoSourceIteratorBegin ( ) const

Get the beginning of the image iterator

Definition at line 2141 of file vtkPlusDevice.cxx.

◆ GetVideoSourceIteratorEnd()

DataSourceContainerConstIterator vtkPlusDevice::GetVideoSourceIteratorEnd ( ) const

Get the end of the image iterator

Definition at line 2147 of file vtkPlusDevice.cxx.

◆ GetVideoSources()

std::vector< vtkPlusDataSource * > vtkPlusDevice::GetVideoSources ( ) const

Get all video sources

Definition at line 2232 of file vtkPlusDevice.cxx.

◆ GetVideoSourcesByPortName() [1/2]

PlusStatus vtkPlusDevice::GetVideoSourcesByPortName	(	const char *	aPortName,
		std::vector< vtkPlusDataSource * > &	sources
	)

Get the video source objects for the specified video port name

Definition at line 464 of file vtkPlusDevice.cxx.

◆ GetVideoSourcesByPortName() [2/2]

PlusStatus vtkPlusDevice::GetVideoSourcesByPortName	(	const std::string &	aPortName,
		std::vector< vtkPlusDataSource * > &	sources
	)

Definition at line 476 of file vtkPlusDevice.cxx.

◆ HasGracePeriodExpired()

bool vtkPlusDevice::HasGracePeriodExpired ( )

protected

Definition at line 2383 of file vtkPlusDevice.cxx.

◆ InternalConnect()

PlusStatus vtkPlusDevice::InternalConnect ( )

protectedvirtual

Should be overridden to connect to the hardware

Definition at line 1401 of file vtkPlusDevice.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusDevice::InternalDisconnect ( )

protectedvirtual

Release the video driver. Should be overridden to disconnect from the hardware.

Definition at line 1407 of file vtkPlusDevice.cxx.

◆ InternalStartRecording()

PlusStatus vtkPlusDevice::InternalStartRecording ( )

protectedvirtual

Called at the end of StartRecording to allow hardware-specific actions for starting the recording

Definition at line 1413 of file vtkPlusDevice.cxx.

◆ InternalStopRecording()

PlusStatus vtkPlusDevice::InternalStopRecording ( )

protectedvirtual

Called at the beginning of StopRecording to allow hardware-specific actions for stopping the recording

Definition at line 1419 of file vtkPlusDevice.cxx.

◆ InternalUpdate()

PlusStatus vtkPlusDevice::InternalUpdate ( )

virtual

The subclass will do all the hardware-specific update stuff in this function. It should call ToolUpdate() for each tool. Note that vtkPlusDevice.cxx starts up a separate thread after InternalStartRecording() is called, and that InternalUpdate() is called repeatedly from within that thread. Therefore, any code within InternalUpdate() must be thread safe. You can temporarily pause the thread by locking this->UpdateMutex->Lock() e.g. if you need to communicate with the device from outside of InternalUpdate(). A call to this->UpdateMutex->Unlock() will resume the thread.

Definition at line 540 of file vtkPlusDevice.cxx.

◆ InternalWriteInputChannels()

void vtkPlusDevice::InternalWriteInputChannels ( vtkXMLDataElement * rootXMLElement )

protectedvirtual

Method that writes output streams to XML

Definition at line 2082 of file vtkPlusDevice.cxx.

◆ InternalWriteOutputChannels()

void vtkPlusDevice::InternalWriteOutputChannels ( vtkXMLDataElement * rootXMLElement )

protectedvirtual

Method that writes output streams to XML

Reimplemented in vtkPlusVirtualVolumeReconstructor, and vtkPlusVirtualCapture.

Definition at line 2069 of file vtkPlusDevice.cxx.

◆ IsA()

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

virtual

Reimplemented in vtkPlusNDITracker, vtkPlusSonixVideoSource, vtkPlusVirtualTextRecognizer, vtkPlusPhidgetSpatialTracker, vtkPlusMmfVideoSource, vtkPlusBkProFocusCameraLinkVideoSource, vtkPlusWin32VideoSource2, vtkPlusBrachyTracker, vtkPlusFakeTracker, vtkPlusV4L2VideoSource, vtkPlusOptimetConoProbeMeasurer, vtkPlusIntersonArraySDKCxxVideoSource, vtkPlusIntersonSDKCxxVideoSource, vtkPlusVirtualDeinterlacer, vtkPlusAgilentScopeTracker, vtkPlusNDICertusTracker, vtkPlusICCapturingSource, vtkPlusIntuitiveDaVinciTracker, vtkPlusOpenCVCaptureVideoSource, vtkPlusSavedDataSource, vtkPlusUSDigitalEncodersTracker, vtkPlusDeckLinkVideoSource, vtkPlusTelemedVideoSource, vtkPlusUsDevice, vtkPlusChRoboticsTracker, vtkPlusInfraredTEEV2Cam, vtkInfraredTEQ1Cam, vtkPlus3dConnexionTracker, vtkPlusAndorVideoSource, vtkPlusClariusOEM, vtkInfraredSeekCam, vtkPlusLeapMotion, vtkPlusOpticalMarkerTracker, vtkPlusStealthLinkTracker, vtkPlusGenericSerialDevice, vtkPlusWinProbeVideoSource, vtkPlusOpenHapticsDevice, vtkPlusOpenIGTLinkDevice, vtkPlusBkProFocusOemVideoSource, vtkPlusCapistranoVideoSource, vtkPlusImageProcessorVideoSource, vtkPlusNvidiaDVPVideoSource, vtkPlusOvrvisionProVideoSource, vtkPlusUsSimulatorVideoSource, vtkPlusClarius, vtkPlusEpiphanVideoSource, vtkPlusGenericSensorTracker, vtkPlusOpenIGTLinkVideoSource, vtkPlusVirtualCapture, vtkPlusVirtualVolumeReconstructor, vtkPlusAtracsysTracker, vtkPlusDAQVideoSource, vtkPlusIntersonVideoSource, vtkPlusMicronTracker, vtkPlusPhilips3DProbeVideoSource, vtkPlusThorLabsVideoSource, vtkPlusUltravioletPCOUVCam, vtkPlusVirtualMixer, vtkPlusMicrochipTracker, vtkPlusOpenIGTLinkTracker, vtkPlusSpinnakerVideoSource, vtkPlusVirtualSwitcher, vtkPlusAscension3DGTrackerBase, vtkPlusAzureKinect, vtkPlusIntelRealSense, vtkPlusOptiTrack, vtkPlusPicoScopeDataSource, vtkPlusSteamVRTracker, vtkPlusNvidiaDVPVideoSource, vtkPlusRevopoint3DCamera, and vtkPlusWitMotionTracker.

◆ IsConnected()

bool vtkPlusDevice::IsConnected ( ) const

virtual

Definition at line 1830 of file vtkPlusDevice.cxx.

◆ IsRecording()

bool vtkPlusDevice::IsRecording ( ) const

virtual

Get whether recording is underway

Definition at line 685 of file vtkPlusDevice.cxx.

◆ IsResettable()

bool vtkPlusDevice::IsResettable ( )

virtual

Return whether or not the device can be reset

Reimplemented in vtkPlusPhidgetSpatialTracker, and vtkPlusVirtualMixer.

Definition at line 249 of file vtkPlusDevice.cxx.

◆ IsTracker()

bool vtkPlusDevice::IsTracker ( ) const

virtual

Is this device a tracker

Definition at line 2347 of file vtkPlusDevice.cxx.

◆ IsTypeOf()

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

static

◆ IsVirtual()

bool vtkPlusDevice::IsVirtual ( ) const

virtual

Reimplemented in vtkPlusVirtualVolumeReconstructor, vtkPlusVirtualCapture, vtkPlusVirtualTextRecognizer, vtkPlusAtracsysTracker, vtkPlusOpticalMarkerTracker, vtkPlusAzureKinect, vtkPlusImageProcessorVideoSource, vtkPlusVirtualDeinterlacer, vtkPlusRevopoint3DCamera, vtkPlusIntelRealSense, vtkPlusVirtualSwitcher, vtkPlusClariusOEM, vtkPlusDeckLinkVideoSource, vtkPlusSpinnakerVideoSource, vtkPlusVirtualMixer, vtkPlusOptiTrack, and vtkPlusPicoScopeDataSource.

Definition at line 2354 of file vtkPlusDevice.cxx.

◆ New()

static vtkPlusDevice* vtkPlusDevice::New ( )

static

◆ NotifyConfigured()

PlusStatus vtkPlusDevice::NotifyConfigured ( )

virtual

Perform any completion tasks once configured

Definition at line 2057 of file vtkPlusDevice.cxx.

◆ OutputChannelCount()

int vtkPlusDevice::OutputChannelCount ( ) const

virtual

Reimplemented in vtkPlusVirtualVolumeReconstructor, and vtkPlusVirtualCapture.

Definition at line 2028 of file vtkPlusDevice.cxx.

◆ PrintSelf()

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

virtual

Definition at line 195 of file vtkPlusDevice.cxx.

◆ Probe()

PlusStatus vtkPlusDevice::Probe ( )

virtual

Probe to see to see if the device is connected to the computer. This method should be overridden in subclasses.

Reimplemented in vtkPlusNDITracker, vtkPlusSavedDataSource, vtkPlusPhidgetSpatialTracker, vtkPlusAtracsysTracker, vtkPlusUSDigitalEncodersTracker, vtkPlusBrachyTracker, vtkPlusNDICertusTracker, vtkPlusFakeTracker, vtkPlusAgilentScopeTracker, vtkPlusAscension3DGTrackerBase, vtkPlusDeckLinkVideoSource, vtkPlusIntuitiveDaVinciTracker, vtkPlusClarius, vtkPlusOptiTrack, vtkPlusPicoScopeDataSource, vtkPlusChRoboticsTracker, vtkPlusOpenIGTLinkDevice, vtkPlus3dConnexionTracker, vtkPlusGenericSensorTracker, vtkPlusOpenHapticsDevice, vtkPlusClariusOEM, vtkPlusLeapMotion, vtkPlusMicronTracker, and vtkPlusSteamVRTracker.

Definition at line 1563 of file vtkPlusDevice.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusDevice::ReadConfiguration ( vtkXMLDataElement * rootXMLElement )

virtual

Read main configuration from xml data

Definition at line 929 of file vtkPlusDevice.cxx.

◆ RequestData()

int vtkPlusDevice::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

virtual

Return the latest or desired image frame. This method can be overridden in subclasses Part of the vtkAlgorithm pipeline

Definition at line 1754 of file vtkPlusDevice.cxx.

◆ RequestInformation()

int vtkPlusDevice::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

virtual

Return the latest or desired image frame. This method can be overridden in subclasses Part of the vtkAlgorithm pipeline

Definition at line 1706 of file vtkPlusDevice.cxx.

◆ Reset()

PlusStatus vtkPlusDevice::Reset ( )

virtual

Reset the device. The actual reset action is defined in subclasses. A reset is typically performed on the users request while the device is connected. A reset can be used for zeroing sensors, canceling an operation in progress, etc.

Reimplemented in vtkPlusPhidgetSpatialTracker, vtkPlusVirtualVolumeReconstructor, vtkPlusVirtualCapture, and vtkPlusVirtualMixer.

Definition at line 256 of file vtkPlusDevice.cxx.

◆ SafeDownCast()

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

static

◆ SendText()

PlusStatus vtkPlusDevice::SendText	(	const std::string &	textToSend,
		std::string *	textReceived = `NULL`
	)

virtual

Send text message to the device. If a non-NULL pointer is passed as textReceived then the device waits for a response and returns it in textReceived.

Reimplemented in vtkPlusGenericSerialDevice.

Definition at line 2475 of file vtkPlusDevice.cxx.

◆ SetAcquisitionRate()

PlusStatus vtkPlusDevice::SetAcquisitionRate ( double aRate )

Definition at line 669 of file vtkPlusDevice.cxx.

◆ SetBufferSize()

PlusStatus vtkPlusDevice::SetBufferSize	(	vtkPlusChannel &	aChannel,
		int	FrameBufferSize,
		const std::string &	aSourceId = `std::string("")`
	)

virtual

Get the buffer that is used to hold the data There are cases when multiple externally controlled buffers are needed. There must always be a valid buffer in the data object, therefore the input parameter shall not be NULL.

Set size of the internal frame buffer, i.e. the number of most recent frames that are stored in the video source class internally.

Definition at line 1468 of file vtkPlusDevice.cxx.

◆ SetCorrectlyConfigured()

virtual void vtkPlusDevice::SetCorrectlyConfigured ( bool )

protectedvirtual

◆ SetDataCollector()

void vtkPlusDevice::SetDataCollector ( vtkPlusDataCollector * _arg )

virtual

Set the parent data collector

Definition at line 2377 of file vtkPlusDevice.cxx.

◆ SetDesiredTimestamp()

virtual void vtkPlusDevice::SetDesiredTimestamp ( double )

virtual

Set the desired timestamp. The result of GetOutput() will be the frame closest to DesiredTimestamp if it is set and if UpdateWithDesiredTimestamp is set on (default off)

◆ SetDeviceId()

void vtkPlusDevice::SetDeviceId ( const std::string & id )

Definition at line 697 of file vtkPlusDevice.cxx.

◆ SetFieldDataSourcesBufferSize()

void vtkPlusDevice::SetFieldDataSourcesBufferSize ( int aBufferSize )

Set buffer size of all available field data sources

Definition at line 507 of file vtkPlusDevice.cxx.

◆ SetImageType()

PlusStatus vtkPlusDevice::SetImageType	(	vtkPlusChannel &	aChannel,
		US_IMAGE_TYPE	imageType
	)

virtual

Set the image type (B-mode, RF, ...) provided by the video source.

Definition at line 1974 of file vtkPlusDevice.cxx.

◆ SetInputFrameSize()

PlusStatus vtkPlusDevice::SetInputFrameSize	(	vtkPlusDataSource &	aSource,
		unsigned int	x,
		unsigned int	y,
		unsigned int	z
	)

virtual

Set the full-frame size. This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size.

Definition at line 1836 of file vtkPlusDevice.cxx.

◆ SetLocalTimeOffsetSec()

void vtkPlusDevice::SetLocalTimeOffsetSec ( double aTimeOffsetSec )

virtual

Set local time offset of all available buffers

Definition at line 517 of file vtkPlusDevice.cxx.

◆ SetMissingInputGracePeriodSec()

virtual void vtkPlusDevice::SetMissingInputGracePeriodSec ( double )

virtual

◆ SetParameter()

PlusStatus vtkPlusDevice::SetParameter	(	const std::string &	key,
		const std::string &	value
	)

virtual

Reimplemented in vtkPlusUsDevice.

Definition at line 570 of file vtkPlusDevice.cxx.

◆ SetPixelType()

PlusStatus vtkPlusDevice::SetPixelType	(	vtkPlusChannel &	aChannel,
		igsioCommon::VTKScalarPixelType	pixelType
	)

virtual

Set the pixel type (char, unsigned short, ...)

Definition at line 1931 of file vtkPlusDevice.cxx.

◆ SetRecordingStartTime()

virtual void vtkPlusDevice::SetRecordingStartTime ( double )

protectedvirtual

◆ SetStartThreadForInternalUpdates()

virtual void vtkPlusDevice::SetStartThreadForInternalUpdates ( bool )

protectedvirtual

◆ SetStartTime()

void vtkPlusDevice::SetStartTime ( double startTime )

virtual

Set recording start time

Definition at line 1516 of file vtkPlusDevice.cxx.

◆ SetToolReferenceFrameName()

void vtkPlusDevice::SetToolReferenceFrameName ( const std::string & frameName )

Set Reference name of the tools

Definition at line 818 of file vtkPlusDevice.cxx.

◆ SetToolsBufferSize()

void vtkPlusDevice::SetToolsBufferSize ( int aBufferSize )

Set buffer size of all available tools

Definition at line 497 of file vtkPlusDevice.cxx.

◆ SetUpdateWithDesiredTimestamp()

virtual void vtkPlusDevice::SetUpdateWithDesiredTimestamp ( int )

virtual

The result of GetOutput() will be the frame closest to DesiredTimestamp if it is set and if UpdateWithDesiredTimestamp is set on (default off)

◆ StartRecording()

PlusStatus vtkPlusDevice::StartRecording ( )

virtual

Record incoming data at the specified acquisition rate. The recording continues indefinitely until StopRecording() is called.

Definition at line 1273 of file vtkPlusDevice.cxx.

◆ StopRecording()

PlusStatus vtkPlusDevice::StopRecording ( )

virtual

Stop recording

Definition at line 1316 of file vtkPlusDevice.cxx.

◆ ToolTimeStampedUpdate()

PlusStatus vtkPlusDevice::ToolTimeStampedUpdate	(	const std::string &	aToolSourceId,
		vtkMatrix4x4 *	matrix,
		ToolStatus	status,
		unsigned long	frameNumber,
		double	unfilteredtimestamp,
		const igsioFieldMapType *	customFields = `NULL`
	)

protectedvirtual

This function is called by InternalUpdate() so that the subclasses can communicate information back to the vtkPlusDevice base class, which will in turn relay the information to the appropriate vtkPlusDataSource.

Definition at line 1678 of file vtkPlusDevice.cxx.

◆ ToolTimeStampedUpdateWithoutFiltering()

PlusStatus vtkPlusDevice::ToolTimeStampedUpdateWithoutFiltering	(	const std::string &	aToolSourceId,
		vtkMatrix4x4 *	matrix,
		ToolStatus	status,
		double	unfilteredtimestamp,
		double	filteredtimestamp,
		const igsioFieldMapType *	customFields = `NULL`
	)

protectedvirtual

This function is called by InternalUpdate() so that the subclasses can communicate information back to the vtkPlusDevice base class, which will in turn relay the information to the appropriate vtkPlusDataSource. This function is for devices has no frame numbering, just auto increment tool frame number if new frame received

Definition at line 1619 of file vtkPlusDevice.cxx.

◆ UpdateWithDesiredTimestampOff()

virtual void vtkPlusDevice::UpdateWithDesiredTimestampOff ( )

virtual

◆ UpdateWithDesiredTimestampOn()

virtual void vtkPlusDevice::UpdateWithDesiredTimestampOn ( )

virtual

The result of GetOutput() will be the frame closest to DesiredTimestamp if it is set and if UpdateWithDesiredTimestamp is set on (default off)

◆ vtkDataCaptureThread()

void * vtkPlusDevice::vtkDataCaptureThread ( vtkMultiThreader::ThreadInfo * data )

staticprotected

Definition at line 1355 of file vtkPlusDevice.cxx.

◆ WriteConfiguration()

PlusStatus vtkPlusDevice::WriteConfiguration ( vtkXMLDataElement * config )

virtual

Write main configuration to xml data

Definition at line 1136 of file vtkPlusDevice.cxx.

◆ WriteToolsToSequenceFile()

PlusStatus vtkPlusDevice::WriteToolsToSequenceFile	(	const std::string &	filename,
		bool	useCompression = `false`
	)

virtual

Dump the current state of the device to sequence file (with each tools and buffers)

Definition at line 715 of file vtkPlusDevice.cxx.

Member Data Documentation

◆ AcquisitionRate

double vtkPlusDevice::AcquisitionRate

protected

Acquisition rate

Definition at line 564 of file vtkPlusDevice.h.

◆ BMODE_PORT_NAME

const std::string vtkPlusDevice::BMODE_PORT_NAME = "B"

static

Definition at line 67 of file vtkPlusDevice.h.

◆ Connected

int vtkPlusDevice::Connected

protected

Definition at line 538 of file vtkPlusDevice.h.

◆ CorrectlyConfigured

bool vtkPlusDevice::CorrectlyConfigured

protected

Is this device correctly configured?

Definition at line 582 of file vtkPlusDevice.h.

◆ CurrentStreamBufferItem

StreamBufferItem* vtkPlusDevice::CurrentStreamBufferItem

protected

A stream buffer item to use as a temporary staging point

Definition at line 550 of file vtkPlusDevice.h.

◆ DataCollector

vtkPlusDataCollector* vtkPlusDevice::DataCollector

protected

Definition at line 561 of file vtkPlusDevice.h.

◆ DesiredTimestamp

double vtkPlusDevice::DesiredTimestamp

protected

if we want to update according to the frame closest to the timestamp specified by desiredTimestamp

Definition at line 570 of file vtkPlusDevice.h.

◆ DeviceId

std::string vtkPlusDevice::DeviceId

protected

Id of the device

Definition at line 559 of file vtkPlusDevice.h.

◆ Fields

DataSourceContainer vtkPlusDevice::Fields

protected

Definition at line 553 of file vtkPlusDevice.h.

◆ FrameNumber

unsigned long vtkPlusDevice::FrameNumber

protected

Sequential number of frame, possibly since last re-initialization.

Definition at line 575 of file vtkPlusDevice.h.

◆ FrameTimeStamp

double vtkPlusDevice::FrameTimeStamp

protected

Definition at line 576 of file vtkPlusDevice.h.

◆ InputChannels

ChannelContainer vtkPlusDevice::InputChannels

protected

Definition at line 547 of file vtkPlusDevice.h.

◆ InternalUpdateRate

double vtkPlusDevice::InternalUpdateRate

Definition at line 290 of file vtkPlusDevice.h.

◆ LocalTimeOffsetSec

double vtkPlusDevice::LocalTimeOffsetSec

protected

Value to use when mixing data with another temporally calibrated device

Definition at line 591 of file vtkPlusDevice.h.

◆ MissingInputGracePeriodSec

double vtkPlusDevice::MissingInputGracePeriodSec

protected

Adjust the device reporting behaviour depending on whether or not a grace period has expired

Definition at line 594 of file vtkPlusDevice.h.

◆ OutputChannels

ChannelContainer vtkPlusDevice::OutputChannels

protected

Definition at line 546 of file vtkPlusDevice.h.

◆ OutputNeedsInitialization

int vtkPlusDevice::OutputNeedsInitialization

protected

Set if output needs to be cleared to be cleared before being written

Definition at line 579 of file vtkPlusDevice.h.

◆ PARAMETER_XML_ELEMENT_TAG

const std::string vtkPlusDevice::PARAMETER_XML_ELEMENT_TAG = "Parameter"

static

Definition at line 70 of file vtkPlusDevice.h.

◆ Parameters

std::map<std::string, std::string> vtkPlusDevice::Parameters

protected

Map to store general purpose device parameters

Definition at line 606 of file vtkPlusDevice.h.

◆ PARAMETERS_XML_ELEMENT_TAG

const std::string vtkPlusDevice::PARAMETERS_XML_ELEMENT_TAG = "Parameters"

static

Definition at line 69 of file vtkPlusDevice.h.

◆ Recording

int vtkPlusDevice::Recording

protected

Definition at line 567 of file vtkPlusDevice.h.

◆ RecordingStartTime

double vtkPlusDevice::RecordingStartTime

protected

Adjust the device reporting behaviour depending on whether or not a grace period has expired

Definition at line 596 of file vtkPlusDevice.h.

◆ ReportedUnknownTools

std::set<std::string> vtkPlusDevice::ReportedUnknownTools

protected

The list contains the IDs of the tools that have been already reported to be unknown. This list is used to only report an unknown tool once (after the connection has been established), not at each attempt to access it.

Definition at line 603 of file vtkPlusDevice.h.

◆ RequireImageOrientationInConfiguration

bool vtkPlusDevice::RequireImageOrientationInConfiguration

protected

Definition at line 615 of file vtkPlusDevice.h.

◆ RequirePortNameInDeviceSetConfiguration

bool vtkPlusDevice::RequirePortNameInDeviceSetConfiguration

protected

Definition at line 616 of file vtkPlusDevice.h.

◆ RFMODE_PORT_NAME

const std::string vtkPlusDevice::RFMODE_PORT_NAME = "Rf"

static

Definition at line 68 of file vtkPlusDevice.h.

◆ StartThreadForInternalUpdates

bool vtkPlusDevice::StartThreadForInternalUpdates

protected

If enabled, then a data capture thread is created when the device is connected that regularly calls InternalUpdate. This update mechanism is useful for devices that don't provide callback functions but require polling.

Definition at line 588 of file vtkPlusDevice.h.

◆ ThreadAlive

bool vtkPlusDevice::ThreadAlive

protected

Flag to store recording thread state

Definition at line 535 of file vtkPlusDevice.h.

◆ Threader

vtkMultiThreader* vtkPlusDevice::Threader

protected

Thread used for acquisition

Definition at line 541 of file vtkPlusDevice.h.

◆ ThreadId

int vtkPlusDevice::ThreadId

protected

Recording thread id

Definition at line 544 of file vtkPlusDevice.h.

◆ TimestampClosestToDesired

double vtkPlusDevice::TimestampClosestToDesired

protected

Definition at line 572 of file vtkPlusDevice.h.

◆ ToolReferenceFrameName

std::string vtkPlusDevice::ToolReferenceFrameName

protected

Reference name of the tools

Definition at line 556 of file vtkPlusDevice.h.

◆ Tools

DataSourceContainer vtkPlusDevice::Tools

protected

Definition at line 551 of file vtkPlusDevice.h.

◆ UpdateMutex

vtkIGSIORecursiveCriticalSection* vtkPlusDevice::UpdateMutex

Definition at line 288 of file vtkPlusDevice.h.

◆ UpdateTime

vtkTimeStamp vtkPlusDevice::UpdateTime

Definition at line 289 of file vtkPlusDevice.h.

◆ UpdateWithDesiredTimestamp

int vtkPlusDevice::UpdateWithDesiredTimestamp

protected

Definition at line 571 of file vtkPlusDevice.h.

◆ VideoSources

DataSourceContainer vtkPlusDevice::VideoSources

protected

Definition at line 552 of file vtkPlusDevice.h.

◆ VIRTUAL_DEVICE_FRAME_RATE

const int vtkPlusDevice::VIRTUAL_DEVICE_FRAME_RATE = 50

staticprotected

Definition at line 608 of file vtkPlusDevice.h.

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

src/PlusDataCollection/vtkPlusDevice.h
src/PlusDataCollection/vtkPlusDevice.cxx

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPlusDevice()

◆ ~vtkPlusDevice()

Member Function Documentation

◆ AddFieldDataSource()

◆ AddInputChannel()

◆ AddOutputChannel()

◆ AddTool()

◆ AddVideoItemToVideoSources() [1/2]

◆ AddVideoItemToVideoSources() [2/2]

◆ AddVideoSource()

◆ ClearAllBuffers()

◆ Connect()

◆ CreateDefaultOutputChannel()

◆ DeepCopy()

◆ Disconnect()

◆ EnsureUniqueDataSourceId()

◆ FindInputChannelElement()

◆ FindOutputChannelElement()

◆ FindThisDeviceElement()

◆ ForceUpdate()

◆ GetAcquisitionRate()

◆ GetBufferSize()

◆ GetClassName()

◆ GetConnected()

◆ GetCorrectlyConfigured()

◆ GetDataCollector()

◆ GetDataSource() [1/2]

◆ GetDataSource() [2/2]

◆ GetDesiredTimestamp()

◆ GetDeviceId()

◆ GetFieldDataSource() [1/2]

◆ GetFieldDataSource() [2/2]

◆ GetFieldDataSourcessIteratorBegin()

◆ GetFieldDataSourcessIteratorEnd()

◆ GetFirstActiveOutputVideoSource()

◆ GetFirstActiveTool()

◆ GetFirstOutputChannel()

◆ GetFirstVideoSource()

◆ GetFrameNumber()

◆ GetFrameTimeStamp()

◆ GetImage()

◆ GetImageMetaData()

◆ GetImageType()

◆ GetInputDevices()

◆ GetInputDevicesRecursive()

◆ GetInputFrameSize() [1/2]

◆ GetInputFrameSize() [2/2]

◆ GetInternalUpdateRate()

◆ GetLocalTimeOffsetSec()

◆ GetMissingInputGracePeriodSec()

◆ GetNumberOfFieldDataSources()

◆ GetNumberOfTools()

◆ GetNumberOfVideoSources()

◆ GetOutputChannelByName() [1/2]

◆ GetOutputChannelByName() [2/2]

◆ GetOutputChannelsEnd() [1/2]

◆ GetOutputChannelsEnd() [2/2]

◆ GetOutputChannelsStart() [1/2]

◆ GetOutputChannelsStart() [2/2]

◆ GetOutputFrameSize() [1/2]

◆ GetOutputFrameSize() [2/2]

◆ GetParameter() [1/2]

◆ GetParameter() [2/2]

◆ GetPixelType()

◆ GetRecordingStartTime()

◆ GetSdkVersion()

◆ GetStartThreadForInternalUpdates()