vtkPlusDataSource Class Reference

Interface to a 3D positioning tool, video source, or generalized data stream. More...

#include <src/PlusDataCollection/vtkPlusDataSource.h>

Inheritance diagram for vtkPlusDataSource:

Collaboration diagram for vtkPlusDataSource:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual PlusStatus	AddItem (vtkImageData *frame, US_IMAGE_ORIENTATION usImageOrientation, US_IMAGE_TYPE imageType, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)
virtual PlusStatus	AddItem (const igsioVideoFrame *frame, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)
virtual PlusStatus	AddItem (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)
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 &customFields, 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 ()
void	DeepCopy (const vtkPlusDataSource &source)
virtual PlusStatus	DeepCopyBufferTo (vtkPlusBuffer &bufferToFill)
virtual int	GetBufferSize ()
virtual const char *	GetClassName ()
std::array< int, 3 >	GetClipRectangleOrigin () const
std::array< int, 3 >	GetClipRectangleSize () const
std::string	GetCustomProperty (const std::string &propertyName)
vtkPlusDevice *	GetDevice ()
virtual double	GetFrameRate (bool ideal=false, double *framePeriodStdevSecPtr=NULL)
US_IMAGE_TYPE	GetImageType ()
virtual ItemStatus	GetIndex (const BufferItemUidType uid, unsigned long &index)
FrameSizeType	GetInputFrameSize () const
virtual US_IMAGE_ORIENTATION	GetInputImageOrientation ()
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 ()
int	GetNumberOfBytesPerPixel ()
virtual int	GetNumberOfItems ()
virtual unsigned int	GetNumberOfScalarComponents ()
virtual BufferItemUidType	GetOldestItemUidInBuffer ()
virtual ItemStatus	GetOldestStreamBufferItem (StreamBufferItem *bufferItem)
virtual ItemStatus	GetOldestTimeStamp (double &oldestTimestamp)
virtual FrameSizeType	GetOutputFrameSize () const
virtual PlusStatus	GetOutputFrameSize (unsigned int &_arg1, unsigned int &_arg2, unsigned int &_arg3) const
virtual US_IMAGE_ORIENTATION	GetOutputImageOrientation ()
virtual igsioCommon::VTKScalarPixelType	GetPixelType ()
std::string	GetSourceId () const
virtual double	GetStartTime ()
virtual ItemStatus	GetStreamBufferItem (BufferItemUidType uid, StreamBufferItem *bufferItem)
virtual ItemStatus	GetStreamBufferItemFromTime (double time, StreamBufferItem *bufferItem, vtkPlusBuffer::DataItemTemporalInterpolationType interpolation)
virtual ItemStatus	GetTimeStamp (BufferItemUidType uid, double &timestamp)
bool	GetTimeStampReporting ()
virtual PlusStatus	GetTimeStampReportTable (vtkTable *timeStampReportTable)
std::string	GetTransformName () const
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 PlusStatus	ReadConfiguration (vtkXMLDataElement *toolElement, bool requirePortNameInSourceConfiguration=false, bool requireImageOrientationInChannelConfiguration=false, const std::string &aDescriptiveNameForBuffer=std::string(""))
virtual PlusStatus	SetBufferSize (int n)
void	SetClipRectangleOrigin (const std::array< int, 3 > _arg)
void	SetClipRectangleSize (const std::array< int, 3 > _arg)
void	SetCustomProperty (const std::string &propertyName, const std::string &propertyValue)
void	SetDevice (vtkPlusDevice *_arg)
virtual void	SetFrameNumber (unsigned long)
PlusStatus	SetId (const char *aSourceId)
PlusStatus	SetId (const std::string &aSourceId)
PlusStatus	SetImageType (US_IMAGE_TYPE imageType)
PlusStatus	SetInputFrameSize (unsigned int x, unsigned int y, unsigned int z)
PlusStatus	SetInputFrameSize (const FrameSizeType &frameSize)
virtual PlusStatus	SetInputImageOrientation (US_IMAGE_ORIENTATION imageOrientation)
virtual void	SetLocalTimeOffsetSec (double offsetSec)
PlusStatus	SetNumberOfScalarComponents (unsigned int numberOfScalarComponents)
virtual PlusStatus	SetOutputImageOrientation (US_IMAGE_ORIENTATION imageOrientation)
PlusStatus	SetPixelType (igsioCommon::VTKScalarPixelType pixelType)
PlusStatus	SetPortName (const std::string &portName)
PlusStatus	SetPortName (const char *portName)
PlusStatus	SetReferenceCoordinateFrameName (const char *referenceName)
PlusStatus	SetReferenceCoordinateFrameName (const std::string &referenceName)
PlusStatus	SetSourceId (const std::string &aSourceId)
virtual void	SetStartTime (double startTime)
void	SetTimeStampReporting (bool enable)
virtual void	SetType (DataSourceType)
	vtkGetMacroConst (Type, DataSourceType)
	vtkGetMacroConst (FrameNumber, unsigned long)
	vtkGetStdStringMacro (Id)
	vtkGetStdStringMacro (ReferenceCoordinateFrameName)
	vtkGetStdStringMacro (PortName)
