#include <src/PlusDataCollection/vtkPlusBuffer.h>

Inheritance diagram for vtkPlusBuffer:

Collaboration diagram for vtkPlusBuffer:

Public Types
enum	DataItemTemporalInterpolationType { EXACT_TIME, INTERPOLATED, CLOSEST_TIME }

typedef vtkObject	Superclass

enum	TIMESTAMP_FILTERING_OPTION { READ_FILTERED_AND_UNFILTERED_TIMESTAMPS = 0, READ_UNFILTERED_COMPUTE_FILTERED_TIMESTAMPS, READ_FILTERED_IGNORE_UNFILTERED_TIMESTAMPS }

Public Member Functions
virtual PlusStatus	AddItem (vtkImageData frame, US_IMAGE_ORIENTATION usImageOrientation, US_IMAGE_TYPE imageType, long frameNumber, const std::array< int, 3 > &clipRectangleOrigin, const std::array< int, 3 > &clipRectangleSize, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType customFields=NULL)

virtual PlusStatus	AddItem (const igsioVideoFrame frame, long frameNumber, const std::array< int, 3 > &clipRectangleOrigin, const std::array< int, 3 > &clipRectangleSize, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType customFields=NULL)

virtual PlusStatus	AddItem (void imageDataPtr, US_IMAGE_ORIENTATION usImageOrientation, const FrameSizeType &inputFrameSizeInPx, igsioCommon::VTKScalarPixelType pixelType, unsigned int numberOfScalarComponents, US_IMAGE_TYPE imageType, int numberOfBytesToSkip, long frameNumber, const std::array< int, 3 > &clipRectangleOrigin, const std::array< int, 3 > &clipRectangleSize, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType customFields=NULL, vtkStreamingVolumeFrame *encodedFrame=NULL)

virtual PlusStatus	AddItem (void imageDataPtr, const FrameSizeType &frameSize, unsigned int frameSizeInBytes, US_IMAGE_TYPE imageType, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType customFields=NULL)

virtual PlusStatus	AddItem (const igsioFieldMapType &fields, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP)

PlusStatus	AddTimeStampedItem (vtkMatrix4x4 matrix, ToolStatus status, unsigned long frameNumber, double unfilteredTimestamp, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType customFields=NULL)

virtual void	Clear ()

PlusStatus	CopyImagesFromTrackedFrameList (vtkIGSIOTrackedFrameList *sourceTrackedFrameList, TIMESTAMP_FILTERING_OPTION timestampFiltering, bool copyFrameFields)

PlusStatus	CopyTransformFromTrackedFrameList (vtkIGSIOTrackedFrameList *sourceTrackedFrameList, TIMESTAMP_FILTERING_OPTION timestampFiltering, igsioTransformName &transformName)

virtual void	DeepCopy (vtkPlusBuffer *buffer)

virtual int	GetAveragedItemsForFiltering ()

ItemStatus	GetBufferIndexFromTime (const double time, int &bufferIndex)

virtual int	GetBufferSize ()

virtual const char *	GetClassName ()

virtual char *	GetDescriptiveName ()

virtual double	GetFrameRate (bool ideal=false, double *framePeriodStdevSecPtr=NULL)

virtual FrameSizeType	GetFrameSize () const

virtual PlusStatus	GetFrameSize (unsigned int &_arg1, unsigned int &_arg2, unsigned int &_arg3) const

virtual US_IMAGE_ORIENTATION	GetImageOrientation ()

virtual US_IMAGE_TYPE	GetImageType ()

virtual ItemStatus	GetIndex (const BufferItemUidType uid, unsigned long &index)

virtual ItemStatus	GetItemUidFromTime (double time, BufferItemUidType &uid)

virtual bool	GetLatestItemHasValidFieldData ()

virtual bool	GetLatestItemHasValidTransformData ()

virtual bool	GetLatestItemHasValidVideoData ()

virtual BufferItemUidType	GetLatestItemUidInBuffer ()

virtual ItemStatus	GetLatestStreamBufferItem (StreamBufferItem *bufferItem)

virtual ItemStatus	GetLatestTimeStamp (double &latestTimestamp)

virtual double	GetLocalTimeOffsetSec ()

virtual double	GetMaxAllowedTimeDifference ()

int	GetNumberOfBytesPerPixel ()

int	GetNumberOfBytesPerScalar ()

virtual int	GetNumberOfItems ()

virtual unsigned int	GetNumberOfScalarComponents ()

virtual BufferItemUidType	GetOldestItemUidInBuffer ()

virtual ItemStatus	GetOldestStreamBufferItem (StreamBufferItem *bufferItem)

