Interface class to collect sensor data in a generic wayFor now, the following sensor types are supported: More...

#include <src/PlusDataCollection/GenericSensor/vtkPlusGenericSensorTracker.h>

Inheritance diagram for vtkPlusGenericSensorTracker:

Collaboration diagram for vtkPlusGenericSensorTracker:

[legend]

Public Types
typedef vtkPlusDevice	Superclass

Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm	Superclass

Public Member Functions
virtual const char *	GetClassName ()

PlusStatus	InternalConnect () override

PlusStatus	InternalDisconnect () override

PlusStatus	InternalStartRecording () override

PlusStatus	InternalStopRecording () override

PlusStatus	InternalUpdate () override

virtual int	IsA (const char *type)

bool	IsTracker () const

void	PrintSelf (ostream &os, vtkIndent indent) override

PlusStatus	Probe () override

PlusStatus	ReadConfiguration (vtkXMLDataElement *config) override

Public Member Functions inherited from vtkPlusDevice
PlusStatus	AddFieldDataSource (vtkPlusDataSource *aSource)

PlusStatus	AddInputChannel (vtkPlusChannel *aChannel)

PlusStatus	AddOutputChannel (vtkPlusChannel *aChannel)

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

PlusStatus	AddVideoSource (vtkPlusDataSource *anImage)

void	ClearAllBuffers ()

virtual PlusStatus	Connect ()

virtual PlusStatus	CreateDefaultOutputChannel (const char *channelId=NULL, bool addSource=true)

void	DeepCopy (const vtkPlusDevice &device)

virtual PlusStatus	Disconnect ()

virtual PlusStatus	ForceUpdate ()

virtual double	GetAcquisitionRate () const

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

virtual int	GetConnected () const

virtual bool	GetCorrectlyConfigured () const

PlusStatus	GetDataSource (const char aSourceId, vtkPlusDataSource &aSource)

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

virtual double	GetDesiredTimestamp ()

virtual std::string	GetDeviceId () const

PlusStatus	GetFieldDataSource (const char aSourceId, vtkPlusDataSource &aSource) const

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

DataSourceContainerConstIterator	GetFieldDataSourcessIteratorBegin () const

DataSourceContainerConstIterator	GetFieldDataSourcessIteratorEnd () const

PlusStatus	GetFirstActiveOutputVideoSource (vtkPlusDataSource *&aVideoSource)

PlusStatus	GetFirstActiveTool (vtkPlusDataSource *&aTool) const

PlusStatus	GetFirstOutputChannel (vtkPlusChannel *&aChannel)

PlusStatus	GetFirstVideoSource (vtkPlusDataSource *&anImage)

virtual unsigned long	GetFrameNumber () const

virtual double	GetFrameTimeStamp () const

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

virtual PlusStatus	GetImageMetaData (igsioCommon::ImageMetaDataList &imageMetaDataItems)

virtual US_IMAGE_TYPE	GetImageType (vtkPlusChannel &aChannel)

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

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

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

virtual PlusStatus	GetInputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const

double	GetInternalUpdateRate () const

virtual double	GetLocalTimeOffsetSec () const

double	GetMissingInputGracePeriodSec () const

virtual int	GetNumberOfFieldDataSources () const

virtual int	GetNumberOfTools () const

virtual int	GetNumberOfVideoSources () const

PlusStatus	GetOutputChannelByName (vtkPlusChannel &aChannel, const char aChannelId)

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

ChannelContainerConstIterator	GetOutputChannelsEnd () const

ChannelContainerIterator	GetOutputChannelsEnd ()

ChannelContainerConstIterator	GetOutputChannelsStart () const

ChannelContainerIterator	GetOutputChannelsStart ()

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

virtual PlusStatus	GetOutputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const

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

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

virtual igsioCommon::VTKScalarPixelType	GetPixelType (vtkPlusChannel &aChannel)

virtual std::string	GetSdkVersion ()

virtual double	GetStartTime ()

virtual double	GetTimestampClosestToDesired ()

PlusStatus	GetTool (const char aToolSourceId, vtkPlusDataSource &aTool) const

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