virtual PlusStatus	WriteCompactConfiguration (vtkXMLDataElement *toolElement)
virtual PlusStatus	WriteConfiguration (vtkXMLDataElement *toolElement)
virtual PlusStatus	WriteToSequenceFile (const char *filename, bool useCompression=false)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkPlusDataSource *	New ()
static vtkPlusDataSource *	SafeDownCast (vtkObject *o)

Static Public Attributes
static std::string	DATA_SOURCE_TYPE_FIELDDATA_TAG = "FieldData"
static std::string	DATA_SOURCE_TYPE_TOOL_TAG = "Tool"
static std::string	DATA_SOURCE_TYPE_VIDEO_TAG = "Video"

Protected Member Functions
virtual vtkPlusBuffer *	GetBuffer () const
	vtkPlusDataSource ()
	~vtkPlusDataSource ()

Protected Attributes
vtkPlusBuffer *	Buffer
std::array< int, 3 >	ClipRectangleOrigin
std::array< int, 3 >	ClipRectangleSize
CustomPropertyMap	CustomProperties
vtkPlusDevice *	Device
unsigned long	FrameNumber
std::string	Id
FrameSizeType	InputFrameSize
US_IMAGE_ORIENTATION	InputImageOrientation
std::string	PortName
std::string	ReferenceCoordinateFrameName
DataSourceType	Type

Detailed Description

Interface to a 3D positioning tool, video source, or generalized data stream.

Definition at line 42 of file vtkPlusDataSource.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPlusDataSource::Superclass

Definition at line 55 of file vtkPlusDataSource.h.

Constructor & Destructor Documentation

vtkPlusDataSource()

vtkPlusDataSource::vtkPlusDataSource ( )

protected

Definition at line 27 of file vtkPlusDataSource.cxx.

~vtkPlusDataSource()

vtkPlusDataSource::~vtkPlusDataSource ( )

protected

Definition at line 51 of file vtkPlusDataSource.cxx.

Member Function Documentation

AddItem() [1/5]

