Class for providing VTK video input interface from sequence fileAttributes: More...

#include <src/PlusDataCollection/SavedDataSource/vtkPlusSavedDataSource.h>

Inheritance diagram for vtkPlusSavedDataSource:

Collaboration diagram for vtkPlusSavedDataSource:

[legend]

Public Types
typedef vtkPlusDevice	Superclass

Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual vtkPlusBuffer *	GetLocalVideoBuffer ()

void	GetLoopTimeRange (double &loopStartTime, double &loopStopTime)

virtual bool	GetRepeatEnabled ()

virtual char *	GetSequenceFile ()

virtual bool	GetUseAllFrameFields ()

virtual bool	GetUseOriginalTimestamps ()

virtual int	IsA (const char *type)

virtual bool	IsTracker () const

virtual PlusStatus	NotifyConfigured ()

void	PrintSelf (ostream &os, vtkIndent indent)

PlusStatus	Probe ()

virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *config)

virtual void	RepeatEnabledOff ()

virtual void	RepeatEnabledOn ()

void	SetLoopTimeRange (double loopStartTime, double loopStopTime)

virtual void	SetRepeatEnabled (bool)

virtual void	SetSequenceFile (const char *)

virtual void	SetUseAllFrameFields (bool)

virtual void	SetUseOriginalTimestamps (bool)

virtual void	UseAllFrameFieldsOff ()

virtual void	UseAllFrameFieldsOn ()

virtual void	UseOriginalTimestampsOff ()

virtual void	UseOriginalTimestampsOn ()

virtual PlusStatus	WriteConfiguration (vtkXMLDataElement *config)

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

PlusStatus	AddInputChannel (vtkPlusChannel *aChannel)

PlusStatus	AddOutputChannel (vtkPlusChannel *aChannel)

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

PlusStatus	AddVideoSource (vtkPlusDataSource *anImage)

void	ClearAllBuffers ()

virtual PlusStatus	Connect ()

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

void	DeepCopy (const vtkPlusDevice &device)

virtual PlusStatus	Disconnect ()

virtual PlusStatus	ForceUpdate ()

virtual double	GetAcquisitionRate () const

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

virtual int	GetConnected () const

virtual bool	GetCorrectlyConfigured () const

PlusStatus	GetDataSource (const char aSourceId, vtkPlusDataSource &aSource)

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

virtual double	GetDesiredTimestamp ()

virtual std::string	GetDeviceId () const

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

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

DataSourceContainerConstIterator	GetFieldDataSourcessIteratorBegin () const

DataSourceContainerConstIterator	GetFieldDataSourcessIteratorEnd () const

PlusStatus	GetFirstActiveOutputVideoSource (vtkPlusDataSource *&aVideoSource)

PlusStatus	GetFirstActiveTool (vtkPlusDataSource *&aTool) const

PlusStatus	GetFirstOutputChannel (vtkPlusChannel *&aChannel)

PlusStatus	GetFirstVideoSource (vtkPlusDataSource *&anImage)

virtual unsigned long	GetFrameNumber () const

virtual double	GetFrameTimeStamp () const

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

virtual PlusStatus	GetImageMetaData (igsioCommon::ImageMetaDataList &imageMetaDataItems)

virtual US_IMAGE_TYPE	GetImageType (vtkPlusChannel &aChannel)

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

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

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

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

double	GetInternalUpdateRate () const

virtual double	GetLocalTimeOffsetSec () const

double	GetMissingInputGracePeriodSec () const

virtual int	GetNumberOfFieldDataSources () const

virtual int	GetNumberOfTools () const

virtual int	GetNumberOfVideoSources () const

PlusStatus	GetOutputChannelByName (vtkPlusChannel &aChannel, const char aChannelId)

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

ChannelContainerConstIterator	GetOutputChannelsEnd () const

ChannelContainerIterator	GetOutputChannelsEnd ()

ChannelContainerConstIterator	GetOutputChannelsStart () const