PlusStatus	GetToolByPortName (const char aPortName, vtkPlusDataSource &aSource)

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

DataSourceContainerConstIterator	GetToolIteratorBegin () const

DataSourceContainerConstIterator	GetToolIteratorEnd () const

std::string	GetToolReferenceFrameName () const

virtual int	GetUpdateWithDesiredTimestamp ()

PlusStatus	GetVideoSource (const char aSourceId, vtkPlusDataSource &aVideoSource)

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

DataSourceContainerConstIterator	GetVideoSourceIteratorBegin () const

DataSourceContainerConstIterator	GetVideoSourceIteratorEnd () const

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

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

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

virtual bool	IsConnected () const

virtual bool	IsRecording () const

virtual bool	IsResettable ()

virtual bool	IsVirtual () const

virtual PlusStatus	NotifyConfigured ()

virtual int	OutputChannelCount () const

virtual 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 int	IsTypeOf (const char *type)

static vtkPlusGenericSensorTracker *	New ()

static vtkPlusGenericSensorTracker *	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
	vtkPlusGenericSensorTracker ()

	~vtkPlusGenericSensorTracker ()

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

virtual PlusStatus	AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, void imageDataPtr, US_IMAGE_ORIENTATION usImageOrientation, const FrameSizeType &frameSizeInPx, igsioCommon::VTKScalarPixelType pixelType, unsigned int numberOfScalarComponents, US_IMAGE_TYPE imageType, int numberOfBytesToSkip, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType customFields=NULL)

PlusStatus	EnsureUniqueDataSourceId (const std::string &aSourceId)

vtkXMLDataElement *	FindInputChannelElement (vtkXMLDataElement rootXMLElement, const char aChannelId)

vtkXMLDataElement *	FindOutputChannelElement (vtkXMLDataElement rootXMLElement, const char aChannelId)

vtkXMLDataElement *	FindThisDeviceElement (vtkXMLDataElement *rootXMLElement)

virtual vtkPlusDataCollector *	GetDataCollector ()

double	GetRecordingStartTime () const

bool	GetStartThreadForInternalUpdates () const

bool	HasGracePeriodExpired ()

virtual void	InternalWriteInputChannels (vtkXMLDataElement *rootXMLElement)

virtual void	InternalWriteOutputChannels (vtkXMLDataElement *rootXMLElement)

virtual void	SetCorrectlyConfigured (bool)

virtual void	SetRecordingStartTime (double)

virtual void	SetStartThreadForInternalUpdates (bool)

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

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

	vtkPlusDevice ()

virtual	~vtkPlusDevice ()

Additional Inherited Members
Public Attributes inherited from vtkPlusDevice
double	InternalUpdateRate

vtkIGSIORecursiveCriticalSection *	UpdateMutex

vtkTimeStamp	UpdateTime

Static Public Attributes inherited from vtkPlusDevice
static const std::string	BMODE_PORT_NAME = "B"

static const std::string	PARAMETER_XML_ELEMENT_TAG = "Parameter"

static const std::string	PARAMETERS_XML_ELEMENT_TAG = "Parameters"

static const std::string	RFMODE_PORT_NAME = "Rf"

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

Protected Attributes inherited from vtkPlusDevice
double	AcquisitionRate

int	Connected

bool	CorrectlyConfigured

StreamBufferItem *	CurrentStreamBufferItem

vtkPlusDataCollector *	DataCollector

double	DesiredTimestamp

std::string	DeviceId

DataSourceContainer	Fields

unsigned long	FrameNumber

double	FrameTimeStamp

ChannelContainer	InputChannels

double	LocalTimeOffsetSec

double	MissingInputGracePeriodSec

ChannelContainer	OutputChannels

int	OutputNeedsInitialization

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

int	Recording

double	RecordingStartTime

std::set< std::string >	ReportedUnknownTools

bool	RequireImageOrientationInConfiguration

bool	RequirePortNameInDeviceSetConfiguration

bool	StartThreadForInternalUpdates

bool	ThreadAlive

vtkMultiThreader *	Threader

int	ThreadId

double	TimestampClosestToDesired