PlusStatus vtkPlusDataSource::AddItem ( vtkImageData *  frame, US_IMAGE_ORIENTATION  usImageOrientation, 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. 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 549 of file vtkPlusDataSource.cxx.

AddItem() [2/5]

PlusStatus vtkPlusDataSource::AddItem ( const igsioVideoFrame *  frame, 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. 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 555 of file vtkPlusDataSource.cxx.

AddItem() [3/5]

PlusStatus vtkPlusDataSource::AddItem ( 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  )

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.

Definition at line 568 of file vtkPlusDataSource.cxx.

AddItem() [4/5]

PlusStatus vtkPlusDataSource::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 format doesn't match the buffer's frame format, then the frame is not added to the buffer.

Definition at line 577 of file vtkPlusDataSource.cxx.

AddItem() [5/5]

PlusStatus vtkPlusDataSource::AddItem ( const igsioFieldMapType &  customFields, 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 561 of file vtkPlusDataSource.cxx.

AddTimeStampedItem()

PlusStatus vtkPlusDataSource::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 filteredTiemstamp argument is undefined then the filtered timestamp will be computed from the input unfiltered timestamp.

Definition at line 921 of file vtkPlusDataSource.cxx.

Clear()

void vtkPlusDataSource::Clear ( )

virtual

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

Definition at line 841 of file vtkPlusDataSource.cxx.

DeepCopy()

void vtkPlusDataSource::DeepCopy

(

const vtkPlusDataSource &

source

)

Make this tracker into a copy of another tracker. You should lock both of the tracker buffers before doing this.

Definition at line 211 of file vtkPlusDataSource.cxx.

DeepCopyBufferTo()

PlusStatus vtkPlusDataSource::DeepCopyBufferTo ( vtkPlusBuffer &  bufferToFill )

virtual

Make a copy of the buffer

Definition at line 913 of file vtkPlusDataSource.cxx.

GetBuffer()

vtkPlusBuffer * vtkPlusDataSource::GetBuffer ( ) const

protectedvirtual

Access the data buffer

Definition at line 680 of file vtkPlusDataSource.cxx.

GetBufferSize()

int vtkPlusDataSource::GetBufferSize ( )

virtual

Get the size of the buffer

Definition at line 853 of file vtkPlusDataSource.cxx.

GetClassName()

virtual const char* vtkPlusDataSource::GetClassName ( )

virtual

GetClipRectangleOrigin()

std::array< int, 3 > vtkPlusDataSource::GetClipRectangleOrigin

(

)

const

Get the clip rectangle origin to apply to the image in pixel coordinates. If the ClipRectangleSize is (0,0) then the whole frame is captured.

Definition at line 233 of file vtkPlusDataSource.cxx.

GetClipRectangleSize()

std::array< int, 3 > vtkPlusDataSource::GetClipRectangleSize

(

)

const

Get the clip rectangle size to apply to the image in pixel coordinates. If the ClipRectangleSize is (0,0) then the values are ignored and the whole frame is captured.

Definition at line 227 of file vtkPlusDataSource.cxx.

GetCustomProperty()

std::string vtkPlusDataSource::GetCustomProperty

(

const std::string &

propertyName

)

Get a custom property string. If the property is not defined then an empty string is returned.

Definition at line 531 of file vtkPlusDataSource.cxx.

GetDevice()

vtkPlusDevice* vtkPlusDataSource::GetDevice ( )

inline

Definition at line 266 of file vtkPlusDataSource.h.

GetFrameRate()

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

virtual

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 939 of file vtkPlusDataSource.cxx.

GetImageType()

US_IMAGE_TYPE vtkPlusDataSource::GetImageType

(

)

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

Definition at line 583 of file vtkPlusDataSource.cxx.

GetIndex()

ItemStatus vtkPlusDataSource::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 933 of file vtkPlusDataSource.cxx.

GetInputFrameSize()

FrameSizeType vtkPlusDataSource::GetInputFrameSize

(

)

const

Get the input frame size in pixel

Definition at line 662 of file vtkPlusDataSource.cxx.

GetInputImageOrientation()

US_IMAGE_ORIENTATION vtkPlusDataSource::GetInputImageOrientation ( )

virtual

Get the image orientation of the input data (MF, MN, ...). The internal buffer's image orientation and the output is always the standard MF (for B-mode) or FM (for RF-mode).

Definition at line 727 of file vtkPlusDataSource.cxx.

GetItemUidFromTime()

ItemStatus vtkPlusDataSource::GetItemUidFromTime ( double  time, BufferItemUidType &  uid  )

virtual

Definition at line 787 of file vtkPlusDataSource.cxx.

GetLatestItemHasValidFieldData()

bool vtkPlusDataSource::GetLatestItemHasValidFieldData ( )

virtual

Returns true if the latest item contains valid field data

Definition at line 805 of file vtkPlusDataSource.cxx.

GetLatestItemHasValidTransformData()

bool vtkPlusDataSource::GetLatestItemHasValidTransformData ( )

virtual

Returns true if the latest item contains valid transform data

Definition at line 799 of file vtkPlusDataSource.cxx.

GetLatestItemHasValidVideoData()

bool vtkPlusDataSource::GetLatestItemHasValidVideoData ( )

virtual

Returns true if the latest item contains valid video data

Definition at line 793 of file vtkPlusDataSource.cxx.

GetLatestItemUidInBuffer()

BufferItemUidType vtkPlusDataSource::GetLatestItemUidInBuffer ( )

virtual

Definition at line 781 of file vtkPlusDataSource.cxx.

GetLatestStreamBufferItem()

ItemStatus vtkPlusDataSource::GetLatestStreamBufferItem ( StreamBufferItem *  bufferItem )

virtual

Get the most recent frame from the buffer

Definition at line 817 of file vtkPlusDataSource.cxx.

GetLatestTimeStamp()

ItemStatus vtkPlusDataSource::GetLatestTimeStamp ( double &  latestTimestamp )

virtual

Get latest timestamp in the buffer

Definition at line 859 of file vtkPlusDataSource.cxx.

GetLocalTimeOffsetSec()

double vtkPlusDataSource::GetLocalTimeOffsetSec ( )

virtual

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

Definition at line 883 of file vtkPlusDataSource.cxx.

GetNumberOfBytesPerPixel()

int vtkPlusDataSource::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 927 of file vtkPlusDataSource.cxx.

GetNumberOfItems()

int vtkPlusDataSource::GetNumberOfItems ( )

virtual

Get the number of items in the buffer

Definition at line 769 of file vtkPlusDataSource.cxx.

GetNumberOfScalarComponents()

unsigned int vtkPlusDataSource::GetNumberOfScalarComponents ( )

virtual

Get the number of scalar components

Definition at line 739 of file vtkPlusDataSource.cxx.

GetOldestItemUidInBuffer()

BufferItemUidType vtkPlusDataSource::GetOldestItemUidInBuffer ( )

virtual

Get buffer item unique ID

Definition at line 775 of file vtkPlusDataSource.cxx.

GetOldestStreamBufferItem()

ItemStatus vtkPlusDataSource::GetOldestStreamBufferItem ( StreamBufferItem *  bufferItem )

virtual

Get the oldest frame from buffer

Definition at line 823 of file vtkPlusDataSource.cxx.

GetOldestTimeStamp()

ItemStatus vtkPlusDataSource::GetOldestTimeStamp ( double &  oldestTimestamp )

virtual

Get oldest timestamp in the buffer

Definition at line 865 of file vtkPlusDataSource.cxx.

GetOutputFrameSize() [1/2]

FrameSizeType vtkPlusDataSource::GetOutputFrameSize ( ) const

virtual

Get the output frame size in pixel. If no clipping rectangle is set then the output frame size is the clipping rectangle size; otherwise it is the input frame size

Definition at line 668 of file vtkPlusDataSource.cxx.

GetOutputFrameSize() [2/2]

PlusStatus vtkPlusDataSource::GetOutputFrameSize ( unsigned int &  _arg1, unsigned int &  _arg2, unsigned int &  _arg3  ) const

virtual

Definition at line 674 of file vtkPlusDataSource.cxx.

GetOutputImageOrientation()

US_IMAGE_ORIENTATION vtkPlusDataSource::GetOutputImageOrientation ( )

virtual

Definition at line 721 of file vtkPlusDataSource.cxx.

GetPixelType()

igsioCommon::VTKScalarPixelType vtkPlusDataSource::GetPixelType ( )

virtual

Get the pixel type

Definition at line 745 of file vtkPlusDataSource.cxx.

GetSourceId()

std::string vtkPlusDataSource::GetSourceId

(

)

const

Definition at line 139 of file vtkPlusDataSource.cxx.

GetStartTime()

double vtkPlusDataSource::GetStartTime ( )

virtual

Get recording start time

Definition at line 763 of file vtkPlusDataSource.cxx.

GetStreamBufferItem()

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

virtual

Get a frame with the specified frame uid from the buffer

Definition at line 811 of file vtkPlusDataSource.cxx.

GetStreamBufferItemFromTime()

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

virtual

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

Definition at line 829 of file vtkPlusDataSource.cxx.

GetTimeStamp()

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

virtual

Get video buffer item timestamp

Definition at line 871 of file vtkPlusDataSource.cxx.

GetTimeStampReporting()

bool vtkPlusDataSource::GetTimeStampReporting

(

)

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

Definition at line 901 of file vtkPlusDataSource.cxx.

GetTimeStampReportTable()

PlusStatus vtkPlusDataSource::GetTimeStampReportTable ( vtkTable *  timeStampReportTable )

virtual

Get the table report of the timestamped buffer

Definition at line 889 of file vtkPlusDataSource.cxx.

GetTransformName()

std::string vtkPlusDataSource::GetTransformName

(

)

const

Definition at line 523 of file vtkPlusDataSource.cxx.

IsA()

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

virtual

IsTypeOf()

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

static

ModifyBufferItemFrameField()

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

virtual

Update a field in the specified stream buffer item

Definition at line 835 of file vtkPlusDataSource.cxx.

New()

static vtkPlusDataSource* vtkPlusDataSource::New ( )

static

PrintSelf()

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

virtual

Definition at line 61 of file vtkPlusDataSource.cxx.

ReadConfiguration()

PlusStatus vtkPlusDataSource::ReadConfiguration ( vtkXMLDataElement *  toolElement, bool  requirePortNameInSourceConfiguration = false, bool  requireImageOrientationInChannelConfiguration = false, const std::string &  aDescriptiveNameForBuffer = std::string("")  )

virtual

Read main configuration from xml data

Definition at line 251 of file vtkPlusDataSource.cxx.

SafeDownCast()

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

static

SetBufferSize()

PlusStatus vtkPlusDataSource::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 847 of file vtkPlusDataSource.cxx.

SetClipRectangleOrigin()

void vtkPlusDataSource::SetClipRectangleOrigin

(

const std::array< int, 3 >

_arg

)

Set the clip rectangle origin to apply to the image in pixel coordinates. If the ClipRectangleSize is (0,0) then the whole frame is captured.

Definition at line 245 of file vtkPlusDataSource.cxx.

SetClipRectangleSize()

void vtkPlusDataSource::SetClipRectangleSize

(

const std::array< int, 3 >

_arg

)

Set the clip rectangle size to apply to the image in pixel coordinates. If the ClipRectangleSize is (0,0) then the values are ignored and the whole frame is captured. Width of the ClipRectangle typically have to be a multiple of 4.

Definition at line 239 of file vtkPlusDataSource.cxx.

SetCustomProperty()

void vtkPlusDataSource::SetCustomProperty	(	const std::string &	propertyName,
		const std::string &	propertyValue
	)

Set a custom property string. Custom properties are useful because custom information can be stored for each tool in the same class object where standard properties of the tool are stored.

Definition at line 543 of file vtkPlusDataSource.cxx.

SetDevice()

void vtkPlusDataSource::SetDevice ( vtkPlusDevice *  _arg )

inline

Get the device which owns this source.

Definition at line 265 of file vtkPlusDataSource.h.

SetFrameNumber()

virtual void vtkPlusDataSource::SetFrameNumber ( unsigned long  )

virtual

SetId() [1/2]

PlusStatus vtkPlusDataSource::SetId

(

const char *

aSourceId

)

Set source Id. SourceId is used to identify the data source among all the data sources provided by the device therefore it must be unique

Definition at line 102 of file vtkPlusDataSource.cxx.

SetId() [2/2]

PlusStatus vtkPlusDataSource::SetId

(

const std::string &

aSourceId

)

Definition at line 113 of file vtkPlusDataSource.cxx.

SetImageType()

PlusStatus vtkPlusDataSource::SetImageType

(

US_IMAGE_TYPE

imageType

)

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

Definition at line 589 of file vtkPlusDataSource.cxx.

SetInputFrameSize() [1/2]

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

Set the non-clipped input frame size in pixel

Definition at line 595 of file vtkPlusDataSource.cxx.

SetInputFrameSize() [2/2]

PlusStatus vtkPlusDataSource::SetInputFrameSize

(

const FrameSizeType &

frameSize

)

Set the non-clipped input frame size in pixel

Definition at line 656 of file vtkPlusDataSource.cxx.

SetInputImageOrientation()

PlusStatus vtkPlusDataSource::SetInputImageOrientation ( US_IMAGE_ORIENTATION  imageOrientation )

virtual

Set the image orientation of the input data (MF, MN, ...). The internal buffer's image orientation and the output is always the standard MF (for B-mode) or FM (for RF-mode), so the input images are reoriented as needed when AddItem(...) is called. This method is necessary for initializing the storage buffers and also serves as a convenient storage for the image orientation of the hardware device.

Definition at line 686 of file vtkPlusDataSource.cxx.

SetLocalTimeOffsetSec()

void vtkPlusDataSource::SetLocalTimeOffsetSec ( double  offsetSec )

virtual

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

Definition at line 877 of file vtkPlusDataSource.cxx.

SetNumberOfScalarComponents()

PlusStatus vtkPlusDataSource::SetNumberOfScalarComponents

(

unsigned int

numberOfScalarComponents

)

Set the number of scalar components

Definition at line 733 of file vtkPlusDataSource.cxx.

SetOutputImageOrientation()

PlusStatus vtkPlusDataSource::SetOutputImageOrientation ( US_IMAGE_ORIENTATION  imageOrientation )

virtual

Set the image orientation of the internal buffer. It has to be MF for all imaging modes except RF (for that the orientation has to be FM).

Definition at line 709 of file vtkPlusDataSource.cxx.

SetPixelType()

PlusStatus vtkPlusDataSource::SetPixelType

(

igsioCommon::VTKScalarPixelType

pixelType

)

Set the pixel type

Definition at line 751 of file vtkPlusDataSource.cxx.

SetPortName() [1/2]

PlusStatus vtkPlusDataSource::SetPortName

(

const std::string &

portName

)

Set port name. Port name is used to identify the source among all the sources provided by the device therefore it must be unique

Definition at line 188 of file vtkPlusDataSource.cxx.

SetPortName() [2/2]

PlusStatus vtkPlusDataSource::SetPortName

(

const char *

portName

)

Definition at line 176 of file vtkPlusDataSource.cxx.

SetReferenceCoordinateFrameName() [1/2]

PlusStatus vtkPlusDataSource::SetReferenceCoordinateFrameName

(

const char *

referenceName

)

Set reference name. Reference name is used to convey context about the coordinate frame that the tool is based

Definition at line 165 of file vtkPlusDataSource.cxx.

SetReferenceCoordinateFrameName() [2/2]

PlusStatus vtkPlusDataSource::SetReferenceCoordinateFrameName

(

const std::string &

referenceName

)

Definition at line 145 of file vtkPlusDataSource.cxx.

SetSourceId()

PlusStatus vtkPlusDataSource::SetSourceId

(

const std::string &

aSourceId

)

Definition at line 133 of file vtkPlusDataSource.cxx.

SetStartTime()

void vtkPlusDataSource::SetStartTime ( double  startTime )

virtual

Set recording start time

Definition at line 757 of file vtkPlusDataSource.cxx.

SetTimeStampReporting()

void vtkPlusDataSource::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 895 of file vtkPlusDataSource.cxx.

SetType()

virtual void vtkPlusDataSource::SetType ( DataSourceType  )

virtual

vtkGetMacroConst() [1/2]

vtkPlusDataSource::vtkGetMacroConst	(	Type	,
		DataSourceType
	)

Get type: video or tool.

vtkGetMacroConst() [2/2]

vtkPlusDataSource::vtkGetMacroConst	(	FrameNumber	,
		unsigned long
	)

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

vtkGetStdStringMacro() [1/3]

vtkPlusDataSource::vtkGetStdStringMacro

(

Id

)

Get source id

vtkGetStdStringMacro() [2/3]

vtkPlusDataSource::vtkGetStdStringMacro

(

ReferenceCoordinateFrameName

)

Get the reference coordinate frame name

vtkGetStdStringMacro() [3/3]

vtkPlusDataSource::vtkGetStdStringMacro

(

PortName

)

Get port name. Port name is used to identify the tool among all the tools provided by the tracker device.

WriteCompactConfiguration()

PlusStatus vtkPlusDataSource::WriteCompactConfiguration ( vtkXMLDataElement *  toolElement )

virtual

WriteCompactConfiguration is called when a channel is populating its tool data source links, most usages should call WriteConfiguration

Definition at line 498 of file vtkPlusDataSource.cxx.

WriteConfiguration()

PlusStatus vtkPlusDataSource::WriteConfiguration ( vtkXMLDataElement *  toolElement )

virtual

Write main configuration to xml data

Definition at line 437 of file vtkPlusDataSource.cxx.

WriteToSequenceFile()

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

virtual

Dump the current state of the video buffer to metafile

Definition at line 907 of file vtkPlusDataSource.cxx.

Member Data Documentation

Buffer

vtkPlusBuffer* vtkPlusDataSource::Buffer

protected

Definition at line 380 of file vtkPlusDataSource.h.

ClipRectangleOrigin

std::array<int, 3> vtkPlusDataSource::ClipRectangleOrigin

protected

Crop rectangle origin for this data source

Definition at line 385 of file vtkPlusDataSource.h.

ClipRectangleSize

std::array<int, 3> vtkPlusDataSource::ClipRectangleSize

protected

Crop rectangle size for this data source

Definition at line 387 of file vtkPlusDataSource.h.

CustomProperties

CustomPropertyMap vtkPlusDataSource::CustomProperties

protected

Definition at line 382 of file vtkPlusDataSource.h.

DATA_SOURCE_TYPE_FIELDDATA_TAG

std::string vtkPlusDataSource::DATA_SOURCE_TYPE_FIELDDATA_TAG = "FieldData"

static

Definition at line 51 of file vtkPlusDataSource.h.

DATA_SOURCE_TYPE_TOOL_TAG

std::string vtkPlusDataSource::DATA_SOURCE_TYPE_TOOL_TAG = "Tool"

static

Definition at line 49 of file vtkPlusDataSource.h.

DATA_SOURCE_TYPE_VIDEO_TAG

std::string vtkPlusDataSource::DATA_SOURCE_TYPE_VIDEO_TAG = "Video"

static

Definition at line 50 of file vtkPlusDataSource.h.

Device

vtkPlusDevice* vtkPlusDataSource::Device

protected

Definition at line 367 of file vtkPlusDataSource.h.

FrameNumber

unsigned long vtkPlusDataSource::FrameNumber

protected

Definition at line 375 of file vtkPlusDataSource.h.

Id

std::string vtkPlusDataSource::Id

protected

Definition at line 377 of file vtkPlusDataSource.h.

InputFrameSize

FrameSizeType vtkPlusDataSource::InputFrameSize

protected

Definition at line 389 of file vtkPlusDataSource.h.

InputImageOrientation

US_IMAGE_ORIENTATION vtkPlusDataSource::InputImageOrientation

protected

The orientation of the image outputted by the device

Definition at line 371 of file vtkPlusDataSource.h.

PortName

std::string vtkPlusDataSource::PortName

protected

Definition at line 369 of file vtkPlusDataSource.h.

ReferenceCoordinateFrameName

std::string vtkPlusDataSource::ReferenceCoordinateFrameName

protected

Definition at line 378 of file vtkPlusDataSource.h.

Type

DataSourceType vtkPlusDataSource::Type

protected

Definition at line 373 of file vtkPlusDataSource.h.

---

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

• src/PlusDataCollection/vtkPlusDataSource.h
• src/PlusDataCollection/vtkPlusDataSource.cxx