ChannelContainerIterator	GetOutputChannelsStart ()

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

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

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

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

virtual igsioCommon::VTKScalarPixelType	GetPixelType (vtkPlusChannel &aChannel)

virtual std::string	GetSdkVersion ()

virtual double	GetStartTime ()

virtual double	GetTimestampClosestToDesired ()

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

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

PlusStatus	GetToolByPortName (const char aPortName, vtkPlusDataSource &aSource)

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

DataSourceContainerConstIterator	GetToolIteratorBegin () const

DataSourceContainerConstIterator	GetToolIteratorEnd () const

std::string	GetToolReferenceFrameName () const

virtual int	GetUpdateWithDesiredTimestamp ()

PlusStatus	GetVideoSource (const char aSourceId, vtkPlusDataSource &aVideoSource)

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

DataSourceContainerConstIterator	GetVideoSourceIteratorBegin () const

DataSourceContainerConstIterator	GetVideoSourceIteratorEnd () const

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

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

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

virtual bool	IsConnected () const

virtual bool	IsRecording () const

virtual bool	IsResettable ()

virtual bool	IsVirtual () const

virtual 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 vtkPlusSavedDataSource *	New ()

static vtkPlusSavedDataSource *	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 Types
enum	SimulatedStreamType { TRACKER_STREAM, VIDEO_STREAM }

Protected Member Functions
void	DeleteLocalBuffers ()

BufferItemUidType	GetClosestFrameUidWithinTimeRange (double time_Local, double startTime_Local, double stopTime_Local)

vtkPlusBuffer *	GetLocalBuffer ()

vtkPlusBuffer *	GetLocalTrackerBuffer ()

vtkPlusDataSource *	GetOutputDataSource ()

virtual PlusStatus	InternalConnect ()

virtual PlusStatus	InternalConnectTracker (vtkIGSIOTrackedFrameList *savedDataBuffer)

virtual PlusStatus	InternalConnectVideo (vtkIGSIOTrackedFrameList *savedDataBuffer)

virtual PlusStatus	InternalDisconnect ()

PlusStatus	InternalUpdate ()

PlusStatus	InternalUpdateCurrentTimestamp (BufferItemUidType frameToBeAddedUid, int frameToBeAddedLoopIndex)

PlusStatus	InternalUpdateOriginalTimestamp (BufferItemUidType frameToBeAddedUid, int frameToBeAddedLoopIndex)

	vtkPlusSavedDataSource ()

virtual	~vtkPlusSavedDataSource ()

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

Protected Attributes
int	FrameBufferRowAlignment

BufferItemUidType	LastAddedFrameUid

int	LastAddedLoopIndex

std::map< std::string, vtkPlusBuffer * >	LocalTrackerBuffers

vtkPlusBuffer *	LocalVideoBuffer

BufferItemUidType	LoopFirstFrameUid

BufferItemUidType	LoopLastFrameUid

double	LoopStartTime_Local

double	LoopStopTime_Local

bool	RepeatEnabled

char *	SequenceFile

SimulatedStreamType	SimulatedStream

bool	UseAllFrameFields

bool	UseOriginalTimestamps

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

Additional Inherited Members
Public Attributes inherited from vtkPlusDevice
double	InternalUpdateRate

vtkIGSIORecursiveCriticalSection *	UpdateMutex

vtkTimeStamp	UpdateTime

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

static const std::string	PARAMETER_XML_ELEMENT_TAG = "Parameter"

static const std::string	PARAMETERS_XML_ELEMENT_TAG = "Parameters"

static const std::string	RFMODE_PORT_NAME = "Rf"

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

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

Detailed Description

Class for providing VTK video input interface from sequence file

Attributes:

SequenceFile: source file to read the image/transform data from
UseData: specifies what data to be use from the source file (IMAGE|IMAGE_AND_TRANSFORM|TRANSFORM)
RepeatEnabled: if true then the sequence is played repeateadly (TRUE|FALSE)
UseOriginalTimestamps: if true then the original timestamps (recorded originally in the source file) will be replayed exactly, otherwise only the timestamp difference will be replayed exactly, starting from the current time (TRUE|FALSE)

