VTK interface for video input from Ultrasonix machine. More...

#include <src/PlusDataCollection/SonixVideo/vtkPlusSonixVideoSource.h>

Inheritance diagram for vtkPlusSonixVideoSource:

[legend]

Collaboration diagram for vtkPlusSonixVideoSource:

[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
PlusStatus	GetAcquisitionDataTypeDevice (int &acquisitionDataType)

virtual bool	GetAutoClipEnabled ()

virtual const char *	GetClassName ()

PlusStatus	GetCompressionStatus (int &aCompressionStatus)

virtual int	GetConnectionSetupDelayMs ()

PlusStatus	GetDepthDevice (int &aDepth)

PlusStatus	GetDisplayedFrameRateDevice (int &aFrameRate)

PlusStatus	GetDynRangeDevice (int &aDynRange)

PlusStatus	GetFrequencyDevice (double &aFrequency)

PlusStatus	GetGainDevice (int &aGain)

virtual bool	GetImageGeometryOutputEnabled ()

PlusStatus	GetImagingModeDevice (int &mode)

virtual std::string	GetSdkVersion ()

PlusStatus	GetSectorDevice (int &aSector)

virtual int	GetSharedMemoryStatus ()

virtual char *	GetSonixIP ()

PlusStatus	GetSoundVelocityDevice (float &soundVelocity)

PlusStatus	GetTimeGainCompensationDevice (int tgc[8])

PlusStatus	GetTimeGainCompensationDevice (Plus_uTGC &tgc)

PlusStatus	GetZoomDevice (int &aZoom)

virtual int	IsA (const char *type)

virtual bool	IsTracker () const

virtual PlusStatus	NotifyConfigured ()

PlusStatus	PrintListOfImagingParametersFromDevice ()

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

virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *config)

PlusStatus	SetAcquisitionDataTypeDevice (int aAcquisitionDataType)

virtual void	SetAutoClipEnabled (bool)

PlusStatus	SetCompressionStatus (int aCompressionStatus)

virtual void	SetConnectionSetupDelayMs (int)

PlusStatus	SetDepthDevice (int aDepth)

PlusStatus	SetDynRangeDevice (int aDynRange)

PlusStatus	SetFrameRateLimitDevice (int frLimit)

PlusStatus	SetFrequencyDevice (double aFrequency)

PlusStatus	SetGainDevice (int aGain)

virtual void	SetImageGeometryOutputEnabled (bool)

PlusStatus	SetImagingModeDevice (int mode)

PlusStatus	SetPPFilterDevice (int filterIndex)

PlusStatus	SetRFDecimationDevice (int decimation)

PlusStatus	SetSectorDevice (int aSector)

virtual void	SetSharedMemoryStatus (int)

virtual void	SetSonixIP (const char *)

PlusStatus	SetSoundVelocityDevice (float _arg)

PlusStatus	SetTimeGainCompensationDevice (int tgc[8])

PlusStatus	SetTimeGainCompensationDevice (const Plus_uTGC &tgc)

PlusStatus	SetTimeout (int aTimeout)

PlusStatus	SetZoomDevice (int aZoom)

virtual PlusStatus	WriteConfiguration (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)

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

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

static vtkPlusSonixVideoSource *	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 Types
enum	RfAcquisitionModeType { RF_UNKNOWN = -1, RF_ACQ_B_ONLY = 0, RF_ACQ_RF_ONLY = 1, RF_ACQ_B_AND_RF = 2, RF_ACQ_CHRF_ONLY = 3, RF_ACQ_B_AND_CHRF = 4 }
	Defines RF acquisition mode types (0=B only, 1=RF only, 2=B and RF, 3=ChRF, 4=B and ChRF) More...

Protected Member Functions
PlusStatus	AddFrameToBuffer (void *data, int type, int sz, bool cine, int frmnum)

PlusStatus	ConfigureVideoSource (uData aValue)

std::string	GetLastUlteriusError ()

PlusStatus	GetParamValueDevice (char *paramId, int &paramValue, int &validatedParamValue)

PlusStatus	GetParamValueDevice (char *paramId, Plus_uTGC &paramValue, Plus_uTGC &validatedParamValue)

