Interface to Clarius Ultrasound Devices This class talks with a Clarius US Scanner over the Clarius OEM API. Requires the PLUS_USE_CLARIUS_OEM option in CMake. More...

#include <src/PlusDataCollection/Clarius/vtkPlusClariusOEM.h>

Inheritance diagram for vtkPlusClariusOEM:

[legend]

Collaboration diagram for vtkPlusClariusOEM:

[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
double	ConvertDepthCmToPercent (double aFocusDepthMm)

double	ConvertDepthPercentToCm (double aFocusDepthPercent)

virtual const char *	GetClassName ()

PlusStatus	GetDepthMm (double &aDepthMm)

PlusStatus	GetDynRangePercent (double &aDynamicRangePercent)

PlusStatus	GetEnableAutoFocus (bool &aEnableAutoFocus)

PlusStatus	GetEnableAutoGain (bool &aEnableAutoGain)

PlusStatus	GetEnablePenetrationMode (bool &aEnablePenetrationMode)

PlusStatus	GetFocusDepthPercent (double &aFocusDepthPercent)

PlusStatus	GetGainPercent (double &aGainPercent)

std::string	GetSdkVersion () override

PlusStatus	GetTimeGainCompensationDb (std::vector< double > &aTGC)

PlusStatus	InternalUpdate () override

virtual int	IsA (const char *type)

bool	IsTracker () const override

bool	IsVirtual () const override

PlusStatus	NotifyConfigured () override

void	PrintSelf (ostream &os, vtkIndent indent) override

PlusStatus	Probe () override

PlusStatus	ReadConfiguration (vtkXMLDataElement *config) override

PlusStatus	SetDepthMm (double aDepthMm)

PlusStatus	SetDynRangePercent (double aDynamicRangePercent)

PlusStatus	SetEnableAutoFocus (bool aEnableAutoFocus)

PlusStatus	SetEnableAutoGain (bool aEnableAutoGain)

PlusStatus	SetEnablePenetrationMode (bool aEnablePenetrationMode)

PlusStatus	SetFocusDepthPercent (double aFocusDepthPercent)

PlusStatus	SetGainPercent (double aGainPercent)

PlusStatus	SetTimeGainCompensationDb (const std::vector< double > &aTGC)

PlusStatus	UpdateFrameSize ()

PlusStatus	UpdateProbeStatus ()

PlusStatus	WriteConfiguration (vtkXMLDataElement *config) override

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 bool	IsConnected () const

virtual bool	IsRecording () const

virtual bool	IsResettable ()

virtual int	OutputChannelCount () const

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual PlusStatus	Reset ()

virtual PlusStatus	SendText (const std::string &textToSend, std::string *textReceived=NULL)

PlusStatus	SetAcquisitionRate (double aRate)

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

virtual void	SetDataCollector (vtkPlusDataCollector *_arg)

virtual void	SetDesiredTimestamp (double)

void	SetDeviceId (const std::string &id)

void	SetFieldDataSourcesBufferSize (int aBufferSize)

virtual PlusStatus	SetImageType (vtkPlusChannel &aChannel, US_IMAGE_TYPE imageType)

virtual PlusStatus	SetInputFrameSize (vtkPlusDataSource &aSource, unsigned int x, unsigned int y, unsigned int z)

virtual void	SetLocalTimeOffsetSec (double aTimeOffsetSec)

virtual void	SetMissingInputGracePeriodSec (double)

virtual PlusStatus	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 vtkPlusClariusOEM *	GetInstance ()

static int	IsTypeOf (const char *type)

static vtkPlusClariusOEM *	New ()

static vtkPlusClariusOEM *	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)

Static Public Attributes
static const std::string	OVERLAY_PORT_NAME = "Overlay"

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"

Protected Member Functions
PlusStatus	ConfigureProbeApplication ()

void	DeInitializeBLE ()

void	DeInitializeOEM ()

void	DeInitializeProbe ()

void	DeInitializeWifi ()

PlusStatus	InitializeBLE ()

PlusStatus	InitializeOEM ()

PlusStatus	InitializeProbe ()

PlusStatus	InitializeWifi ()