Definition at line 32 of file vtkPlusSavedDataSource.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusDevice vtkPlusSavedDataSource::Superclass

Definition at line 35 of file vtkPlusSavedDataSource.h.

Member Enumeration Documentation

◆ SimulatedStreamType

enum vtkPlusSavedDataSource::SimulatedStreamType

protected

Enumerator
TRACKER_STREAM
VIDEO_STREAM	The device provides a video stream (with optional tracking data added as fields)

Definition at line 176 of file vtkPlusSavedDataSource.h.

Constructor & Destructor Documentation

◆ vtkPlusSavedDataSource()

vtkPlusSavedDataSource::vtkPlusSavedDataSource ( )

protected

Constructor

Definition at line 22 of file vtkPlusSavedDataSource.cxx.

◆ ~vtkPlusSavedDataSource()

vtkPlusSavedDataSource::~vtkPlusSavedDataSource ( )

protectedvirtual

Destructor

Definition at line 41 of file vtkPlusSavedDataSource.cxx.

Member Function Documentation

◆ DeleteLocalBuffers()

void vtkPlusSavedDataSource::DeleteLocalBuffers ( )

protected

Definition at line 859 of file vtkPlusSavedDataSource.cxx.

◆ GetClassName()

virtual const char* vtkPlusSavedDataSource::GetClassName ( )

virtual

Reimplemented from vtkPlusDevice.

◆ GetClosestFrameUidWithinTimeRange()

BufferItemUidType vtkPlusSavedDataSource::GetClosestFrameUidWithinTimeRange	(	double	time_Local,
		double	startTime_Local,
		double	stopTime_Local
	)

protected

Definition at line 789 of file vtkPlusSavedDataSource.cxx.

◆ GetLocalBuffer()

vtkPlusBuffer * vtkPlusSavedDataSource::GetLocalBuffer ( )

protected

Get local tracker buffer, it returns tracker buffer if the output is a tracker stream, and returns the video buffer if the output is a video stream

Definition at line 880 of file vtkPlusSavedDataSource.cxx.

◆ GetLocalTrackerBuffer()

vtkPlusBuffer * vtkPlusSavedDataSource::GetLocalTrackerBuffer ( )

protected

Get local tracker buffer

Definition at line 846 of file vtkPlusSavedDataSource.cxx.

◆ GetLocalVideoBuffer()

virtual vtkPlusBuffer* vtkPlusSavedDataSource::GetLocalVideoBuffer ( )

virtual

Get local video buffer

◆ GetLoopTimeRange()

void vtkPlusSavedDataSource::GetLoopTimeRange	(	double &	loopStartTime,
		double &	loopStopTime
	)

Get the time range of the loaded buffer that will be replayed. It is initialized to the full range of the loaded data set on Connect().

Definition at line 763 of file vtkPlusSavedDataSource.cxx.

◆ GetOutputDataSource()

vtkPlusDataSource * vtkPlusSavedDataSource::GetOutputDataSource ( )

protected

Get the output data source (the video buffer or the first active tool buffer of the current stream)

Definition at line 902 of file vtkPlusSavedDataSource.cxx.

◆ GetRepeatEnabled()

virtual bool vtkPlusSavedDataSource::GetRepeatEnabled ( )

virtual

Set flag to to enable saved dataset looping /sa RepeatEnabled

◆ GetSequenceFile()

virtual char* vtkPlusSavedDataSource::GetSequenceFile ( )

virtual

Get SequenceMetafile name with path with tracking buffer data

◆ GetUseAllFrameFields()

virtual bool vtkPlusSavedDataSource::GetUseAllFrameFields ( )

virtual

Read all the frame fields from the file and provide them in the output

◆ GetUseOriginalTimestamps()

virtual bool vtkPlusSavedDataSource::GetUseOriginalTimestamps ( )

