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
vtkPlusIntersonArraySDKCxxVideoSource Class Reference
DataCollection

Class for acquiring ultrasound images from Interson Array USB ultrasound systems with C++ Wrapped SDK. More...

#include <src/PlusDataCollection/IntersonArraySDKCxx/vtkPlusIntersonArraySDKCxxVideoSource.h>

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

Public Types

typedef unsigned char BmodePixelType
 
typedef short RfPixelType
 
typedef vtkPlusDevice Superclass
 
- Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual unsigned char GetPulseVoltage ()
 
virtual std::string GetSdkVersion ()
 
virtual int IsA (const char *type)
 
virtual bool IsTracker () const
 
virtual PlusStatus NotifyConfigured ()
 
virtual void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *config)
 
PlusStatus SetDynRangeDb (double dynRangeDb)
 
PlusStatus SetProbeFrequencyMhz (double aFreq)
 
PlusStatus SetPulseVoltage (unsigned char voltage)
 
virtual PlusStatus WriteConfiguration (vtkXMLDataElement *config)
 
- 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 std::string GetParameter (const std::string &key) const
 
virtual PlusStatus GetParameter (const std::string &key, std::string &outValue) 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 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 SetParameter (const std::string &key, const std::string &value)
 
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 vtkPlusIntersonArraySDKCxxVideoSource * New ()
 
static vtkPlusIntersonArraySDKCxxVideoSource * 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 ()
 
virtual PlusStatus InternalStartRecording ()
 
virtual PlusStatus InternalStopRecording ()
 
virtual PlusStatus InternalUpdate ()
 
 vtkPlusIntersonArraySDKCxxVideoSource ()
 
 ~vtkPlusIntersonArraySDKCxxVideoSource ()
 
- Protected Member Functions inherited from vtkPlusDevice
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)
 
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)
 
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

vtkPlusUsImagingParameters * ImagingParameters
 
vtkInternal * Internal
 
unsigned char PulseVoltage
 
- Protected Attributes inherited from vtkPlusDevice
double AcquisitionRate
 
int Connected
 
bool CorrectlyConfigured
 
StreamBufferItem * CurrentStreamBufferItem
 
vtkPlusDataCollector * DataCollector
 
double DesiredTimestamp
 
std::string DeviceId
 
DataSourceContainer Fields
 
unsigned long FrameNumber
 
double FrameTimeStamp
 
ChannelContainer InputChannels
 
double LocalTimeOffsetSec
 
double MissingInputGracePeriodSec
 
ChannelContainer OutputChannels
 
int OutputNeedsInitialization
 
std::map< std::string, std::string > Parameters
 
int Recording
 
double RecordingStartTime
 
std::set< std::string > ReportedUnknownTools
 
bool RequireImageOrientationInConfiguration
 
bool RequirePortNameInDeviceSetConfiguration
 
bool StartThreadForInternalUpdates
 
bool ThreadAlive
 
vtkMultiThreader * Threader
 
int ThreadId
 
double TimestampClosestToDesired
 
std::string ToolReferenceFrameName
 
DataSourceContainer Tools
 
int UpdateWithDesiredTimestamp
 
DataSourceContainer VideoSources
 

Additional Inherited Members

- Public Attributes inherited from vtkPlusDevice
double InternalUpdateRate
 
vtkIGSIORecursiveCriticalSection * UpdateMutex
 
vtkTimeStamp UpdateTime
 
- Static Public Attributes inherited from vtkPlusDevice
static const std::string BMODE_PORT_NAME = "B"
 
static const std::string PARAMETER_XML_ELEMENT_TAG = "Parameter"
 
static const std::string PARAMETERS_XML_ELEMENT_TAG = "Parameters"
 
static const std::string RFMODE_PORT_NAME = "Rf"
 
- Static Protected Member Functions inherited from vtkPlusDevice
static void * vtkDataCaptureThread (vtkMultiThreader::ThreadInfo *data)
 
- Static Protected Attributes inherited from vtkPlusDevice
static const int VIRTUAL_DEVICE_FRAME_RATE = 50
 

Detailed Description

Class for acquiring ultrasound images from Interson Array USB ultrasound systems with C++ Wrapped SDK.

Requires the PLUS_USE_INTERSONARRAYSDKCXX_VIDEO option in CMake. Requires Interson Array SDK 2.X and the C++ Wrappers (SDK provided by Interson, Wrappers provided by Kitware).

Both RF and B-Mode output is supported. If there is a single B-Mode output channel configured, then the native B-Mode generated on the transducer is output utilizing Plus scan conversion. If an RF channel is configured, then RF is output on the RF channel, and, if a B-Mode channel is also configured, the B-Mode derived from the RF using Plus envelope detection, amplitude compression, and scan conversion derived directly from the RF will be output on the B-Mode channel.

Definition at line 36 of file vtkPlusIntersonArraySDKCxxVideoSource.h.

Member Typedef Documentation