PlusStatus	InternalApplyImagingParameterChange () override

PlusStatus	InternalConnect () override

PlusStatus	InternalDisconnect () override

PlusStatus	InternalStartRecording () override

PlusStatus	InternalStopRecording () override

PlusStatus	SetClariusCert ()

PlusStatus	SetInitialUsParams ()

	vtkPlusClariusOEM ()

	~vtkPlusClariusOEM ()

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

Additional Inherited Members
Public Attributes inherited from vtkPlusDevice
double	InternalUpdateRate

vtkIGSIORecursiveCriticalSection *	UpdateMutex

vtkTimeStamp	UpdateTime

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

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

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

Detailed Description

Interface to Clarius Ultrasound Devices This class talks with a Clarius US Scanner over the Clarius OEM API. Requires the PLUS_USE_CLARIUS_OEM option in CMake.

Definition at line 27 of file vtkPlusClariusOEM.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusUsDevice vtkPlusClariusOEM::Superclass

Definition at line 30 of file vtkPlusClariusOEM.h.

Constructor & Destructor Documentation

◆ vtkPlusClariusOEM()

vtkPlusClariusOEM::vtkPlusClariusOEM ( )

protected

Definition at line 817 of file vtkPlusClariusOEM.cxx.

◆ ~vtkPlusClariusOEM()

vtkPlusClariusOEM::~vtkPlusClariusOEM ( )

protected

Definition at line 837 of file vtkPlusClariusOEM.cxx.

Member Function Documentation

◆ ConfigureProbeApplication()

PlusStatus vtkPlusClariusOEM::ConfigureProbeApplication ( )

protected

Connect and Configure the Clarius probe application

Definition at line 1440 of file vtkPlusClariusOEM.cxx.

◆ ConvertDepthCmToPercent()

double vtkPlusClariusOEM::ConvertDepthCmToPercent ( double aFocusDepthMm )

Convert the depth in cm to a percent of the current depth

Definition at line 2337 of file vtkPlusClariusOEM.cxx.

◆ ConvertDepthPercentToCm()

double vtkPlusClariusOEM::ConvertDepthPercentToCm ( double aFocusDepthPercent )

Convert the depth in % of the current depth to cm

Definition at line 2348 of file vtkPlusClariusOEM.cxx.

◆ DeInitializeBLE()

void vtkPlusClariusOEM::DeInitializeBLE ( )

protected

Disconnect from the Clarius probe's BLE network

Definition at line 1819 of file vtkPlusClariusOEM.cxx.

◆ DeInitializeOEM()

void vtkPlusClariusOEM::DeInitializeOEM ( )

protected

Disconnect from Clarius OEM library

Definition at line 1749 of file vtkPlusClariusOEM.cxx.

◆ DeInitializeProbe()

void vtkPlusClariusOEM::DeInitializeProbe ( )

protected

Power off the Clarius probe

Definition at line 1801 of file vtkPlusClariusOEM.cxx.

◆ DeInitializeWifi()

void vtkPlusClariusOEM::DeInitializeWifi ( )

protected

Disconnect from the Clarius probe's Wi-Fi network

Definition at line 1786 of file vtkPlusClariusOEM.cxx.

◆ GetClassName()

virtual const char* vtkPlusClariusOEM::GetClassName ( )

virtual

Reimplemented from vtkPlusUsDevice.

◆ GetDepthMm()

PlusStatus vtkPlusClariusOEM::GetDepthMm ( double & aDepthMm )

Get the imaging depth of B-mode ultrasound (mm)

Definition at line 1980 of file vtkPlusClariusOEM.cxx.

◆ GetDynRangePercent()

PlusStatus vtkPlusClariusOEM::GetDynRangePercent ( double & aDynamicRangePercent )

Get the dynamic range of B-mode ultrasound (%)

Definition at line 2083 of file vtkPlusClariusOEM.cxx.

◆ GetEnableAutoFocus()

PlusStatus vtkPlusClariusOEM::GetEnableAutoFocus ( bool & aEnableAutoFocus )

Get if the auto focus is enabled

Definition at line 2210 of file vtkPlusClariusOEM.cxx.