virtual

Read the timestamps from the file and use provide them in the output (instead of the current time)

◆ InternalConnect()

PlusStatus vtkPlusSavedDataSource::InternalConnect ( )

protectedvirtual

Connect to device

Reimplemented from vtkPlusDevice.

Definition at line 366 of file vtkPlusSavedDataSource.cxx.

◆ InternalConnectTracker()

PlusStatus vtkPlusSavedDataSource::InternalConnectTracker ( vtkIGSIOTrackedFrameList * savedDataBuffer )

protectedvirtual

Connect to device, in case the output is a tracker stream

Definition at line 553 of file vtkPlusSavedDataSource.cxx.

◆ InternalConnectVideo()

PlusStatus vtkPlusSavedDataSource::InternalConnectVideo ( vtkIGSIOTrackedFrameList * savedDataBuffer )

protectedvirtual

Connect to device, in case the output is a video stream

Definition at line 461 of file vtkPlusSavedDataSource.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusSavedDataSource::InternalDisconnect ( )

protectedvirtual

Disconnect from device

Reimplemented from vtkPlusDevice.

Definition at line 615 of file vtkPlusSavedDataSource.cxx.

◆ InternalUpdate()

PlusStatus vtkPlusSavedDataSource::InternalUpdate ( )

protectedvirtual

The internal function which actually does the grab.

Reimplemented from vtkPlusDevice.

Definition at line 58 of file vtkPlusSavedDataSource.cxx.

◆ InternalUpdateCurrentTimestamp()

PlusStatus vtkPlusSavedDataSource::InternalUpdateCurrentTimestamp	(	BufferItemUidType	frameToBeAddedUid,
		int	frameToBeAddedLoopIndex
	)

protected

Internal update, called when NOT the original timestamps are used

Definition at line 255 of file vtkPlusSavedDataSource.cxx.

◆ InternalUpdateOriginalTimestamp()

PlusStatus vtkPlusSavedDataSource::InternalUpdateOriginalTimestamp	(	BufferItemUidType	frameToBeAddedUid,
		int	frameToBeAddedLoopIndex
	)

protected

Internal update, called when the original timestamps are used

Definition at line 86 of file vtkPlusSavedDataSource.cxx.

◆ IsA()

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

virtual

Reimplemented from vtkPlusDevice.

◆ IsTracker()

bool vtkPlusSavedDataSource::IsTracker ( ) const

virtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 944 of file vtkPlusSavedDataSource.cxx.

◆ IsTypeOf()

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

static

◆ New()

static vtkPlusSavedDataSource* vtkPlusSavedDataSource::New ( )

static

◆ NotifyConfigured()

PlusStatus vtkPlusSavedDataSource::NotifyConfigured ( )

virtual

Perform any completion tasks once configured

Reimplemented from vtkPlusDevice.

Definition at line 732 of file vtkPlusSavedDataSource.cxx.

◆ PrintSelf()

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

virtual

Reimplemented from vtkPlusDevice.

Definition at line 52 of file vtkPlusSavedDataSource.cxx.

◆ Probe()

PlusStatus vtkPlusSavedDataSource::Probe ( )

virtual

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

Reimplemented from vtkPlusDevice.

Definition at line 354 of file vtkPlusSavedDataSource.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusSavedDataSource::ReadConfiguration ( vtkXMLDataElement * config )

virtual

Read configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 622 of file vtkPlusSavedDataSource.cxx.

◆ RepeatEnabledOff()

virtual void vtkPlusSavedDataSource::RepeatEnabledOff ( )

virtual

◆ RepeatEnabledOn()

virtual void vtkPlusSavedDataSource::RepeatEnabledOn ( )

virtual

Get flag to to enable saved dataset looping /sa RepeatEnabled

◆ SafeDownCast()

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

static

◆ SetLoopTimeRange()

void vtkPlusSavedDataSource::SetLoopTimeRange	(	double	loopStartTime,
		double	loopStopTime
	)