virtual ItemStatus	GetOldestTimeStamp (double &oldestTimestamp)

virtual igsioCommon::VTKScalarPixelType	GetPixelType ()

virtual double	GetStartTime ()

virtual ItemStatus	GetStreamBufferItem (BufferItemUidType uid, StreamBufferItem *bufferItem)

virtual ItemStatus	GetStreamBufferItemFromTime (double time, StreamBufferItem *bufferItem, DataItemTemporalInterpolationType interpolation)

virtual ItemStatus	GetTimeStamp (BufferItemUidType uid, double &timestamp)

bool	GetTimeStampReporting ()

virtual PlusStatus	GetTimeStampReportTable (vtkTable *timeStampReportTable)

virtual int	IsA (const char *type)

virtual PlusStatus	ModifyBufferItemFrameField (BufferItemUidType uid, const std::string &key, const std::string &value)

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

virtual void	SetAveragedItemsForFiltering (int averagedItemsForFiltering)

virtual PlusStatus	SetBufferSize (int n)

virtual void	SetDescriptiveName (const char *)

PlusStatus	SetFrameSize (unsigned int x, unsigned int y, unsigned int z, bool allocateFrames=true)

PlusStatus	SetFrameSize (const FrameSizeType &frameSize, bool allocateFrames=true)

PlusStatus	SetImageOrientation (US_IMAGE_ORIENTATION imageOrientation)

PlusStatus	SetImageType (US_IMAGE_TYPE imageType)

virtual void	SetLocalTimeOffsetSec (double offsetSec)

virtual void	SetMaxAllowedTimeDifference (double)

PlusStatus	SetNumberOfScalarComponents (unsigned int numberOfScalarComponents)

PlusStatus	SetPixelType (igsioCommon::VTKScalarPixelType pixelType)

virtual void	SetStartTime (double startTime)

void	SetTimeStampReporting (bool enable)

virtual PlusStatus	WriteToSequenceFile (const char *filename, bool useCompression=false)

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkPlusBuffer *	New ()

static vtkPlusBuffer *	SafeDownCast (vtkObject *o)

Protected Types
typedef vtkPlusTimestampedCircularBuffer	StreamItemCircularBuffer

Protected Member Functions
virtual PlusStatus	AllocateMemoryForFrames ()

virtual bool	CheckFrameFormat (const FrameSizeType &frameSizeInPx, igsioCommon::VTKScalarPixelType pixelType, US_IMAGE_TYPE imgType, int numberOfScalarComponents)

virtual ItemStatus	GetInterpolatedStreamBufferItemFromTime (double time, StreamBufferItem *bufferItem)

PlusStatus	GetPrevNextBufferItemFromTime (double time, StreamBufferItem &itemA, StreamBufferItem &itemB)

virtual ItemStatus	GetStreamBufferItemFromClosestTime (double time, StreamBufferItem *bufferItem)

virtual ItemStatus	GetStreamBufferItemFromExactTime (double time, StreamBufferItem *bufferItem)

	vtkPlusBuffer ()

	~vtkPlusBuffer ()

Protected Attributes
char *	DescriptiveName

FrameSizeType	FrameSize

US_IMAGE_ORIENTATION	ImageOrientation

US_IMAGE_TYPE	ImageType

double	MaxAllowedTimeDifference

unsigned int	NumberOfScalarComponents

igsioCommon::VTKScalarPixelType	PixelType

StreamItemCircularBuffer *	StreamBuffer

Detailed Description

Definition at line 34 of file vtkPlusBuffer.h.

Member Typedef Documentation

◆ StreamItemCircularBuffer

typedef vtkPlusTimestampedCircularBuffer vtkPlusBuffer::StreamItemCircularBuffer

protected

Definition at line 365 of file vtkPlusBuffer.h.

◆ Superclass

typedef vtkObject vtkPlusBuffer::Superclass

Definition at line 53 of file vtkPlusBuffer.h.

Member Enumeration Documentation

◆ DataItemTemporalInterpolationType

enum vtkPlusBuffer::DataItemTemporalInterpolationType

Tracker item temporal interpolation type

Enumerator
EXACT_TIME	only returns the item if the requested timestamp exactly matches the timestamp of an existing element
INTERPOLATED	returns interpolated transform (requires valid transform at the requested timestamp)
CLOSEST_TIME	returns the closest item

Definition at line 45 of file vtkPlusBuffer.h.

◆ TIMESTAMP_FILTERING_OPTION

enum vtkPlusBuffer::TIMESTAMP_FILTERING_OPTION

