PlusLib  2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
vtkPlusClarius Class Reference
DataCollection

Interface to the Clarius ultrasound scans This class talks with a Clarius Scanner over the Clarius API. Requires PLUS_USE_CLARIUS option in CMake. More...

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

Inheritance diagram for vtkPlusClarius:
Inheritance graph
[legend]
Collaboration diagram for vtkPlusClarius:
Collaboration graph
[legend]

Public Types

enum  AHRS_METHOD { AHRS_MADGWICK, AHRS_MAHONY }
 
typedef vtkPlusDevice Superclass
 
- Public Types inherited from vtkPlusUsDevice
typedef vtkPlusDevice Superclass
 
- Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual void CompressRawDataOff ()
 
virtual void CompressRawDataOn ()
 
virtual double * GetAhrsAlgorithmGain ()
 
virtual void GetAhrsAlgorithmGain (double &, double &)
 
virtual void GetAhrsAlgorithmGain (double [2])
 
virtual const char * GetClassName ()
 
virtual bool GetCompressRawData ()
 
virtual double * GetFilteredTiltSensorAhrsAlgorithmGain ()
 
virtual void GetFilteredTiltSensorAhrsAlgorithmGain (double &, double &)
 
virtual void GetFilteredTiltSensorAhrsAlgorithmGain (double [2])
 
virtual unsigned int GetFrameHeight ()
 
virtual unsigned int GetFrameWidth ()
 
virtual bool GetImuEnabled ()
 
virtual std::string GetImuOutputFileName ()
 
virtual std::string GetIpAddress ()
 
virtual std::string GetSdkVersion ()
 
virtual unsigned int GetTcpPort ()
 
virtual bool GetWriteImagesToDisk ()
 
virtual int IsA (const char *type)
 
bool IsTracker () const
 
virtual PlusStatus NotifyConfigured ()
 
void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
virtual PlusStatus Probe ()
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *config)
 
PlusStatus RequestLastNSecondsRawData (double lastNSeconds)
 
PlusStatus RequestRawData (long long startTimestampNanoSeconds, long long endTimestampNanoSeconds)
 
virtual void SetAhrsAlgorithmGain (double, double)
 
void SetAhrsAlgorithmGain (double [2])
 
virtual void SetCompressRawData (bool)
 
virtual void SetFilteredTiltSensorAhrsAlgorithmGain (double, double)
 
void SetFilteredTiltSensorAhrsAlgorithmGain (double [2])
 
virtual void SetFrameHeight (unsigned int)
 
virtual void SetFrameWidth (unsigned int)
 
virtual void SetImuEnabled (bool)
 
virtual void SetImuOutputFileName (std::string)
 
virtual void SetIpAddress (std::string)
 
virtual void SetTcpPort (unsigned int)
 
virtual void SetWriteImagesToDisk (bool)
 
 vtkGetStdStringMacro (RawDataOutputFilename)
 
 vtkSetStdStringMacro (RawDataOutputFilename)
 
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 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 vtkPlusClarius * GetInstance ()
 
static int IsTypeOf (const char *type)
 
static vtkPlusClarius * New ()
 
static vtkPlusClarius * 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 InternalConnect ()
 
virtual PlusStatus InternalDisconnect ()
 
 vtkPlusClarius ()
 
 ~vtkPlusClarius ()
 
- Protected Member Functions inherited from vtkPlusUsDevice
void CalculateImageToTransducer (igsioFieldMapType &customFields)
 
virtual PlusStatus InternalApplyImagingParameterChange ()
 
 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

double AhrsAlgorithmGain [2]
 
bool CompressRawData
 
double FilteredTiltSensorAhrsAlgorithmGain [2]
 
int FilteredTiltSensorWestAxisIndex
 
int FrameHeight
 
int FrameWidth
 
bool ImuEnabled
 
std::string ImuOutputFileName
 
vtkInternal * Internal
 
std::string IpAddress
 
std::string RawDataOutputFilename
 
unsigned int TcpPort
 
int TiltSensorWestAxisIndex
 
bool WriteImagesToDisk
 