◆ GetEnableAutoGain()

PlusStatus vtkPlusClariusOEM::GetEnableAutoGain ( bool & aEnableAutoGain )

Get if the auto gain is enabled

Definition at line 2359 of file vtkPlusClariusOEM.cxx.

◆ GetEnablePenetrationMode()

PlusStatus vtkPlusClariusOEM::GetEnablePenetrationMode ( bool & aEnablePenetrationMode )

Get if the penetration mode is enabled

Definition at line 2248 of file vtkPlusClariusOEM.cxx.

◆ GetFocusDepthPercent()

PlusStatus vtkPlusClariusOEM::GetFocusDepthPercent ( double & aFocusDepthPercent )

Get the focus depth of B-mode ultrasound (%)

Definition at line 2278 of file vtkPlusClariusOEM.cxx.

◆ GetGainPercent()

PlusStatus vtkPlusClariusOEM::GetGainPercent ( double & aGainPercent )

Get the gain percentage of B-mode ultrasound (%)

Definition at line 2032 of file vtkPlusClariusOEM.cxx.

◆ GetInstance()

vtkPlusClariusOEM * vtkPlusClariusOEM::GetInstance ( )

static

return the singleton instance with no reference counting

Definition at line 852 of file vtkPlusClariusOEM.cxx.

◆ GetSdkVersion()

std::string vtkPlusClariusOEM::GetSdkVersion ( )

overridevirtual

PLUS device info methods

Reimplemented from vtkPlusDevice.

Definition at line 1151 of file vtkPlusClariusOEM.cxx.

◆ GetTimeGainCompensationDb()

PlusStatus vtkPlusClariusOEM::GetTimeGainCompensationDb ( std::vector< double > & aTGC )

Get the time gain compensation in (%)

Definition at line 2134 of file vtkPlusClariusOEM.cxx.

◆ InitializeBLE()

PlusStatus vtkPlusClariusOEM::InitializeBLE ( )

protected

Connect to the Clarius bluetooth low energy network

Definition at line 1158 of file vtkPlusClariusOEM.cxx.

◆ InitializeOEM()

PlusStatus vtkPlusClariusOEM::InitializeOEM ( )

protected

Setup the Clarius OEM library

Definition at line 1320 of file vtkPlusClariusOEM.cxx.

◆ InitializeProbe()

PlusStatus vtkPlusClariusOEM::InitializeProbe ( )

protected

Power on the probe, and wait for the wifi info to be available

Definition at line 1211 of file vtkPlusClariusOEM.cxx.

◆ InitializeWifi()

PlusStatus vtkPlusClariusOEM::InitializeWifi ( )

protected

Connect to the Clarius probe's access point Wi-Fi network

Definition at line 1296 of file vtkPlusClariusOEM.cxx.

◆ InternalApplyImagingParameterChange()

PlusStatus vtkPlusClariusOEM::InternalApplyImagingParameterChange ( )

overrideprotectedvirtual

Manage changes to the Clarius probe US parameters

Reimplemented from vtkPlusUsDevice.

Definition at line 1908 of file vtkPlusClariusOEM.cxx.

◆ InternalConnect()

PlusStatus vtkPlusClariusOEM::InternalConnect ( )

overrideprotectedvirtual

Overridden PLUS method to manage probe power on, setup, and connection

Reimplemented from vtkPlusDevice.

Definition at line 1612 of file vtkPlusClariusOEM.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusClariusOEM::InternalDisconnect ( )

overrideprotectedvirtual

Overriden PLUS method to manage probe dis-connection, tear down, and power off

Reimplemented from vtkPlusDevice.

Definition at line 1832 of file vtkPlusClariusOEM.cxx.

◆ InternalStartRecording()

PlusStatus vtkPlusClariusOEM::InternalStartRecording ( )

overrideprotectedvirtual

Start acquistion of Clarius US frames

Reimplemented from vtkPlusDevice.

Definition at line 1846 of file vtkPlusClariusOEM.cxx.

◆ InternalStopRecording()

PlusStatus vtkPlusClariusOEM::InternalStopRecording ( )

overrideprotectedvirtual