Enumerator
READ_FILTERED_AND_UNFILTERED_TIMESTAMPS
READ_UNFILTERED_COMPUTE_FILTERED_TIMESTAMPS
READ_FILTERED_IGNORE_UNFILTERED_TIMESTAMPS

Definition at line 37 of file vtkPlusBuffer.h.

Constructor & Destructor Documentation

◆ vtkPlusBuffer()

vtkPlusBuffer::vtkPlusBuffer ( )

protected

Definition at line 79 of file vtkPlusBuffer.cxx.

◆ ~vtkPlusBuffer()

vtkPlusBuffer::~vtkPlusBuffer ( )

protected

Definition at line 99 of file vtkPlusBuffer.cxx.

Member Function Documentation

◆ AddItem() [1/5]

PlusStatus vtkPlusBuffer::AddItem	(	vtkImageData *	frame,
		US_IMAGE_ORIENTATION	usImageOrientation,
		US_IMAGE_TYPE	imageType,
		long	frameNumber,
		const std::array< int, 3 > &	clipRectangleOrigin,
		const std::array< int, 3 > &	clipRectangleSize,
		double	unfilteredTimestamp = `UNDEFINED_TIMESTAMP`,
		double	filteredTimestamp = `UNDEFINED_TIMESTAMP`,
		const igsioFieldMapType *	customFields = `NULL`
	)

virtual

Add a frame plus a timestamp to the buffer with frame index. If the timestamp is less than or equal to the previous timestamp, or if the frame's format doesn't match the buffer's frame format, then the frame is not added to the buffer. If a clip rectangle is defined then only that portion of the frame is extracted.

Definition at line 227 of file vtkPlusBuffer.cxx.

◆ AddItem() [2/5]

PlusStatus vtkPlusBuffer::AddItem	(	const igsioVideoFrame *	frame,
		long	frameNumber,
		const std::array< int, 3 > &	clipRectangleOrigin,
		const std::array< int, 3 > &	clipRectangleSize,
		double	unfilteredTimestamp = `UNDEFINED_TIMESTAMP`,
		double	filteredTimestamp = `UNDEFINED_TIMESTAMP`,
		const igsioFieldMapType *	customFields = `NULL`
	)

virtual

Add a frame plus a timestamp to the buffer with frame index. If the timestamp is less than or equal to the previous timestamp, or if the frame's format doesn't match the buffer's frame format, then the frame is not added to the buffer. If a clip rectangle is defined then only that portion of the frame is extracted.

Definition at line 267 of file vtkPlusBuffer.cxx.

◆ AddItem() [3/5]

PlusStatus vtkPlusBuffer::AddItem	(	void *	imageDataPtr,
		US_IMAGE_ORIENTATION	usImageOrientation,
		const FrameSizeType &	inputFrameSizeInPx,
		igsioCommon::VTKScalarPixelType	pixelType,
		unsigned int	numberOfScalarComponents,
		US_IMAGE_TYPE	imageType,
		int	numberOfBytesToSkip,
		long	frameNumber,
		const std::array< int, 3 > &	clipRectangleOrigin,
		const std::array< int, 3 > &	clipRectangleSize,
		double	unfilteredTimestamp = `UNDEFINED_TIMESTAMP`,
		double	filteredTimestamp = `UNDEFINED_TIMESTAMP`,
		const igsioFieldMapType *	customFields = `NULL`,
		vtkStreamingVolumeFrame *	encodedFrame = `NULL`
	)

virtual

Add a frame plus a timestamp to the buffer with frame index. Additionally an optional field name&value can be added, which will be saved as a custom field of the added item. If the timestamp is less than or equal to the previous timestamp, or if the frame's format doesn't match the buffer's frame format, then the frame is not added to the buffer. If a clip rectangle is defined then only that portion of the image is extracted.

Definition at line 389 of file vtkPlusBuffer.cxx.

◆ AddItem() [4/5]

PlusStatus vtkPlusBuffer::AddItem	(	void *	imageDataPtr,
		const FrameSizeType &	frameSize,
		unsigned int	frameSizeInBytes,
		US_IMAGE_TYPE	imageType,
		long	frameNumber,
		double	unfilteredTimestamp = `UNDEFINED_TIMESTAMP`,
		double	filteredTimestamp = `UNDEFINED_TIMESTAMP`,
		const igsioFieldMapType *	customFields = `NULL`
	)

virtual

Add a frame plus a timestamp to the buffer with frame index. Additionally an optional field name&value can be added, which will be saved as a custom field of the added item. If the timestamp is less than or equal to the previous timestamp, or if the frame's size doesn't match the frame size of the buffer, then the frame is not added. This overload is only used for storing compressed or variable frame size entries