- 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

static vtkPlusClarius * Instance
 
- Static Protected Attributes inherited from vtkPlusDevice
static const int VIRTUAL_DEVICE_FRAME_RATE = 50
 

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)
 

Detailed Description

Interface to the Clarius ultrasound scans This class talks with a Clarius Scanner over the Clarius API. Requires PLUS_USE_CLARIUS option in CMake.

Definition at line 23 of file vtkPlusClarius.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusDevice vtkPlusClarius::Superclass

Definition at line 27 of file vtkPlusClarius.h.

Member Enumeration Documentation

◆ AHRS_METHOD

enum vtkPlusClarius::AHRS_METHOD
Enumerator
AHRS_MADGWICK 
AHRS_MAHONY 

Definition at line 117 of file vtkPlusClarius.h.

Constructor & Destructor Documentation

◆ vtkPlusClarius()

vtkPlusClarius::vtkPlusClarius ( )
protected

Definition at line 828 of file vtkPlusClarius.cxx.

◆ ~vtkPlusClarius()

vtkPlusClarius::~vtkPlusClarius ( )
protected

Definition at line 849 of file vtkPlusClarius.cxx.

Member Function Documentation

◆ CompressRawDataOff()

virtual void vtkPlusClarius::CompressRawDataOff ( )
virtual

◆ CompressRawDataOn()

virtual void vtkPlusClarius::CompressRawDataOn ( )
virtual

◆ GetAhrsAlgorithmGain() [1/3]

virtual double* vtkPlusClarius::GetAhrsAlgorithmGain ( )
virtual

◆ GetAhrsAlgorithmGain() [2/3]

virtual void vtkPlusClarius::GetAhrsAlgorithmGain ( double &  ,
double &   
)
virtual

◆ GetAhrsAlgorithmGain() [3/3]

virtual void vtkPlusClarius::GetAhrsAlgorithmGain ( double  [2])
virtual

◆ GetClassName()

virtual const char* vtkPlusClarius::GetClassName ( )
virtual

Reimplemented from vtkPlusUsDevice.

◆ GetCompressRawData()

virtual bool vtkPlusClarius::GetCompressRawData ( )
virtual

Compress raw data using gzip if enabled

◆ GetFilteredTiltSensorAhrsAlgorithmGain() [1/3]

virtual double* vtkPlusClarius::GetFilteredTiltSensorAhrsAlgorithmGain ( )
virtual

◆ GetFilteredTiltSensorAhrsAlgorithmGain() [2/3]

virtual void vtkPlusClarius::GetFilteredTiltSensorAhrsAlgorithmGain ( double &  ,
double &   
)
virtual

◆ GetFilteredTiltSensorAhrsAlgorithmGain() [3/3]

virtual void vtkPlusClarius::GetFilteredTiltSensorAhrsAlgorithmGain ( double  [2])
virtual

◆ GetFrameHeight()

virtual unsigned int vtkPlusClarius::GetFrameHeight ( )
virtual

◆ GetFrameWidth()

virtual unsigned int vtkPlusClarius::GetFrameWidth ( )
virtual

◆ GetImuEnabled()

virtual bool vtkPlusClarius::GetImuEnabled ( )
virtual

◆ GetImuOutputFileName()

virtual std::string vtkPlusClarius::GetImuOutputFileName ( )
virtual

◆ GetInstance()

vtkPlusClarius * vtkPlusClarius::GetInstance ( )
static

return the singleton instance with no reference counting

Definition at line 881 of file vtkPlusClarius.cxx.

◆ GetIpAddress()

virtual std::string vtkPlusClarius::GetIpAddress ( )
virtual

◆ GetSdkVersion()

virtual std::string vtkPlusClarius::GetSdkVersion ( )
virtual

Hardware device SDK version. This method should be overridden in subclasses.

Reimplemented from vtkPlusDevice.

◆ GetTcpPort()

virtual unsigned int vtkPlusClarius::GetTcpPort ( )
virtual

◆ GetWriteImagesToDisk()

virtual bool vtkPlusClarius::GetWriteImagesToDisk ( )
virtual

