Class for providing VTK video input interface from simulated ultrasound. More...

#include <src/PlusDataCollection/UsSimulatorVideo/vtkPlusUsSimulatorVideoSource.h>

Inheritance diagram for vtkPlusUsSimulatorVideoSource:

[legend]

Collaboration diagram for vtkPlusUsSimulatorVideoSource:

[legend]

Public Types
typedef vtkPlusUsDevice	Superclass

Public Types inherited from vtkPlusUsDevice
typedef vtkPlusDevice	Superclass

Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual vtkPlusUsSimulatorAlgo *	GetUsSimulator ()

virtual int	IsA (const char *type)

virtual bool	IsTracker () const

virtual PlusStatus	NotifyConfigured ()

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

virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *config)

Public Member Functions inherited from vtkPlusUsDevice
virtual PlusStatus	AddVideoItemToVideoSource (vtkPlusDataSource &videoSource, const igsioVideoFrame &frame, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)

virtual PlusStatus	AddVideoItemToVideoSource (vtkPlusDataSource &videoSource, 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	AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, const igsioVideoFrame &frame, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL) override

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

virtual std::vector< double >	CalculateAngles ()

virtual std::vector< double >	CalculateBoundingBox ()

virtual std::vector< double >	CalculateDepths ()

virtual double	CalculateLinearWidth ()

virtual std::vector< double >	CalculateOrigin ()

virtual vtkPlusUsImagingParameters *	GetImagingParameters ()

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

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

virtual IGTLIO_PROBE_TYPE	GetProbeType ()

bool	IsKnownKey (const std::string &queryKey) const

virtual PlusStatus	SetNewImagingParameters (const vtkPlusUsImagingParameters &newImagingParameters)

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

	vtkGetStdStringMacro (ImageToTransducerTransformName)

	vtkSetStdStringMacro (ImageToTransducerTransformName)

virtual PlusStatus	WriteConfiguration (vtkXMLDataElement *)

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

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

static vtkPlusUsSimulatorVideoSource *	SafeDownCast (vtkObject *o)

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

static vtkPlusUsDevice *	New ()

static vtkPlusUsDevice *	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
virtual PlusStatus	InternalApplyImagingParameterChange ()

virtual PlusStatus	InternalConnect ()

virtual PlusStatus	InternalDisconnect ()

virtual PlusStatus	InternalUpdate ()

virtual void	SetUsSimulator (vtkPlusUsSimulatorAlgo *)

	vtkPlusUsSimulatorVideoSource ()

virtual	~vtkPlusUsSimulatorVideoSource ()

Protected Member Functions inherited from vtkPlusUsDevice
void	CalculateImageToTransducer (igsioFieldMapType &customFields)

	vtkPlusUsDevice ()

virtual	~vtkPlusUsDevice ()

Protected Member Functions inherited from vtkPlusDevice
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
vtkPlusLogger::LogLevelType	GracePeriodLogLevel

double	LastProcessedTrackingDataTimestamp

vtkPlusUsSimulatorAlgo *	UsSimulator

Protected Attributes inherited from vtkPlusUsDevice
double	CurrentPixelSpacingMm [3]
	Values used in calculation of image to transducer matrix. More...

int	CurrentTransducerOriginPixels [3]
	Values used in calculation of image to transducer matrix. More...

igsioTransformName	ImageToTransducerTransform

std::string	ImageToTransducerTransformName

vtkPlusUsImagingParameters *	ImagingParameters
	Store the current imaging parameters. More...

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 simulated ultrasound.

Definition at line 24 of file vtkPlusUsSimulatorVideoSource.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusUsDevice vtkPlusUsSimulatorVideoSource::Superclass

Definition at line 28 of file vtkPlusUsSimulatorVideoSource.h.

Constructor & Destructor Documentation

◆ vtkPlusUsSimulatorVideoSource()

vtkPlusUsSimulatorVideoSource::vtkPlusUsSimulatorVideoSource ( )

protected

Constructor

Definition at line 22 of file vtkPlusUsSimulatorVideoSource.cxx.

◆ ~vtkPlusUsSimulatorVideoSource()

vtkPlusUsSimulatorVideoSource::~vtkPlusUsSimulatorVideoSource ( )

protectedvirtual

Destructor

Definition at line 42 of file vtkPlusUsSimulatorVideoSource.cxx.

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPlusUsSimulatorVideoSource::GetClassName ( )

virtual

Reimplemented from vtkPlusUsDevice.