Definition at line 540 of file vtkPlusBuffer.cxx.

◆ AddItem() [5/5]

PlusStatus vtkPlusBuffer::AddItem	(	const igsioFieldMapType &	fields,
		long	frameNumber,
		double	unfilteredTimestamp = `UNDEFINED_TIMESTAMP`,
		double	filteredTimestamp = `UNDEFINED_TIMESTAMP`
	)

virtual

Add custom fields to the new item If the timestamp is less than or equal to the previous timestamp, or if the frame's format doesn't match the buffer's frame format, then the frame is not added to the buffer.

Definition at line 321 of file vtkPlusBuffer.cxx.

◆ AddTimeStampedItem()

PlusStatus vtkPlusBuffer::AddTimeStampedItem	(	vtkMatrix4x4 *	matrix,
		ToolStatus	status,
		unsigned long	frameNumber,
		double	unfilteredTimestamp,
		double	filteredTimestamp = `UNDEFINED_TIMESTAMP`,
		const igsioFieldMapType *	customFields = `NULL`
	)

Add a matrix plus status to the list, with an exactly known timestamp value (e.g., provided by a high-precision hardware timer). If the timestamp is less than or equal to the previous timestamp, then nothing will be done. If filteredTimestamp argument is undefined then the filtered timestamp will be computed from the input unfiltered timestamp.

Definition at line 631 of file vtkPlusBuffer.cxx.

◆ AllocateMemoryForFrames()

PlusStatus vtkPlusBuffer::AllocateMemoryForFrames ( )

protectedvirtual

Update video buffer by setting the frame format for each frame

Definition at line 127 of file vtkPlusBuffer.cxx.

◆ CheckFrameFormat()

bool vtkPlusBuffer::CheckFrameFormat	(	const FrameSizeType &	frameSizeInPx,
		igsioCommon::VTKScalarPixelType	pixelType,
		US_IMAGE_TYPE	imgType,
		int	numberOfScalarComponents
	)

protectedvirtual

Compares frame format with new frame imaging parameters.

Returns: true if current buffer frame format matches the method arguments, otherwise false

Definition at line 192 of file vtkPlusBuffer.cxx.

◆ Clear()

void vtkPlusBuffer::Clear ( )

virtual

Clear buffer (set the buffer pointer to the first element)

Definition at line 811 of file vtkPlusBuffer.cxx.

◆ CopyImagesFromTrackedFrameList()

PlusStatus vtkPlusBuffer::CopyImagesFromTrackedFrameList	(	vtkIGSIOTrackedFrameList *	sourceTrackedFrameList,
		TIMESTAMP_FILTERING_OPTION	timestampFiltering,
		bool	copyFrameFields
	)

Copy images from a tracked frame buffer. It is useful when data is stored in a metafile and the data is needed as a vtkPlusDataBuffer.

Definition at line 910 of file vtkPlusBuffer.cxx.

◆ CopyTransformFromTrackedFrameList()

PlusStatus vtkPlusBuffer::CopyTransformFromTrackedFrameList	(	vtkIGSIOTrackedFrameList *	sourceTrackedFrameList,
		TIMESTAMP_FILTERING_OPTION	timestampFiltering,
		igsioTransformName &	transformName
	)

Copy a specified transform to a tracker buffer. It is useful when tracking-only data is stored in a metafile (with dummy image data), which is read by a sequence metafile reader, and the result is needed as a vtkPlusDataBuffer. If useFilteredTimestamps is true, then the filtered timestamps that are stored in the buffer will be copied to the tracker buffer. If useFilteredTimestamps is false, then only unfiltered timestamps will be copied to the tracker buffer and the tracker buffer will compute the filtered timestamps.

Definition at line 1504 of file vtkPlusBuffer.cxx.

◆ DeepCopy()

void vtkPlusBuffer::DeepCopy ( vtkPlusBuffer * buffer )

virtual

Make this buffer into a copy of another buffer. You should Lock both of the buffers before doing this.

Definition at line 794 of file vtkPlusBuffer.cxx.

◆ GetAveragedItemsForFiltering()

int vtkPlusBuffer::GetAveragedItemsForFiltering ( )

virtual

Definition at line 742 of file vtkPlusBuffer.cxx.

◆ GetBufferIndexFromTime()

ItemStatus vtkPlusBuffer::GetBufferIndexFromTime	(	const double	time,
		int &	bufferIndex
	)

Given a timestamp, compute the nearest buffer index This assumes that the times monotonically increase