virtual PlusStatus	GetRequestedImagingDataTypeFromSources (int &requestedImagingDataType)

PlusStatus	GetRfAcquisitionModeDevice (RfAcquisitionModeType &mode)

bool	HasDataType (uData aValue)

virtual PlusStatus	InternalApplyImagingParameterChange ()

virtual PlusStatus	InternalConnect ()

virtual PlusStatus	InternalDisconnect ()

virtual PlusStatus	InternalStartRecording ()

virtual PlusStatus	InternalStopRecording ()

PlusStatus	SetParamValueDevice (char *paramId, int paramValue, int &validatedParamValue)

PlusStatus	SetParamValueDevice (char *paramId, Plus_uTGC &paramValue, Plus_uTGC &validatedParamValue)

PlusStatus	SetRfAcquisitionModeDevice (RfAcquisitionModeType mode)

void	UpdateImagingParametersFromDevice ()

	vtkPlusSonixVideoSource ()

bool	WantDataType (uData aValue)

virtual	~vtkPlusSonixVideoSource ()

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 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	AcquisitionDataType

bool	AutoClipEnabled

std::map< std::string, bool >	ChangedImagingParameters

int	CompressionStatus

int	ConnectionSetupDelayMs

bool	ImageGeometryChanged

bool	ImageGeometryOutputEnabled

int	ImagingMode

bool	ImagingParameterChanged

int	OutputFormat

RfAcquisitionModeType	RfAcquisitionMode

int	SharedMemoryStatus

char *	SonixIP

int	Timeout

ulterius *	Ult

bool	UlteriusConnected

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

VTK interface for video input from Ultrasonix machine.

vtkPlusSonixVideoSource is a class for providing video input interfaces between VTK and Ultrasonix machine. The goal is to provide the ability to be able to do acquisition in various imaging modes, buffer the image/volume series being acquired and stream the frames to output. Note that the data coming out of the SonixRP through ulterius is always RGB This class talks to Ultrasonix's Ulterius SDK for executing the tasks Parameter setting doesn't work with Ulterius-2.x

Usage: sonixGrabber->SetSonixIP("130.15.7.212"); sonixGrabber->SetImagingMode(0); sonixGrabber->SetAcquisitionDataType(udtBPost); sonixGrabber->Record(); imageviewer->SetInputData(sonixGrabber->GetOutput()); See vtkPlusSonixVideoSourceTest1.cxx for more details

Definition at line 50 of file vtkPlusSonixVideoSource.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusUsDevice vtkPlusSonixVideoSource::Superclass

Definition at line 68 of file vtkPlusSonixVideoSource.h.

Member Enumeration Documentation

◆ RfAcquisitionModeType

enum vtkPlusSonixVideoSource::RfAcquisitionModeType

protected

Defines RF acquisition mode types (0=B only, 1=RF only, 2=B and RF, 3=ChRF, 4=B and ChRF)

Enumerator
RF_UNKNOWN
RF_ACQ_B_ONLY
RF_ACQ_RF_ONLY
RF_ACQ_B_AND_RF
RF_ACQ_CHRF_ONLY
RF_ACQ_B_AND_CHRF

Definition at line 268 of file vtkPlusSonixVideoSource.h.

Constructor & Destructor Documentation

◆ vtkPlusSonixVideoSource()

vtkPlusSonixVideoSource::vtkPlusSonixVideoSource ( )

protected

Definition at line 73 of file vtkPlusSonixVideoSource.cxx.

◆ ~vtkPlusSonixVideoSource()

vtkPlusSonixVideoSource::~vtkPlusSonixVideoSource ( )

protectedvirtual

Definition at line 106 of file vtkPlusSonixVideoSource.cxx.

Member Function Documentation

◆ AddFrameToBuffer()

PlusStatus vtkPlusSonixVideoSource::AddFrameToBuffer	(	void *	data,
		int	type,
		int	sz,
		bool	cine,
		int	frmnum
	)

protected

For internal use only

Definition at line 253 of file vtkPlusSonixVideoSource.cxx.

◆ ConfigureVideoSource()

PlusStatus vtkPlusSonixVideoSource::ConfigureVideoSource ( uData aValue )