◆ GetUsSimulator()

virtual vtkPlusUsSimulatorAlgo* vtkPlusUsSimulatorVideoSource::GetUsSimulator ( )

virtual

Get ultrasound simulator

◆ InternalApplyImagingParameterChange()

PlusStatus vtkPlusUsSimulatorVideoSource::InternalApplyImagingParameterChange ( )

protectedvirtual

Set changed imaging parameter to device

Reimplemented from vtkPlusUsDevice.

Definition at line 268 of file vtkPlusUsSimulatorVideoSource.cxx.

◆ InternalConnect()

PlusStatus vtkPlusUsSimulatorVideoSource::InternalConnect ( )

protectedvirtual

Connect to device

Reimplemented from vtkPlusDevice.

Definition at line 156 of file vtkPlusUsSimulatorVideoSource.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusUsSimulatorVideoSource::InternalDisconnect ( )

protectedvirtual

Disconnect from device

Reimplemented from vtkPlusDevice.

Definition at line 219 of file vtkPlusUsSimulatorVideoSource.cxx.

◆ InternalUpdate()

PlusStatus vtkPlusUsSimulatorVideoSource::InternalUpdate ( )

protectedvirtual

The internal function which actually does the grab.

Reimplemented from vtkPlusDevice.

Definition at line 59 of file vtkPlusUsSimulatorVideoSource.cxx.

◆ IsA()

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

virtual

Reimplemented from vtkPlusUsDevice.

◆ IsTracker()

virtual bool vtkPlusUsSimulatorVideoSource::IsTracker ( ) const

inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 40 of file vtkPlusUsSimulatorVideoSource.h.

◆ IsTypeOf()

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

static

◆ New()

static vtkPlusUsSimulatorVideoSource* vtkPlusUsSimulatorVideoSource::New ( )

static

◆ NotifyConfigured()

PlusStatus vtkPlusUsSimulatorVideoSource::NotifyConfigured ( )

virtual

Verify the device is correctly configured

Reimplemented from vtkPlusDevice.

Definition at line 250 of file vtkPlusUsSimulatorVideoSource.cxx.

◆ PrintSelf()

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

virtual

Reimplemented from vtkPlusUsDevice.

Definition at line 53 of file vtkPlusUsSimulatorVideoSource.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusUsSimulatorVideoSource::ReadConfiguration ( vtkXMLDataElement * config )

virtual

Read configuration from xml data

Reimplemented from vtkPlusUsDevice.

Definition at line 225 of file vtkPlusUsSimulatorVideoSource.cxx.

◆ SafeDownCast()

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

static

◆ SetUsSimulator()

virtual void vtkPlusUsSimulatorVideoSource::SetUsSimulator ( vtkPlusUsSimulatorAlgo * )

protectedvirtual

Set ultrasound simulator

Member Data Documentation

◆ GracePeriodLogLevel

vtkPlusLogger::LogLevelType vtkPlusUsSimulatorVideoSource::GracePeriodLogLevel

protected

Definition at line 72 of file vtkPlusUsSimulatorVideoSource.h.

◆ LastProcessedTrackingDataTimestamp

double vtkPlusUsSimulatorVideoSource::LastProcessedTrackingDataTimestamp

protected

Definition at line 69 of file vtkPlusUsSimulatorVideoSource.h.

◆ UsSimulator

vtkPlusUsSimulatorAlgo* vtkPlusUsSimulatorVideoSource::UsSimulator

protected

Ultrasound simulator

Definition at line 66 of file vtkPlusUsSimulatorVideoSource.h.

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

src/PlusDataCollection/UsSimulatorVideo/vtkPlusUsSimulatorVideoSource.h
src/PlusDataCollection/UsSimulatorVideo/vtkPlusUsSimulatorVideoSource.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPlusUsSimulatorVideoSource()

◆ ~vtkPlusUsSimulatorVideoSource()

Member Function Documentation

◆ GetClassName()

◆ GetUsSimulator()

◆ InternalApplyImagingParameterChange()

◆ InternalConnect()

◆ InternalDisconnect()

◆ InternalUpdate()

◆ IsA()

◆ IsTracker()

◆ IsTypeOf()

◆ New()

◆ NotifyConfigured()

◆ PrintSelf()

◆ ReadConfiguration()

◆ SafeDownCast()

◆ SetUsSimulator()

Member Data Documentation

◆ GracePeriodLogLevel

◆ LastProcessedTrackingDataTimestamp

◆ UsSimulator