Definition at line 730 of file vtkPlusBuffer.cxx.

◆ GetBufferSize()

int vtkPlusBuffer::GetBufferSize ( )

virtual

Get the size of the buffer

Definition at line 159 of file vtkPlusBuffer.cxx.

◆ GetClassName()

virtual const char* vtkPlusBuffer::GetClassName ( )

virtual

◆ GetDescriptiveName()

virtual char* vtkPlusBuffer::GetDescriptiveName ( )

virtual

◆ GetFrameRate()

virtual double vtkPlusBuffer::GetFrameRate	(	bool	ideal = `false`,
		double *	framePeriodStdevSecPtr = `NULL`
	)

inlinevirtual

Get the frame rate from the buffer based on the number of frames in the buffer and the elapsed time. Ideal frame rate shows the mean of the frame periods in the buffer based on the frame number difference (aka the device frame rate). If framePeriodStdevSecPtr is not null, then the standard deviation of the frame period is computed as well (in seconds) and stored at the specified address.

Definition at line 229 of file vtkPlusBuffer.h.

◆ GetFrameSize() [1/2]

FrameSizeType vtkPlusBuffer::GetFrameSize ( ) const

virtual

Get the frame size in pixel

Definition at line 1645 of file vtkPlusBuffer.cxx.

◆ GetFrameSize() [2/2]

PlusStatus vtkPlusBuffer::GetFrameSize	(	unsigned int &	_arg1,
		unsigned int &	_arg2,
		unsigned int &	_arg3
	)		const

virtual

Definition at line 1635 of file vtkPlusBuffer.cxx.

◆ GetImageOrientation()

virtual US_IMAGE_ORIENTATION vtkPlusBuffer::GetImageOrientation ( )

virtual

Get the image orientation (MF, MN, ...)

◆ GetImageType()

virtual US_IMAGE_TYPE vtkPlusBuffer::GetImageType ( )

virtual

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

◆ GetIndex()

ItemStatus vtkPlusBuffer::GetIndex	(	const BufferItemUidType	uid,
		unsigned long &	index
	)

virtual

Get the index assigned by the data acquisition system (usually a counter) from the buffer by frame UID.

Definition at line 723 of file vtkPlusBuffer.cxx.

◆ GetInterpolatedStreamBufferItemFromTime()

ItemStatus vtkPlusBuffer::GetInterpolatedStreamBufferItemFromTime	(	double	time,
		StreamBufferItem *	bufferItem
	)

protectedvirtual

Interpolate the matrix for the given timestamp from the two nearest transforms in the buffer. The rotation is interpolated with SLERP interpolation, and the position is interpolated with linear interpolation. The flags correspond to the closest element.

Definition at line 1365 of file vtkPlusBuffer.cxx.

◆ GetItemUidFromTime()

virtual ItemStatus vtkPlusBuffer::GetItemUidFromTime	(	double	time,
		BufferItemUidType &	uid
	)

inlinevirtual

Definition at line 206 of file vtkPlusBuffer.h.

◆ GetLatestItemHasValidFieldData()

bool vtkPlusBuffer::GetLatestItemHasValidFieldData ( )

virtual

Returns true if the latest item contains valid field data

Definition at line 1663 of file vtkPlusBuffer.cxx.

◆ GetLatestItemHasValidTransformData()

bool vtkPlusBuffer::GetLatestItemHasValidTransformData ( )

virtual

Returns true if the latest item contains valid transform data

Definition at line 1657 of file vtkPlusBuffer.cxx.

◆ GetLatestItemHasValidVideoData()

bool vtkPlusBuffer::GetLatestItemHasValidVideoData ( )

virtual

Returns true if the latest item contains valid video data

Definition at line 1651 of file vtkPlusBuffer.cxx.

◆ GetLatestItemUidInBuffer()

virtual BufferItemUidType vtkPlusBuffer::GetLatestItemUidInBuffer ( )

inlinevirtual

Definition at line 202 of file vtkPlusBuffer.h.

◆ GetLatestStreamBufferItem()

virtual ItemStatus vtkPlusBuffer::GetLatestStreamBufferItem ( StreamBufferItem * bufferItem )

inlinevirtual

Get the most recent frame from the buffer

Definition at line 157 of file vtkPlusBuffer.h.

◆ GetLatestTimeStamp()

ItemStatus vtkPlusBuffer::GetLatestTimeStamp ( double & latestTimestamp )

virtual

Get latest timestamp in the buffer

Definition at line 705 of file vtkPlusBuffer.cxx.

◆ GetLocalTimeOffsetSec()

double vtkPlusBuffer::GetLocalTimeOffsetSec ( )