protected

Definition at line 1394 of file vtkPlusSonixVideoSource.cxx.

◆ GetAcquisitionDataTypeDevice()

PlusStatus vtkPlusSonixVideoSource::GetAcquisitionDataTypeDevice ( int & acquisitionDataType )

Get acquisition data type bitmask.

Definition at line 1177 of file vtkPlusSonixVideoSource.cxx.

◆ GetAutoClipEnabled()

virtual bool vtkPlusSonixVideoSource::GetAutoClipEnabled ( )

virtual

◆ GetClassName()

virtual const char* vtkPlusSonixVideoSource::GetClassName ( )

virtual

Reimplemented from vtkPlusUsDevice.

◆ GetCompressionStatus()

PlusStatus vtkPlusSonixVideoSource::GetCompressionStatus ( int & aCompressionStatus )

Get the CompressionStatus to 0 for compression off, 1 for compression on.

Definition at line 1120 of file vtkPlusSonixVideoSource.cxx.

◆ GetConnectionSetupDelayMs()

virtual int vtkPlusSonixVideoSource::GetConnectionSetupDelayMs ( )

virtual

Set the time required for setting up the connection.

◆ GetDepthDevice()

PlusStatus vtkPlusSonixVideoSource::GetDepthDevice ( int & aDepth )

Get the depth (mm) of B-mode ultrasound

Definition at line 887 of file vtkPlusSonixVideoSource.cxx.

◆ GetDisplayedFrameRateDevice()

PlusStatus vtkPlusSonixVideoSource::GetDisplayedFrameRateDevice ( int & aFrameRate )

Get the displayed frame rate.

Definition at line 1241 of file vtkPlusSonixVideoSource.cxx.

◆ GetDynRangeDevice()

PlusStatus vtkPlusSonixVideoSource::GetDynRangeDevice ( int & aDynRange )

Get the DynRange (dB) of B-mode ultrasound

Definition at line 943 of file vtkPlusSonixVideoSource.cxx.

◆ GetFrequencyDevice()

PlusStatus vtkPlusSonixVideoSource::GetFrequencyDevice ( double & aFrequency )

Get ultrasound transmitter frequency (MHz)

Definition at line 860 of file vtkPlusSonixVideoSource.cxx.

◆ GetGainDevice()

PlusStatus vtkPlusSonixVideoSource::GetGainDevice ( int & aGain )

Get the Gain (%) of B-mode ultrasound; valid range: 0-100

Definition at line 915 of file vtkPlusSonixVideoSource.cxx.

◆ GetImageGeometryOutputEnabled()

virtual bool vtkPlusSonixVideoSource::GetImageGeometryOutputEnabled ( )

virtual

◆ GetImagingModeDevice()

PlusStatus vtkPlusSonixVideoSource::GetImagingModeDevice ( int & mode )

Get current imaging mode

Definition at line 1209 of file vtkPlusSonixVideoSource.cxx.

◆ GetLastUlteriusError()

std::string vtkPlusSonixVideoSource::GetLastUlteriusError ( )

protected

Get the last error string returned by Ulterius

Definition at line 755 of file vtkPlusSonixVideoSource.cxx.

◆ GetParamValueDevice() [1/2]

PlusStatus vtkPlusSonixVideoSource::GetParamValueDevice	(	char *	paramId,
		int &	paramValue,
		int &	validatedParamValue
	)

protected

Definition at line 805 of file vtkPlusSonixVideoSource.cxx.

◆ GetParamValueDevice() [2/2]

PlusStatus vtkPlusSonixVideoSource::GetParamValueDevice	(	char *	paramId,
		Plus_uTGC &	paramValue,
		Plus_uTGC &	validatedParamValue
	)

protected

Definition at line 824 of file vtkPlusSonixVideoSource.cxx.

◆ GetRequestedImagingDataTypeFromSources()

PlusStatus vtkPlusSonixVideoSource::GetRequestedImagingDataTypeFromSources ( int & requestedImagingDataType )

protectedvirtual

Determine all necessary imaging data types from the DataSource elements with Type="Video". Returns a combination of vtkPlusUsImagingParameters::DataType enum flags.