Stop acquisition of Clarius US frames

Reimplemented from vtkPlusDevice.

Definition at line 1887 of file vtkPlusClariusOEM.cxx.

◆ InternalUpdate()

PlusStatus vtkPlusClariusOEM::InternalUpdate ( )

overridevirtual

The subclass will do all the hardware-specific update stuff in this function. It should call ToolUpdate() for each tool. Note that vtkPlusDevice.cxx starts up a separate thread after InternalStartRecording() is called, and that InternalUpdate() is called repeatedly from within that thread. Therefore, any code within InternalUpdate() must be thread safe. You can temporarily pause the thread by locking this->UpdateMutex->Lock() e.g. if you need to communicate with the device from outside of InternalUpdate(). A call to this->UpdateMutex->Unlock() will resume the thread.

Reimplemented from vtkPlusDevice.

Definition at line 496 of file vtkPlusClariusOEM.cxx.

◆ IsA()

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

virtual

Reimplemented from vtkPlusUsDevice.

◆ IsTracker()

bool vtkPlusClariusOEM::IsTracker ( ) const

inlineoverridevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 40 of file vtkPlusClariusOEM.h.

◆ IsTypeOf()

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

static

◆ IsVirtual()

bool vtkPlusClariusOEM::IsVirtual ( ) const

inlineoverridevirtual

Reimplemented from vtkPlusDevice.

Definition at line 41 of file vtkPlusClariusOEM.h.

◆ New()

vtkPlusClariusOEM * vtkPlusClariusOEM::New ( )

static

Definition at line 807 of file vtkPlusClariusOEM.cxx.

◆ NotifyConfigured()

PlusStatus vtkPlusClariusOEM::NotifyConfigured ( )

overridevirtual

Perform any completion tasks once configured a multi-purpose function which is called after all devices have been configured, all inputs and outputs have been connected between devices, but before devices begin collecting data. This is the last chance for your device to raise an error about improper or insufficient configuration.

Reimplemented from vtkPlusDevice.

Definition at line 1100 of file vtkPlusClariusOEM.cxx.

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkPlusUsDevice.

Definition at line 867 of file vtkPlusClariusOEM.cxx.

◆ Probe()

PlusStatus vtkPlusClariusOEM::Probe ( )

overridevirtual

Probe to see to see if the device is connected to the computer. This method should be overridden in subclasses.

Reimplemented from vtkPlusDevice.

Definition at line 1142 of file vtkPlusClariusOEM.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusClariusOEM::ReadConfiguration ( vtkXMLDataElement * config )

overridevirtual

Read configuration from xml data

Reimplemented from vtkPlusUsDevice.

Definition at line 896 of file vtkPlusClariusOEM.cxx.

◆ SafeDownCast()

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

static

◆ SetClariusCert()

PlusStatus vtkPlusClariusOEM::SetClariusCert ( )

protected

Send certificate file required for probe use

Definition at line 1411 of file vtkPlusClariusOEM.cxx.

◆ SetDepthMm()

PlusStatus vtkPlusClariusOEM::SetDepthMm ( double aDepthMm )

Set the imaging depth of B-mode ultrasound (mm)

Definition at line 2006 of file vtkPlusClariusOEM.cxx.

◆ SetDynRangePercent()

PlusStatus vtkPlusClariusOEM::SetDynRangePercent ( double aDynamicRangePercent )

Set the dynamic range of B-mode ultrasound (%)

Definition at line 2109 of file vtkPlusClariusOEM.cxx.

◆ SetEnableAutoFocus()

PlusStatus vtkPlusClariusOEM::SetEnableAutoFocus ( bool aEnableAutoFocus )

Set the auto focus enabled

Definition at line 2225 of file vtkPlusClariusOEM.cxx.

◆ SetEnableAutoGain()

PlusStatus vtkPlusClariusOEM::SetEnableAutoGain ( bool aEnableAutoGain )

Set the auto gain enabled

Definition at line 2373 of file vtkPlusClariusOEM.cxx.

◆ SetEnablePenetrationMode()

PlusStatus vtkPlusClariusOEM::SetEnablePenetrationMode ( bool aEnablePenetrationMode )