◆ InternalConnect()

PlusStatus vtkPlusClarius::InternalConnect ( )
protectedvirtual

Should be overridden to connect to the hardware

Reimplemented from vtkPlusDevice.

Definition at line 1117 of file vtkPlusClarius.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusClarius::InternalDisconnect ( )
protectedvirtual

Release the video driver. Should be overridden to disconnect from the hardware.

Reimplemented from vtkPlusDevice.

Definition at line 1280 of file vtkPlusClarius.cxx.

◆ IsA()

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

Reimplemented from vtkPlusUsDevice.

◆ IsTracker()

bool vtkPlusClarius::IsTracker ( ) const
inlinevirtual

The IMU streaming is supported and raw IMU data is written to csv file, however interpreting imu data as tracking data is not supported

Reimplemented from vtkPlusDevice.

Definition at line 75 of file vtkPlusClarius.h.

◆ IsTypeOf()

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

◆ New()

vtkPlusClarius * vtkPlusClarius::New ( )
static

This is a singleton pattern New. There will only be ONE reference to a vtkPlusClarius object per process. Clients that call this must call Delete on the object so that the reference counting will work. The single instance will be unreferenced when the program exits.

Definition at line 818 of file vtkPlusClarius.cxx.

◆ NotifyConfigured()

PlusStatus vtkPlusClarius::NotifyConfigured ( )
virtual

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 1055 of file vtkPlusClarius.cxx.

◆ PrintSelf()

void vtkPlusClarius::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkPlusUsDevice.

Definition at line 898 of file vtkPlusClarius.cxx.

◆ Probe()

PlusStatus vtkPlusClarius::Probe ( )
virtual

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 1097 of file vtkPlusClarius.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusClarius::ReadConfiguration ( vtkXMLDataElement *  config)
virtual

Read configuration from xml data

Reimplemented from vtkPlusUsDevice.

Definition at line 910 of file vtkPlusClarius.cxx.

◆ RequestLastNSecondsRawData()

PlusStatus vtkPlusClarius::RequestLastNSecondsRawData ( double  lastNSeconds)

Request raw ultrasound data in the last N seconds

Definition at line 1306 of file vtkPlusClarius.cxx.

◆ RequestRawData()

PlusStatus vtkPlusClarius::RequestRawData ( long long  startTimestampNanoSeconds,
long long  endTimestampNanoSeconds 
)

Request raw ultrasound data between two timestamps If both timestamps are zero, all available data will be requested

Definition at line 1321 of file vtkPlusClarius.cxx.

◆ SafeDownCast()

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

◆ SetAhrsAlgorithmGain() [1/2]

virtual void vtkPlusClarius::SetAhrsAlgorithmGain ( double  ,
double   
)
virtual

◆ SetAhrsAlgorithmGain() [2/2]

void vtkPlusClarius::SetAhrsAlgorithmGain ( double  [2])

◆ SetCompressRawData()

virtual void vtkPlusClarius::SetCompressRawData ( bool  )
virtual

◆ SetFilteredTiltSensorAhrsAlgorithmGain() [1/2]

virtual void vtkPlusClarius::SetFilteredTiltSensorAhrsAlgorithmGain ( double  ,
double   
)
virtual

◆ SetFilteredTiltSensorAhrsAlgorithmGain() [2/2]

void vtkPlusClarius::SetFilteredTiltSensorAhrsAlgorithmGain ( double  [2])

◆ SetFrameHeight()

virtual void vtkPlusClarius::SetFrameHeight ( unsigned int  )
virtual

◆ SetFrameWidth()

virtual void vtkPlusClarius::SetFrameWidth ( unsigned int  )
virtual

◆ SetImuEnabled()

virtual void vtkPlusClarius::SetImuEnabled ( bool  )
virtual

◆ SetImuOutputFileName()

virtual void vtkPlusClarius::SetImuOutputFileName ( std::string  )
virtual

◆ SetIpAddress()

virtual void vtkPlusClarius::SetIpAddress ( std::string  )
virtual

◆ SetTcpPort()