Definition at line 1482 of file vtkPlusSonixVideoSource.cxx.

◆ GetRfAcquisitionModeDevice()

PlusStatus vtkPlusSonixVideoSource::GetRfAcquisitionModeDevice ( RfAcquisitionModeType & mode )

protected

Get current RF acquire mode

Definition at line 1323 of file vtkPlusSonixVideoSource.cxx.

◆ GetSdkVersion()

std::string vtkPlusSonixVideoSource::GetSdkVersion ( )

virtual

Hardware device SDK version.

Reimplemented from vtkPlusDevice.

Definition at line 116 of file vtkPlusSonixVideoSource.cxx.

◆ GetSectorDevice()

PlusStatus vtkPlusSonixVideoSource::GetSectorDevice ( int & aSector )

Get the Sector (%) of B-mode ultrasound; valid range: 0-100

Definition at line 991 of file vtkPlusSonixVideoSource.cxx.

◆ GetSharedMemoryStatus()

virtual int vtkPlusSonixVideoSource::GetSharedMemoryStatus ( )

virtual

Get the SharedMemoryStatus.

◆ GetSonixIP()

virtual char* vtkPlusSonixVideoSource::GetSonixIP ( )

virtual

Set the IP address of the Ultrasonix host machine

◆ GetSoundVelocityDevice()

PlusStatus vtkPlusSonixVideoSource::GetSoundVelocityDevice ( float & soundVelocity )

Get the sound velocity (m/s) from the device

Definition at line 1087 of file vtkPlusSonixVideoSource.cxx.

◆ GetTimeGainCompensationDevice() [1/2]

PlusStatus vtkPlusSonixVideoSource::GetTimeGainCompensationDevice ( int tgc[8] )

Get the TGC (8 ints) of B-mode ultrasound;

Definition at line 1042 of file vtkPlusSonixVideoSource.cxx.

◆ GetTimeGainCompensationDevice() [2/2]

PlusStatus vtkPlusSonixVideoSource::GetTimeGainCompensationDevice ( Plus_uTGC & tgc )

Get the TGC (8 ints) of B-mode ultrasound;

Definition at line 1059 of file vtkPlusSonixVideoSource.cxx.

◆ GetZoomDevice()

PlusStatus vtkPlusSonixVideoSource::GetZoomDevice ( int & aZoom )

Get the Zoom (%) of B-mode ultrasound; valid range: 0-100

Definition at line 967 of file vtkPlusSonixVideoSource.cxx.

◆ HasDataType()

bool vtkPlusSonixVideoSource::HasDataType ( uData aValue )

protected

Definition at line 1380 of file vtkPlusSonixVideoSource.cxx.

◆ InternalApplyImagingParameterChange()

PlusStatus vtkPlusSonixVideoSource::InternalApplyImagingParameterChange ( )

protectedvirtual

Set changed imaging parameter to device

Reimplemented from vtkPlusUsDevice.

Definition at line 1564 of file vtkPlusSonixVideoSource.cxx.

◆ InternalConnect()

PlusStatus vtkPlusSonixVideoSource::InternalConnect ( )

protectedvirtual

Connect to device

Reimplemented from vtkPlusDevice.

Definition at line 400 of file vtkPlusSonixVideoSource.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusSonixVideoSource::InternalDisconnect ( )

protectedvirtual

Disconnect from device

Reimplemented from vtkPlusDevice.

Definition at line 619 of file vtkPlusSonixVideoSource.cxx.

◆ InternalStartRecording()

PlusStatus vtkPlusSonixVideoSource::InternalStartRecording ( )

protectedvirtual

Record incoming video. The recording continues indefinitely until StopRecording() is called.

Reimplemented from vtkPlusDevice.

Definition at line 629 of file vtkPlusSonixVideoSource.cxx.

◆ InternalStopRecording()

PlusStatus vtkPlusSonixVideoSource::InternalStopRecording ( )

protectedvirtual

Stop recording or playing

Reimplemented from vtkPlusDevice.

Definition at line 641 of file vtkPlusSonixVideoSource.cxx.

◆ IsA()

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

virtual

Reimplemented from vtkPlusUsDevice.

◆ IsTracker()