Set the time range of the loaded buffer that will be replayed

Definition at line 770 of file vtkPlusSavedDataSource.cxx.

◆ SetRepeatEnabled()

virtual void vtkPlusSavedDataSource::SetRepeatEnabled ( bool )

virtual

Get flag to to enable saved dataset looping /sa RepeatEnabled

◆ SetSequenceFile()

virtual void vtkPlusSavedDataSource::SetSequenceFile ( const char * )

virtual

Set SequenceMetafile name with path with tracking buffer data

◆ SetUseAllFrameFields()

virtual void vtkPlusSavedDataSource::SetUseAllFrameFields ( bool )

virtual

Read all the frame fields from the file and provide them in the output

◆ SetUseOriginalTimestamps()

virtual void vtkPlusSavedDataSource::SetUseOriginalTimestamps ( bool )

virtual

Read the timestamps from the file and use provide them in the output (instead of the current time)

◆ UseAllFrameFieldsOff()

virtual void vtkPlusSavedDataSource::UseAllFrameFieldsOff ( )

virtual

◆ UseAllFrameFieldsOn()

virtual void vtkPlusSavedDataSource::UseAllFrameFieldsOn ( )

virtual

Read all the frame fields from the file and provide them in the output

◆ UseOriginalTimestampsOff()

virtual void vtkPlusSavedDataSource::UseOriginalTimestampsOff ( )

virtual

◆ UseOriginalTimestampsOn()

virtual void vtkPlusSavedDataSource::UseOriginalTimestampsOn ( )

virtual

Read the timestamps from the file and use provide them in the output (instead of the current time)

◆ WriteConfiguration()

PlusStatus vtkPlusSavedDataSource::WriteConfiguration ( vtkXMLDataElement * config )

virtual

Write configuration to xml data

Reimplemented from vtkPlusDevice.

Definition at line 704 of file vtkPlusSavedDataSource.cxx.

Member Data Documentation

◆ FrameBufferRowAlignment

int vtkPlusSavedDataSource::FrameBufferRowAlignment

protected

Byte alignment of each row in the framebuffer

Definition at line 134 of file vtkPlusSavedDataSource.h.

◆ LastAddedFrameUid

BufferItemUidType vtkPlusSavedDataSource::LastAddedFrameUid

protected

Buffer item UID of the last added frame in the local buffer

Definition at line 165 of file vtkPlusSavedDataSource.h.

◆ LastAddedLoopIndex

int vtkPlusSavedDataSource::LastAddedLoopIndex

protected

Index of the loop when the last frame was added. Used for making sure we add each frame only once in one loop period.

Definition at line 168 of file vtkPlusSavedDataSource.h.

◆ LocalTrackerBuffers

std::map<std::string, vtkPlusBuffer*> vtkPlusSavedDataSource::LocalTrackerBuffers

protected

Local buffer for each tracker tool, used for storing data read from sequence metafile

Definition at line 156 of file vtkPlusSavedDataSource.h.

◆ LocalVideoBuffer

vtkPlusBuffer* vtkPlusSavedDataSource::LocalVideoBuffer

protected

Local video buffer

Definition at line 153 of file vtkPlusSavedDataSource.h.

◆ LoopFirstFrameUid

BufferItemUidType vtkPlusSavedDataSource::LoopFirstFrameUid

protected

Frames before this item (identified by the buffer item UID) in the local buffer are ignored, not replayed

Definition at line 171 of file vtkPlusSavedDataSource.h.

◆ LoopLastFrameUid

BufferItemUidType vtkPlusSavedDataSource::LoopLastFrameUid

protected

Frames after this item (identified by the buffer item UID) in the local buffer are ignored, not replayed

Definition at line 174 of file vtkPlusSavedDataSource.h.

◆ LoopStartTime_Local

double vtkPlusSavedDataSource::LoopStartTime_Local

protected