virtual void vtkPlusClarius::SetTcpPort ( unsigned int  )
virtual

◆ SetWriteImagesToDisk()

virtual void vtkPlusClarius::SetWriteImagesToDisk ( bool  )
virtual

◆ vtkGetStdStringMacro()

vtkPlusClarius::vtkGetStdStringMacro ( RawDataOutputFilename  )

◆ vtkSetStdStringMacro()

vtkPlusClarius::vtkSetStdStringMacro ( RawDataOutputFilename  )

Output filename of the raw Clarius data If empty, data will be written to the Plus output directory

◆ WriteConfiguration()

PlusStatus vtkPlusClarius::WriteConfiguration ( vtkXMLDataElement *  config)
virtual

Write configuration to xml data

Reimplemented from vtkPlusUsDevice.

Definition at line 1037 of file vtkPlusClarius.cxx.

Member Data Documentation

◆ AhrsAlgorithmGain

double vtkPlusClarius::AhrsAlgorithmGain[2]
protected

Gain values used by the AHRS algorithm (Mahony: first parameter is proportional, second is integral gain; Madgwick: only the first parameter is used) Higher gain gives higher reliability to accelerometer&magnetometer data.

Definition at line 149 of file vtkPlusClarius.h.

◆ CompressRawData

bool vtkPlusClarius::CompressRawData
protected

Definition at line 139 of file vtkPlusClarius.h.

◆ FilteredTiltSensorAhrsAlgorithmGain

double vtkPlusClarius::FilteredTiltSensorAhrsAlgorithmGain[2]
protected

Definition at line 150 of file vtkPlusClarius.h.

◆ FilteredTiltSensorWestAxisIndex

int vtkPlusClarius::FilteredTiltSensorWestAxisIndex
protected

Definition at line 161 of file vtkPlusClarius.h.

◆ FrameHeight

int vtkPlusClarius::FrameHeight
protected

Definition at line 136 of file vtkPlusClarius.h.

◆ FrameWidth

int vtkPlusClarius::FrameWidth
protected

Definition at line 135 of file vtkPlusClarius.h.

◆ ImuEnabled

bool vtkPlusClarius::ImuEnabled
protected

Definition at line 137 of file vtkPlusClarius.h.

◆ ImuOutputFileName

std::string vtkPlusClarius::ImuOutputFileName
protected

Definition at line 134 of file vtkPlusClarius.h.

◆ Instance

vtkPlusClarius * vtkPlusClarius::Instance
staticprotected

Definition at line 143 of file vtkPlusClarius.h.

◆ Internal

vtkInternal* vtkPlusClarius::Internal
protected

Definition at line 163 of file vtkPlusClarius.h.

◆ IpAddress

std::string vtkPlusClarius::IpAddress
protected

Definition at line 132 of file vtkPlusClarius.h.

◆ RawDataOutputFilename

std::string vtkPlusClarius::RawDataOutputFilename
protected

Definition at line 141 of file vtkPlusClarius.h.

◆ TcpPort

unsigned int vtkPlusClarius::TcpPort
protected

Definition at line 131 of file vtkPlusClarius.h.

◆ TiltSensorWestAxisIndex

int vtkPlusClarius::TiltSensorWestAxisIndex
protected

In tilt sensor mode we don't use the magnetometer, so we have to provide a direction reference. The orientation is specified by specifying an axis that will always point to the "West" direction. Recommended values: If sensor axis 0 points down (the sensor plane is about vertical) => TiltSensorDownAxisIndex = 2. If sensor axis 1 points down (the sensor plane is about vertical) => TiltSensorDownAxisIndex = 0. If sensor axis 2 points down (the sensor plane is about horizontal) => TiltSensorDownAxisIndex = 1.

Definition at line 160 of file vtkPlusClarius.h.

◆ WriteImagesToDisk

bool vtkPlusClarius::WriteImagesToDisk
protected

Definition at line 138 of file vtkPlusClarius.h.

The documentation for this class was generated from the following files:
Generated on Thu Apr 25 2024 01:38:10 for PlusLib by   doxygen 1.8.15