virtual bool vtkPlusSonixVideoSource::IsTracker ( ) const

inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 233 of file vtkPlusSonixVideoSource.h.

◆ IsTypeOf()

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

static

◆ New()

static vtkPlusSonixVideoSource* vtkPlusSonixVideoSource::New ( )

static

◆ NotifyConfigured()

PlusStatus vtkPlusSonixVideoSource::NotifyConfigured ( )

virtual

Verify the device is correctly configured

Reimplemented from vtkPlusDevice.

Definition at line 1362 of file vtkPlusSonixVideoSource.cxx.

◆ PrintListOfImagingParametersFromDevice()

PlusStatus vtkPlusSonixVideoSource::PrintListOfImagingParametersFromDevice ( )

Print the list of supported parameters. For diagnostic purposes only.

Definition at line 1223 of file vtkPlusSonixVideoSource.cxx.

◆ PrintSelf()

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

virtual

Reimplemented from vtkPlusUsDevice.

Definition at line 124 of file vtkPlusSonixVideoSource.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusSonixVideoSource::ReadConfiguration ( vtkXMLDataElement * config )

virtual

Read main configuration from/to xml data

Reimplemented from vtkPlusUsDevice.

Definition at line 653 of file vtkPlusSonixVideoSource.cxx.

◆ SafeDownCast()

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

static

◆ SetAcquisitionDataTypeDevice()

PlusStatus vtkPlusSonixVideoSource::SetAcquisitionDataTypeDevice ( int aAcquisitionDataType )

Request a particular data type from sonix machine by means of a bitmask. The mask must be applied before any data can be acquired via realtime imaging or cine retrieval

udtScreen = 0x00000001, // Screen udtBPre = 0x00000002, // B Pre Scan Converted udtBPost = 0x00000004, // B Post Scan Converted (8 bit) udtBPost32 = 0x00000008, // B Post Scan Converted (32 bit) udtRF = 0x00000010, // RF udtMPre = 0x00000020, // M Pre Scan Converted udtMPost = 0x00000040, // M Post Scan Converted udtPWRF = 0x00000080, // PW RF udtPWSpectrum = 0x00000100, udtColorRF = 0x00000200, udtColorCombined = 0x00000400, udtColorVelocityVariance = 0x00000800, udtElastoCombined = 0x00002000, // Elasto + B-image (32 bit) udtElastoOverlay = 0x00004000, // Elasto Overlay (8 bit) udtElastoPre = 0x00008000, // Elasto Pre Scan Coverted (8 bit) udtECG = 0x00010000, udtGPS = 0x00020000, udtPNG = 0x10000000

Definition at line 1153 of file vtkPlusSonixVideoSource.cxx.

◆ SetAutoClipEnabled()

virtual void vtkPlusSonixVideoSource::SetAutoClipEnabled ( bool )

virtual

Set clip rectangle origin and size according to the ROI provided by the ultrasound system

◆ SetCompressionStatus()

PlusStatus vtkPlusSonixVideoSource::SetCompressionStatus ( int aCompressionStatus )

Set the CompressionStatus to 0 for compression off, 1 for compression on. (Default: off)

Definition at line 1101 of file vtkPlusSonixVideoSource.cxx.

◆ SetConnectionSetupDelayMs()

virtual void vtkPlusSonixVideoSource::SetConnectionSetupDelayMs ( int )

virtual

Set the time required for setting up the connection. The value depends on the probe type, typical values are between 2000-3000ms. (Default: 3000)

◆ SetDepthDevice()

PlusStatus vtkPlusSonixVideoSource::SetDepthDevice ( int aDepth )

Set the depth (mm) of B-mode ultrasound

Definition at line 875 of file vtkPlusSonixVideoSource.cxx.

◆ SetDynRangeDevice()

PlusStatus vtkPlusSonixVideoSource::SetDynRangeDevice ( int aDynRange )

Set the DynRange (dB) of B-mode ultrasound

Definition at line 931 of file vtkPlusSonixVideoSource.cxx.

◆ SetFrameRateLimitDevice()

PlusStatus vtkPlusSonixVideoSource::SetFrameRateLimitDevice ( int frLimit )