Loop start time (in local buffer time). The first acquired frame (at system time = 0) will be the frame that has the closest timestamp to the start time. ItemTimestamp_Local = loopStartTime_Local + (actualTimestamp_Sys - startTimestamp_Sys) % (loopStopTime-LooStartTime)

Definition at line 147 of file vtkPlusSavedDataSource.h.

◆ LoopStopTime_Local

double vtkPlusSavedDataSource::LoopStopTime_Local

protected

Loop stop time (in local buffer time)

Definition at line 150 of file vtkPlusSavedDataSource.h.

◆ RepeatEnabled

bool vtkPlusSavedDataSource::RepeatEnabled

protected

Flag to to enable saved dataset looping. If it's enabled, the video source will continuously play saved data (starts playing from the beginning when the end is reached).

Definition at line 140 of file vtkPlusSavedDataSource.h.

◆ SequenceFile

char* vtkPlusSavedDataSource::SequenceFile

protected

Name of input sequence file

Definition at line 137 of file vtkPlusSavedDataSource.h.

◆ SimulatedStream

SimulatedStreamType vtkPlusSavedDataSource::SimulatedStream

protected

Definition at line 182 of file vtkPlusSavedDataSource.h.

◆ UseAllFrameFields

bool vtkPlusSavedDataSource::UseAllFrameFields

protected

Read all the frame fields from the file and provide them in the output

Definition at line 159 of file vtkPlusSavedDataSource.h.

◆ UseOriginalTimestamps

bool vtkPlusSavedDataSource::UseOriginalTimestamps

protected

Read the timestamps from the file and use provide them in the output (instead of the current time)

Definition at line 162 of file vtkPlusSavedDataSource.h.

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

src/PlusDataCollection/SavedDataSource/vtkPlusSavedDataSource.h
src/PlusDataCollection/SavedDataSource/vtkPlusSavedDataSource.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ SimulatedStreamType

Constructor & Destructor Documentation

◆ vtkPlusSavedDataSource()

◆ ~vtkPlusSavedDataSource()

Member Function Documentation

◆ DeleteLocalBuffers()

◆ GetClassName()

◆ GetClosestFrameUidWithinTimeRange()

◆ GetLocalBuffer()

◆ GetLocalTrackerBuffer()

◆ GetLocalVideoBuffer()

◆ GetLoopTimeRange()

◆ GetOutputDataSource()

◆ GetRepeatEnabled()

◆ GetSequenceFile()

◆ GetUseAllFrameFields()

◆ GetUseOriginalTimestamps()

◆ InternalConnect()

◆ InternalConnectTracker()

◆ InternalConnectVideo()

◆ InternalDisconnect()

◆ InternalUpdate()

◆ InternalUpdateCurrentTimestamp()

◆ InternalUpdateOriginalTimestamp()

◆ IsA()

◆ IsTracker()

◆ IsTypeOf()

◆ New()

◆ NotifyConfigured()

◆ PrintSelf()

◆ Probe()

◆ ReadConfiguration()

◆ RepeatEnabledOff()

◆ RepeatEnabledOn()

◆ SafeDownCast()

◆ SetLoopTimeRange()

◆ SetRepeatEnabled()

◆ SetSequenceFile()

◆ SetUseAllFrameFields()

◆ SetUseOriginalTimestamps()

◆ UseAllFrameFieldsOff()

◆ UseAllFrameFieldsOn()

◆ UseOriginalTimestampsOff()

◆ UseOriginalTimestampsOn()

◆ WriteConfiguration()

Member Data Documentation

◆ FrameBufferRowAlignment

◆ LastAddedFrameUid

◆ LastAddedLoopIndex

◆ LocalTrackerBuffers

◆ LocalVideoBuffer

◆ LoopFirstFrameUid

◆ LoopLastFrameUid

◆ LoopStartTime_Local

◆ LoopStopTime_Local

◆ RepeatEnabled

◆ SequenceFile

◆ SimulatedStream

◆ UseAllFrameFields

◆ UseOriginalTimestamps