virtual

Get the local time offset in seconds (global = local + offset)

Definition at line 153 of file vtkPlusBuffer.cxx.

◆ GetMaxAllowedTimeDifference()

virtual double vtkPlusBuffer::GetMaxAllowedTimeDifference ( )

virtual

Get maximum allowed time difference in seconds between the desired and the closest valid timestamp

◆ GetNumberOfBytesPerPixel()

int vtkPlusBuffer::GetNumberOfBytesPerPixel ( )

Get the number of bytes per pixel It is the number of bytes per scalar multiplied by the number of scalar components.

Definition at line 904 of file vtkPlusBuffer.cxx.

◆ GetNumberOfBytesPerScalar()

int vtkPlusBuffer::GetNumberOfBytesPerScalar ( )

Get the number of bytes per scalar component

Definition at line 898 of file vtkPlusBuffer.cxx.

◆ GetNumberOfItems()

virtual int vtkPlusBuffer::GetNumberOfItems ( )

inlinevirtual

Get the number of items in the buffer

Definition at line 217 of file vtkPlusBuffer.h.

◆ GetNumberOfScalarComponents()

virtual unsigned int vtkPlusBuffer::GetNumberOfScalarComponents ( )

virtual

Get the number of scalar components

◆ GetOldestItemUidInBuffer()

virtual BufferItemUidType vtkPlusBuffer::GetOldestItemUidInBuffer ( )

inlinevirtual

Get buffer item unique ID

Definition at line 198 of file vtkPlusBuffer.h.

◆ GetOldestStreamBufferItem()

virtual ItemStatus vtkPlusBuffer::GetOldestStreamBufferItem ( StreamBufferItem * bufferItem )

inlinevirtual

Get the oldest frame from buffer

Definition at line 162 of file vtkPlusBuffer.h.

◆ GetOldestTimeStamp()

ItemStatus vtkPlusBuffer::GetOldestTimeStamp ( double & oldestTimestamp )

virtual

Get oldest timestamp in the buffer

Definition at line 711 of file vtkPlusBuffer.cxx.

◆ GetPixelType()

virtual igsioCommon::VTKScalarPixelType vtkPlusBuffer::GetPixelType ( )

virtual

Get the pixel type

◆ GetPrevNextBufferItemFromTime()

PlusStatus vtkPlusBuffer::GetPrevNextBufferItemFromTime	(	double	time,
		StreamBufferItem &	itemA,
		StreamBufferItem &	itemB
	)

protected

Returns the two buffer items that are closest previous and next buffer items relative to the specified time. itemA is the closest item

Definition at line 1160 of file vtkPlusBuffer.cxx.

◆ GetStartTime()

double vtkPlusBuffer::GetStartTime ( )

virtual

Get recording start time

Definition at line 754 of file vtkPlusBuffer.cxx.

◆ GetStreamBufferItem()

ItemStatus vtkPlusBuffer::GetStreamBufferItem	(	BufferItemUidType	uid,
		StreamBufferItem *	bufferItem
	)

virtual

Get a frame with the specified frame uid from the buffer

Definition at line 766 of file vtkPlusBuffer.cxx.

◆ GetStreamBufferItemFromClosestTime()

ItemStatus vtkPlusBuffer::GetStreamBufferItemFromClosestTime	(	double	time,
		StreamBufferItem *	bufferItem
	)

protectedvirtual

Get tracker buffer item from the closest timestamp

Definition at line 1327 of file vtkPlusBuffer.cxx.

◆ GetStreamBufferItemFromExactTime()

ItemStatus vtkPlusBuffer::GetStreamBufferItemFromExactTime	(	double	time,
		StreamBufferItem *	bufferItem
	)

protectedvirtual

Get tracker buffer item from an exact timestamp

Definition at line 1306 of file vtkPlusBuffer.cxx.

◆ GetStreamBufferItemFromTime()

ItemStatus vtkPlusBuffer::GetStreamBufferItemFromTime	(	double	time,
		StreamBufferItem *	bufferItem,
		DataItemTemporalInterpolationType	interpolation
	)

virtual

Get a frame that was acquired at the specified time from buffer

Definition at line 1277 of file vtkPlusBuffer.cxx.

◆ GetTimeStamp()

ItemStatus vtkPlusBuffer::GetTimeStamp	(	BufferItemUidType	uid,
		double &	timestamp
	)

virtual

Get buffer item timestamp

Definition at line 717 of file vtkPlusBuffer.cxx.

◆ GetTimeStampReporting()

bool vtkPlusBuffer::GetTimeStampReporting ( )