std::string	ToolReferenceFrameName

DataSourceContainer	Tools

int	UpdateWithDesiredTimestamp

DataSourceContainer	VideoSources

Static Protected Attributes inherited from vtkPlusDevice
static const int	VIRTUAL_DEVICE_FRAME_RATE = 50

Detailed Description

Interface class to collect sensor data in a generic way

For now, the following sensor types are supported:

Accelerometer

Definition at line 21 of file vtkPlusGenericSensorTracker.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusDevice vtkPlusGenericSensorTracker::Superclass

Definition at line 27 of file vtkPlusGenericSensorTracker.h.

Constructor & Destructor Documentation

◆ vtkPlusGenericSensorTracker()

vtkPlusGenericSensorTracker::vtkPlusGenericSensorTracker ( )

protected

Definition at line 689 of file vtkPlusGenericSensorTracker.cxx.

◆ ~vtkPlusGenericSensorTracker()

vtkPlusGenericSensorTracker::~vtkPlusGenericSensorTracker ( )

protected

Definition at line 696 of file vtkPlusGenericSensorTracker.cxx.

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPlusGenericSensorTracker::GetClassName ( )

virtual

Reimplemented from vtkPlusDevice.

◆ InternalConnect()

PlusStatus vtkPlusGenericSensorTracker::InternalConnect ( )

overridevirtual

Should be overridden to connect to the hardware

Reimplemented from vtkPlusDevice.

Definition at line 767 of file vtkPlusGenericSensorTracker.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusGenericSensorTracker::InternalDisconnect ( )

overridevirtual

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

Reimplemented from vtkPlusDevice.

Definition at line 779 of file vtkPlusGenericSensorTracker.cxx.

◆ InternalStartRecording()

PlusStatus vtkPlusGenericSensorTracker::InternalStartRecording ( )

overridevirtual

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

Reimplemented from vtkPlusDevice.

Definition at line 799 of file vtkPlusGenericSensorTracker.cxx.

◆ InternalStopRecording()

PlusStatus vtkPlusGenericSensorTracker::InternalStopRecording ( )

overridevirtual

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

Reimplemented from vtkPlusDevice.

Definition at line 814 of file vtkPlusGenericSensorTracker.cxx.

◆ InternalUpdate()

PlusStatus vtkPlusGenericSensorTracker::InternalUpdate ( )

overridevirtual

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.

Reimplemented from vtkPlusDevice.

Definition at line 821 of file vtkPlusGenericSensorTracker.cxx.

◆ IsA()

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

virtual

Reimplemented from vtkPlusDevice.

◆ IsTracker()

bool vtkPlusGenericSensorTracker::IsTracker ( ) const

inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 31 of file vtkPlusGenericSensorTracker.h.

◆ IsTypeOf()

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

static

◆ New()

static vtkPlusGenericSensorTracker* vtkPlusGenericSensorTracker::New ( )

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkPlusDevice.

Definition at line 703 of file vtkPlusGenericSensorTracker.cxx.

◆ Probe()

PlusStatus vtkPlusGenericSensorTracker::Probe ( )

overridevirtual

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

Reimplemented from vtkPlusDevice.

Definition at line 786 of file vtkPlusGenericSensorTracker.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusGenericSensorTracker::ReadConfiguration ( vtkXMLDataElement * rootXMLElement )

overridevirtual

Read main configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 720 of file vtkPlusGenericSensorTracker.cxx.

◆ SafeDownCast()

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

static

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

src/PlusDataCollection/GenericSensor/vtkPlusGenericSensorTracker.h
src/PlusDataCollection/GenericSensor/vtkPlusGenericSensorTracker.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPlusGenericSensorTracker()

◆ ~vtkPlusGenericSensorTracker()

Member Function Documentation

◆ GetClassName()

◆ InternalConnect()

◆ InternalDisconnect()

◆ InternalStartRecording()

◆ InternalStopRecording()

◆ InternalUpdate()

◆ IsA()

◆ IsTracker()

◆ IsTypeOf()

◆ New()

◆ PrintSelf()

◆ Probe()

◆ ReadConfiguration()

◆ SafeDownCast()