Set maximum frame rate limit on exam software (frLimit=403 means 40.3Hz). This requires Ulterius be connected.

Definition at line 1290 of file vtkPlusSonixVideoSource.cxx.

◆ SetFrequencyDevice()

PlusStatus vtkPlusSonixVideoSource::SetFrequencyDevice ( double aFrequency )

Set ultrasound transmitter frequency (MHz)

Definition at line 845 of file vtkPlusSonixVideoSource.cxx.

◆ SetGainDevice()

PlusStatus vtkPlusSonixVideoSource::SetGainDevice ( int aGain )

Set the Gain (%) of B-mode ultrasound; valid range: 0-100

Definition at line 899 of file vtkPlusSonixVideoSource.cxx.

◆ SetImageGeometryOutputEnabled()

virtual void vtkPlusSonixVideoSource::SetImageGeometryOutputEnabled ( bool )

virtual

Add image geometry (depth, spacing, transducer origin) to the output

◆ SetImagingModeDevice()

PlusStatus vtkPlusSonixVideoSource::SetImagingModeDevice ( int mode )

Request a particular mode of imaging Usable values are described in ImagingModes.h (default: B-mode) BMode = 0, MMode = 1, ColourMode = 2, PwMode = 3, TriplexMode = 4, PanoMode = 5, DualMode = 6, QuadMode = 7, CompoundMode = 8, DualColourMode = 9, DualCompoundMode = 10, CwMode = 11, RfMode = 12, ColorSplitMode = 13, F4DMode = 14, TriplexCwMode = 15, ColourMMode = 16, ElastoMode = 17, SDUVMode = 18, AnatomicalMMode = 19, ElastoComparativeMode = 20, FusionMode = 21, VecDopMode = 22, BiplaneMode = 23, ClinicalRfMode = 24, RfCompoundMode = 25, SHINEMode = 26, ColourRfMode = 27,

Definition at line 1191 of file vtkPlusSonixVideoSource.cxx.

◆ SetParamValueDevice() [1/2]

PlusStatus vtkPlusSonixVideoSource::SetParamValueDevice	(	char *	paramId,
		int	paramValue,
		int &	validatedParamValue
	)

protected

Definition at line 766 of file vtkPlusSonixVideoSource.cxx.

◆ SetParamValueDevice() [2/2]

PlusStatus vtkPlusSonixVideoSource::SetParamValueDevice	(	char *	paramId,
		Plus_uTGC &	paramValue,
		Plus_uTGC &	validatedParamValue
	)

protected

Definition at line 784 of file vtkPlusSonixVideoSource.cxx.

◆ SetPPFilterDevice()

PlusStatus vtkPlusSonixVideoSource::SetPPFilterDevice ( int filterIndex )

Set speckle reduction filter (filterIndex: 0=off,1,2). This requires Ulterius be connected.

Definition at line 1274 of file vtkPlusSonixVideoSource.cxx.

◆ SetRfAcquisitionModeDevice()

PlusStatus vtkPlusSonixVideoSource::SetRfAcquisitionModeDevice ( RfAcquisitionModeType mode )

protected

Set RF acquire mode. Determined from the video data sources.

Definition at line 1306 of file vtkPlusSonixVideoSource.cxx.

◆ SetRFDecimationDevice()

PlusStatus vtkPlusSonixVideoSource::SetRFDecimationDevice ( int decimation )

Set RF decimation. This requires Ulterius be connected.

Definition at line 1258 of file vtkPlusSonixVideoSource.cxx.

◆ SetSectorDevice()

PlusStatus vtkPlusSonixVideoSource::SetSectorDevice ( int aSector )

Set the Sector (%) of B-mode ultrasound; valid range: 0-100

Definition at line 979 of file vtkPlusSonixVideoSource.cxx.

◆ SetSharedMemoryStatus()

virtual void vtkPlusSonixVideoSource::SetSharedMemoryStatus ( int )

virtual

Set the SharedMemoryStatus(1) to bypass TCP on local access.

◆ SetSonixIP()

virtual void vtkPlusSonixVideoSource::SetSonixIP ( const char * )

virtual

Get the IP address of the Ultrasonix host machine