If TimeStampReporting is enabled then all filtered and unfiltered timestamp values will be saved in a table for diagnostic purposes.

Definition at line 1152 of file vtkPlusBuffer.cxx.

◆ GetTimeStampReportTable()

PlusStatus vtkPlusBuffer::GetTimeStampReportTable ( vtkTable * timeStampReportTable )

virtual

Get the table report of the timestamped buffer

Definition at line 760 of file vtkPlusBuffer.cxx.

◆ IsA()

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

virtual

◆ IsTypeOf()

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

static

◆ ModifyBufferItemFrameField()

PlusStatus vtkPlusBuffer::ModifyBufferItemFrameField	(	BufferItemUidType	uid,
		const std::string &	key,
		const std::string &	value
	)

virtual

Definition at line 1294 of file vtkPlusBuffer.cxx.

◆ New()

static vtkPlusBuffer* vtkPlusBuffer::New ( )

static

◆ PrintSelf()

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

virtual

Definition at line 111 of file vtkPlusBuffer.cxx.

◆ SafeDownCast()

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

static

◆ SetAveragedItemsForFiltering()

void vtkPlusBuffer::SetAveragedItemsForFiltering ( int averagedItemsForFiltering )

virtual

Set number of items used for timestamp filtering (with LSQR mimimizer)

Definition at line 736 of file vtkPlusBuffer.cxx.

◆ SetBufferSize()

PlusStatus vtkPlusBuffer::SetBufferSize ( int n )

virtual

Set the size of the buffer, i.e. the maximum number of video frames that it will hold. The default is 30.

Definition at line 165 of file vtkPlusBuffer.cxx.

◆ SetDescriptiveName()

virtual void vtkPlusBuffer::SetDescriptiveName ( const char * )

virtual

◆ SetFrameSize() [1/2]

PlusStatus vtkPlusBuffer::SetFrameSize	(	unsigned int	x,
		unsigned int	y,
		unsigned int	z,
		bool	allocateFrames = `true`
	)

Set the frame size in pixel

Definition at line 817 of file vtkPlusBuffer.cxx.

◆ SetFrameSize() [2/2]

PlusStatus vtkPlusBuffer::SetFrameSize	(	const FrameSizeType &	frameSize,
		bool	allocateFrames = `true`
	)

Set the frame size in pixel

Definition at line 840 of file vtkPlusBuffer.cxx.

◆ SetImageOrientation()

PlusStatus vtkPlusBuffer::SetImageOrientation ( US_IMAGE_ORIENTATION imageOrientation )

Set the image orientation (MF, MN, ...). Does not reorder the pixels.

Definition at line 882 of file vtkPlusBuffer.cxx.

◆ SetImageType()

PlusStatus vtkPlusBuffer::SetImageType ( US_IMAGE_TYPE imageType )

Set the image type. Does not convert the pixel values.

Definition at line 870 of file vtkPlusBuffer.cxx.

◆ SetLocalTimeOffsetSec()

void vtkPlusBuffer::SetLocalTimeOffsetSec ( double offsetSec )

virtual

Set the local time offset in seconds (global = local + offset)

Definition at line 147 of file vtkPlusBuffer.cxx.

◆ SetMaxAllowedTimeDifference()

virtual void vtkPlusBuffer::SetMaxAllowedTimeDifference ( double )

virtual

Set maximum allowed time difference in seconds between the desired and the closest valid timestamp

◆ SetNumberOfScalarComponents()

PlusStatus vtkPlusBuffer::SetNumberOfScalarComponents ( unsigned int numberOfScalarComponents )

Set the number of scalar components

Definition at line 858 of file vtkPlusBuffer.cxx.

◆ SetPixelType()

PlusStatus vtkPlusBuffer::SetPixelType ( igsioCommon::VTKScalarPixelType pixelType )

Set the pixel type

Definition at line 846 of file vtkPlusBuffer.cxx.

◆ SetStartTime()

void vtkPlusBuffer::SetStartTime ( double startTime )

virtual

Set recording start time

Definition at line 748 of file vtkPlusBuffer.cxx.

◆ SetTimeStampReporting()

void vtkPlusBuffer::SetTimeStampReporting ( bool enable )

If TimeStampReporting is enabled then all filtered and unfiltered timestamp values will be saved in a table for diagnostic purposes.

Definition at line 1146 of file vtkPlusBuffer.cxx.

◆ WriteToSequenceFile()

PlusStatus vtkPlusBuffer::WriteToSequenceFile	(	const char *	filename,
		bool	useCompression = `false`
	)

virtual

Dump the current state of the video buffer to metafile