Set the penetration mode enabled

Definition at line 2262 of file vtkPlusClariusOEM.cxx.

◆ SetFocusDepthPercent()

PlusStatus vtkPlusClariusOEM::SetFocusDepthPercent ( double aFocusDepthPercent )

Set the focus depth of B-mode ultrasound (%)

Definition at line 2303 of file vtkPlusClariusOEM.cxx.

◆ SetGainPercent()

PlusStatus vtkPlusClariusOEM::SetGainPercent ( double aGainPercent )

Set the gain percentage of B-mode ultrasound (%)

Definition at line 2058 of file vtkPlusClariusOEM.cxx.

◆ SetInitialUsParams()

PlusStatus vtkPlusClariusOEM::SetInitialUsParams ( )

protected

Initialize Clarius US parameters

Definition at line 1561 of file vtkPlusClariusOEM.cxx.

◆ SetTimeGainCompensationDb()

PlusStatus vtkPlusClariusOEM::SetTimeGainCompensationDb ( const std::vector< double > & aTGC )

Set the time gain compensation (%)

Definition at line 2163 of file vtkPlusClariusOEM.cxx.

◆ UpdateFrameSize()

PlusStatus vtkPlusClariusOEM::UpdateFrameSize ( )

Definition at line 1875 of file vtkPlusClariusOEM.cxx.

◆ UpdateProbeStatus()

PlusStatus vtkPlusClariusOEM::UpdateProbeStatus ( )

Definition at line 506 of file vtkPlusClariusOEM.cxx.

◆ WriteConfiguration()

PlusStatus vtkPlusClariusOEM::WriteConfiguration ( vtkXMLDataElement * config )

overridevirtual

Write configuration to xml data

Reimplemented from vtkPlusUsDevice.

Definition at line 1088 of file vtkPlusClariusOEM.cxx.

Member Data Documentation

◆ OVERLAY_PORT_NAME

const std::string vtkPlusClariusOEM::OVERLAY_PORT_NAME = "Overlay"

static

Definition at line 41 of file vtkPlusClariusOEM.h.

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

src/PlusDataCollection/Clarius/vtkPlusClariusOEM.h
src/PlusDataCollection/Clarius/vtkPlusClariusOEM.cxx

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPlusClariusOEM()

◆ ~vtkPlusClariusOEM()

Member Function Documentation

◆ ConfigureProbeApplication()

◆ ConvertDepthCmToPercent()

◆ ConvertDepthPercentToCm()

◆ DeInitializeBLE()

◆ DeInitializeOEM()

◆ DeInitializeProbe()

◆ DeInitializeWifi()

◆ GetClassName()

◆ GetDepthMm()

◆ GetDynRangePercent()

◆ GetEnableAutoFocus()

◆ GetEnableAutoGain()

◆ GetEnablePenetrationMode()

◆ GetFocusDepthPercent()

◆ GetGainPercent()

◆ GetInstance()

◆ GetSdkVersion()

◆ GetTimeGainCompensationDb()

◆ InitializeBLE()

◆ InitializeOEM()

◆ InitializeProbe()

◆ InitializeWifi()

◆ InternalApplyImagingParameterChange()

◆ InternalConnect()

◆ InternalDisconnect()

◆ InternalStartRecording()

◆ InternalStopRecording()

◆ InternalUpdate()

◆ IsA()

◆ IsTracker()

◆ IsTypeOf()

◆ IsVirtual()

◆ New()

◆ NotifyConfigured()

◆ PrintSelf()

◆ Probe()

◆ ReadConfiguration()

◆ SafeDownCast()

◆ SetClariusCert()

◆ SetDepthMm()

◆ SetDynRangePercent()

◆ SetEnableAutoFocus()

◆ SetEnableAutoGain()

◆ SetEnablePenetrationMode()

◆ SetFocusDepthPercent()

◆ SetGainPercent()

◆ SetInitialUsParams()

◆ SetTimeGainCompensationDb()

◆ UpdateFrameSize()

◆ UpdateProbeStatus()

◆ WriteConfiguration()

Member Data Documentation

◆ OVERLAY_PORT_NAME