◆ SetSoundVelocityDevice()

PlusStatus vtkPlusSonixVideoSource::SetSoundVelocityDevice ( float _arg )

Set the sound velocity (m/s) from the device

Definition at line 1074 of file vtkPlusSonixVideoSource.cxx.

◆ SetTimeGainCompensationDevice() [1/2]

PlusStatus vtkPlusSonixVideoSource::SetTimeGainCompensationDevice ( int tgc[8] )

Set the TGC (8 ints) of B-mode ultrasound;

Definition at line 1003 of file vtkPlusSonixVideoSource.cxx.

◆ SetTimeGainCompensationDevice() [2/2]

PlusStatus vtkPlusSonixVideoSource::SetTimeGainCompensationDevice ( const Plus_uTGC & tgc )

Set the TGC (8 ints) of B-mode ultrasound;

Definition at line 1027 of file vtkPlusSonixVideoSource.cxx.

◆ SetTimeout()

PlusStatus vtkPlusSonixVideoSource::SetTimeout ( int aTimeout )

Set the Timeout (ms) value for network function calls.

Definition at line 1134 of file vtkPlusSonixVideoSource.cxx.

◆ SetZoomDevice()

PlusStatus vtkPlusSonixVideoSource::SetZoomDevice ( int aZoom )

Set the Zoom (%) of B-mode ultrasound; valid range: 0-100

Definition at line 955 of file vtkPlusSonixVideoSource.cxx.

◆ UpdateImagingParametersFromDevice()

void vtkPlusSonixVideoSource::UpdateImagingParametersFromDevice ( )

protected

Update changed imaging parameters from device

Definition at line 194 of file vtkPlusSonixVideoSource.cxx.

◆ WantDataType()

bool vtkPlusSonixVideoSource::WantDataType ( uData aValue )

protected

Definition at line 1388 of file vtkPlusSonixVideoSource.cxx.

◆ WriteConfiguration()

PlusStatus vtkPlusSonixVideoSource::WriteConfiguration ( vtkXMLDataElement * config )

virtual

Write main configuration from/to xml data

Reimplemented from vtkPlusUsDevice.

Definition at line 722 of file vtkPlusSonixVideoSource.cxx.

Member Data Documentation

◆ AcquisitionDataType

int vtkPlusSonixVideoSource::AcquisitionDataType

protected

Definition at line 311 of file vtkPlusSonixVideoSource.h.

◆ AutoClipEnabled

bool vtkPlusSonixVideoSource::AutoClipEnabled

protected

Definition at line 333 of file vtkPlusSonixVideoSource.h.

◆ ChangedImagingParameters

std::map<std::string, bool> vtkPlusSonixVideoSource::ChangedImagingParameters

protected

Definition at line 323 of file vtkPlusSonixVideoSource.h.

◆ CompressionStatus

int vtkPlusSonixVideoSource::CompressionStatus

protected

Definition at line 314 of file vtkPlusSonixVideoSource.h.

◆ ConnectionSetupDelayMs

int vtkPlusSonixVideoSource::ConnectionSetupDelayMs

protected

Definition at line 316 of file vtkPlusSonixVideoSource.h.

◆ ImageGeometryChanged

bool vtkPlusSonixVideoSource::ImageGeometryChanged

protected

Indicates that current depth, spacing, transducer origin has to be queried

Definition at line 321 of file vtkPlusSonixVideoSource.h.

◆ ImageGeometryOutputEnabled

bool vtkPlusSonixVideoSource::ImageGeometryOutputEnabled

protected

Definition at line 334 of file vtkPlusSonixVideoSource.h.

◆ ImagingMode

int vtkPlusSonixVideoSource::ImagingMode

protected

Definition at line 312 of file vtkPlusSonixVideoSource.h.

◆ ImagingParameterChanged

bool vtkPlusSonixVideoSource::ImagingParameterChanged

protected

Definition at line 322 of file vtkPlusSonixVideoSource.h.

◆ OutputFormat

int vtkPlusSonixVideoSource::OutputFormat

protected

Definition at line 313 of file vtkPlusSonixVideoSource.h.

◆ RfAcquisitionMode