◆ BmodePixelType

typedef unsigned char vtkPlusIntersonArraySDKCxxVideoSource::BmodePixelType

Definition at line 63 of file vtkPlusIntersonArraySDKCxxVideoSource.h.

◆ RfPixelType

typedef short vtkPlusIntersonArraySDKCxxVideoSource::RfPixelType

Definition at line 66 of file vtkPlusIntersonArraySDKCxxVideoSource.h.

◆ Superclass

typedef vtkPlusDevice vtkPlusIntersonArraySDKCxxVideoSource::Superclass

Definition at line 40 of file vtkPlusIntersonArraySDKCxxVideoSource.h.

Constructor & Destructor Documentation

◆ vtkPlusIntersonArraySDKCxxVideoSource()

vtkPlusIntersonArraySDKCxxVideoSource::vtkPlusIntersonArraySDKCxxVideoSource ( )
protected

Constructor

Definition at line 225 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ ~vtkPlusIntersonArraySDKCxxVideoSource()

vtkPlusIntersonArraySDKCxxVideoSource::~vtkPlusIntersonArraySDKCxxVideoSource ( )
protected

Destructor

Definition at line 239 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPlusIntersonArraySDKCxxVideoSource::GetClassName ( )
virtual

Reimplemented from vtkPlusDevice.

◆ GetPulseVoltage()

virtual unsigned char vtkPlusIntersonArraySDKCxxVideoSource::GetPulseVoltage ( )
virtual

◆ GetSdkVersion()

std::string vtkPlusIntersonArraySDKCxxVideoSource::GetSdkVersion ( )
virtual

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

Reimplemented from vtkPlusDevice.

Definition at line 662 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ InternalConnect()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::InternalConnect ( )
protectedvirtual

Device-specific connect

Reimplemented from vtkPlusDevice.

Definition at line 259 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::InternalDisconnect ( )
protectedvirtual

Device-specific disconnect

Reimplemented from vtkPlusDevice.

Definition at line 520 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ InternalStartRecording()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::InternalStartRecording ( )
protectedvirtual

Device-specific recording start

Reimplemented from vtkPlusDevice.

Definition at line 534 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ InternalStopRecording()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::InternalStopRecording ( )
protectedvirtual

Device-specific recording stop

Reimplemented from vtkPlusDevice.

Definition at line 571 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ InternalUpdate()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::InternalUpdate ( )
protectedvirtual

The internal function which actually does the grab.

Reimplemented from vtkPlusDevice.

Definition at line 588 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ IsA()

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

Reimplemented from vtkPlusDevice.

◆ IsTracker()

virtual bool vtkPlusIntersonArraySDKCxxVideoSource::IsTracker ( ) const
inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 43 of file vtkPlusIntersonArraySDKCxxVideoSource.h.

◆ IsTypeOf()

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

◆ New()

static vtkPlusIntersonArraySDKCxxVideoSource* vtkPlusIntersonArraySDKCxxVideoSource::New ( )
static

◆ NotifyConfigured()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::NotifyConfigured ( )
virtual

Verify the device is correctly configured

Reimplemented from vtkPlusDevice.

Definition at line 644 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ PrintSelf()

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

Reimplemented from vtkPlusDevice.

Definition at line 251 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::ReadConfiguration ( vtkXMLDataElement *  config)
virtual

Read configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 599 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ SafeDownCast()

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

◆ SetDynRangeDb()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::SetDynRangeDb ( double  dynRangeDb)

Definition at line 733 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ SetProbeFrequencyMhz()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::SetProbeFrequencyMhz ( double  aFreq)

Definition at line 680 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ SetPulseVoltage()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::SetPulseVoltage ( unsigned char  voltage)

Definition at line 668 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

◆ WriteConfiguration()

PlusStatus vtkPlusIntersonArraySDKCxxVideoSource::WriteConfiguration ( vtkXMLDataElement *  config)
virtual

Write configuration to xml data

Reimplemented from vtkPlusDevice.

Definition at line 635 of file vtkPlusIntersonArraySDKCxxVideoSource.cxx.

Member Data Documentation

◆ ImagingParameters

vtkPlusUsImagingParameters* vtkPlusIntersonArraySDKCxxVideoSource::ImagingParameters
protected

Definition at line 93 of file vtkPlusIntersonArraySDKCxxVideoSource.h.

◆ Internal

vtkInternal* vtkPlusIntersonArraySDKCxxVideoSource::Internal
protected

Definition at line 90 of file vtkPlusIntersonArraySDKCxxVideoSource.h.

◆ PulseVoltage

unsigned char vtkPlusIntersonArraySDKCxxVideoSource::PulseVoltage
protected

Definition at line 95 of file vtkPlusIntersonArraySDKCxxVideoSource.h.

The documentation for this class was generated from the following files:
Generated on Tue Oct 28 2025 01:03:52 for PlusLib by   doxygen 1.8.15