Definition at line 1077 of file vtkPlusBuffer.cxx.

Member Data Documentation

◆ DescriptiveName

char* vtkPlusBuffer::DescriptiveName

protected

Definition at line 372 of file vtkPlusBuffer.h.

◆ FrameSize

FrameSizeType vtkPlusBuffer::FrameSize

protected

Image frame size in pixel

Definition at line 351 of file vtkPlusBuffer.h.

◆ ImageOrientation

US_IMAGE_ORIENTATION vtkPlusBuffer::ImageOrientation

protected

Image orientation (MF, MN, ...)

Definition at line 363 of file vtkPlusBuffer.h.

◆ ImageType

US_IMAGE_TYPE vtkPlusBuffer::ImageType

protected

Image type (B-Mode, RF, ...)

Definition at line 360 of file vtkPlusBuffer.h.

◆ MaxAllowedTimeDifference

double vtkPlusBuffer::MaxAllowedTimeDifference

protected

Maximum allowed time difference in seconds between the desired and the closest valid timestamp

Definition at line 370 of file vtkPlusBuffer.h.

◆ NumberOfScalarComponents

unsigned int vtkPlusBuffer::NumberOfScalarComponents

protected

Number of scalar components

Definition at line 357 of file vtkPlusBuffer.h.

◆ PixelType

igsioCommon::VTKScalarPixelType vtkPlusBuffer::PixelType

protected

Image pixel type

Definition at line 354 of file vtkPlusBuffer.h.

◆ StreamBuffer

StreamItemCircularBuffer* vtkPlusBuffer::StreamBuffer

protected

Timestamped circular buffer that stores the last N frames

Definition at line 367 of file vtkPlusBuffer.h.

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

src/PlusDataCollection/vtkPlusBuffer.h
src/PlusDataCollection/vtkPlusBuffer.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ StreamItemCircularBuffer

◆ Superclass

Member Enumeration Documentation

◆ DataItemTemporalInterpolationType

◆ TIMESTAMP_FILTERING_OPTION

Constructor & Destructor Documentation

◆ vtkPlusBuffer()

◆ ~vtkPlusBuffer()

Member Function Documentation

◆ AddItem() [1/5]

◆ AddItem() [2/5]

◆ AddItem() [3/5]

◆ AddItem() [4/5]

◆ AddItem() [5/5]

◆ AddTimeStampedItem()

◆ AllocateMemoryForFrames()

◆ CheckFrameFormat()

◆ Clear()

◆ CopyImagesFromTrackedFrameList()

◆ CopyTransformFromTrackedFrameList()

◆ DeepCopy()

◆ GetAveragedItemsForFiltering()

◆ GetBufferIndexFromTime()

◆ GetBufferSize()

◆ GetClassName()

◆ GetDescriptiveName()

◆ GetFrameRate()

◆ GetFrameSize() [1/2]

◆ GetFrameSize() [2/2]

◆ GetImageOrientation()

◆ GetImageType()

◆ GetIndex()

◆ GetInterpolatedStreamBufferItemFromTime()

◆ GetItemUidFromTime()

◆ GetLatestItemHasValidFieldData()

◆ GetLatestItemHasValidTransformData()

◆ GetLatestItemHasValidVideoData()

◆ GetLatestItemUidInBuffer()

◆ GetLatestStreamBufferItem()

◆ GetLatestTimeStamp()

◆ GetLocalTimeOffsetSec()

◆ GetMaxAllowedTimeDifference()

◆ GetNumberOfBytesPerPixel()

◆ GetNumberOfBytesPerScalar()

◆ GetNumberOfItems()

◆ GetNumberOfScalarComponents()

◆ GetOldestItemUidInBuffer()

◆ GetOldestStreamBufferItem()

◆ GetOldestTimeStamp()

◆ GetPixelType()

◆ GetPrevNextBufferItemFromTime()

◆ GetStartTime()

◆ GetStreamBufferItem()

◆ GetStreamBufferItemFromClosestTime()

◆ GetStreamBufferItemFromExactTime()

◆ GetStreamBufferItemFromTime()

◆ GetTimeStamp()

◆ GetTimeStampReporting()

◆ GetTimeStampReportTable()

◆ IsA()

◆ IsTypeOf()

◆ ModifyBufferItemFrameField()

◆ New()

◆ PrintSelf()

◆ SafeDownCast()

◆ SetAveragedItemsForFiltering()

◆ SetBufferSize()

◆ SetDescriptiveName()

◆ SetFrameSize() [1/2]

◆ SetFrameSize() [2/2]

◆ SetImageOrientation()

◆ SetImageType()