RfAcquisitionModeType vtkPlusSonixVideoSource::RfAcquisitionMode

protected

Definition at line 318 of file vtkPlusSonixVideoSource.h.

◆ SharedMemoryStatus

int vtkPlusSonixVideoSource::SharedMemoryStatus

protected

Definition at line 317 of file vtkPlusSonixVideoSource.h.

◆ SonixIP

char* vtkPlusSonixVideoSource::SonixIP

protected

Definition at line 325 of file vtkPlusSonixVideoSource.h.

◆ Timeout

int vtkPlusSonixVideoSource::Timeout

protected

Definition at line 315 of file vtkPlusSonixVideoSource.h.

◆ Ult

ulterius* vtkPlusSonixVideoSource::Ult

protected

Definition at line 310 of file vtkPlusSonixVideoSource.h.

◆ UlteriusConnected

bool vtkPlusSonixVideoSource::UlteriusConnected

protected

Indicates if connection to the device has been established. It's not the same as the Connected parameter, because Connected indicates that the connection is successfully completed; while UlteriusConnected indicates that the connection to Ulterius has been established (so that Ulterius calls are allowed), but the connection initialization (setup of requested imaging parameters, etc.) may fail.

Definition at line 332 of file vtkPlusSonixVideoSource.h.

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

src/PlusDataCollection/SonixVideo/vtkPlusSonixVideoSource.h
src/PlusDataCollection/SonixVideo/vtkPlusSonixVideoSource.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

◆ RfAcquisitionModeType

Constructor & Destructor Documentation

◆ vtkPlusSonixVideoSource()

◆ ~vtkPlusSonixVideoSource()

Member Function Documentation

◆ AddFrameToBuffer()

◆ ConfigureVideoSource()

◆ GetAcquisitionDataTypeDevice()

◆ GetAutoClipEnabled()

◆ GetClassName()

◆ GetCompressionStatus()

◆ GetConnectionSetupDelayMs()

◆ GetDepthDevice()

◆ GetDisplayedFrameRateDevice()

◆ GetDynRangeDevice()

◆ GetFrequencyDevice()

◆ GetGainDevice()

◆ GetImageGeometryOutputEnabled()

◆ GetImagingModeDevice()

◆ GetLastUlteriusError()

◆ GetParamValueDevice() [1/2]

◆ GetParamValueDevice() [2/2]

◆ GetRequestedImagingDataTypeFromSources()

◆ GetRfAcquisitionModeDevice()

◆ GetSdkVersion()

◆ GetSectorDevice()

◆ GetSharedMemoryStatus()

◆ GetSonixIP()

◆ GetSoundVelocityDevice()

◆ GetTimeGainCompensationDevice() [1/2]

◆ GetTimeGainCompensationDevice() [2/2]

◆ GetZoomDevice()

◆ HasDataType()

◆ InternalApplyImagingParameterChange()

◆ InternalConnect()

◆ InternalDisconnect()

◆ InternalStartRecording()

◆ InternalStopRecording()

◆ IsA()

◆ IsTracker()

◆ IsTypeOf()

◆ New()

◆ NotifyConfigured()

◆ PrintListOfImagingParametersFromDevice()

◆ PrintSelf()

◆ ReadConfiguration()

◆ SafeDownCast()

◆ SetAcquisitionDataTypeDevice()

◆ SetAutoClipEnabled()

◆ SetCompressionStatus()

◆ SetConnectionSetupDelayMs()

◆ SetDepthDevice()

◆ SetDynRangeDevice()

◆ SetFrameRateLimitDevice()

◆ SetFrequencyDevice()

◆ SetGainDevice()

◆ SetImageGeometryOutputEnabled()

◆ SetImagingModeDevice()

◆ SetParamValueDevice() [1/2]

◆ SetParamValueDevice() [2/2]

◆ SetPPFilterDevice()

◆ SetRfAcquisitionModeDevice()

◆ SetRFDecimationDevice()

◆ SetSectorDevice()

◆ SetSharedMemoryStatus()

◆ SetSonixIP()

◆ SetSoundVelocityDevice()

◆ SetTimeGainCompensationDevice() [1/2]

◆ SetTimeGainCompensationDevice() [2/2]