This class is used to store a configuration of the imaging parameters of an ultrasound video device. Ultrasound video devices should contain a member variable of this class that is used to set/query the depth, gain, etc. This class exists mainly for two reasons: Provide a standard interface for accessing ultrasound parameters Enable standardized API for operating on ultrasound parametersCurrently contains the following items FrequencyMhz DepthMm FocusDepthPercent (normalized [0,100]) SectorPercent GainPercent TGC [initialgain, midgain, fargain] Intensity (brightness) Contrast PowerDb DynRangeDb ZoomFactor Voltage ImageSize [x, y, z] SoundVelocity. More...

#include <src/PlusDataCollection/vtkPlusUsImagingParameters.h>

Inheritance diagram for vtkPlusUsImagingParameters:

[legend]

Collaboration diagram for vtkPlusUsImagingParameters:

[legend]

Classes
class	ParameterInfo

Public Types
enum	DataType { DataTypeScreen = 0x00000001, DataTypeBPre = 0x00000002, DataTypeBPost = 0x00000004, DataTypeBPost32 = 0x00000008, DataTypeRF = 0x00000010, DataTypeMPre = 0x00000020, DataTypeMPost = 0x00000040, DataTypePWRF = 0x00000080, DataTypePWSpectrum = 0x00000100, DataTypeColorRF = 0x00000200, DataTypeColorCombined = 0x00000400, DataTypeColorVelocityVariance = 0x00000800, DataTypeContrast = 0x00001000, DataTypeElastoCombined = 0x00002000, DataTypeElastoOverlay = 0x00004000, DataTypeElastoPre = 0x00008000, DataTypeECG = 0x00010000, DataTypeGPS1 = 0x00020000, DataTypeGPS2 = 0x00040000, DataTypeTimeStamp = 0x00080000, DataTypeColorSpectrumRF = 0x00100000, DataTypeMRF = 0x00200000, DataTypeDAQRF = 0x00400000, DataType3DPre = 0x00800000, DataType3DPost = 0x01000000, DataTypePNG = 0x10000000 }

enum	ImagingMode { 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 }

typedef vtkObject	Superclass

Public Member Functions
virtual PlusStatus	DeepCopy (const vtkPlusUsImagingParameters &otherParameters)

virtual const char *	GetClassName ()

PlusStatus	GetContrast (double &aContrast) const

double	GetContrast () const

PlusStatus	GetDepthMm (double &aDepthMm) const

double	GetDepthMm () const

PlusStatus	GetDynRangeDb (double &aDynRangeDb) const

double	GetDynRangeDb () const

PlusStatus	GetFocusDepthPercent (double &aFocusDepthPercent) const

double	GetFocusDepthPercent () const

PlusStatus	GetFrequencyMhz (double &aFrequencyMhz) const

double	GetFrequencyMhz () const

PlusStatus	GetGainPercent (double aGainPercent) const

double	GetGainPercent () const

PlusStatus	GetImageSize (FrameSizeType &imageSize) const

FrameSizeType	GetImageSize () const

PlusStatus	GetIntensity (double &aIntensity) const

double	GetIntensity () const

PlusStatus	GetPowerDb (double &aPower) const

double	GetPowerDb () const

PlusStatus	GetProbeVoltage (float &aVoltage) const

float	GetProbeVoltage () const

PlusStatus	GetSectorPercent (double &aSectorPercent) const

double	GetSectorPercent () const

PlusStatus	GetSoundVelocity (float &aSoundVelocity) const

float	GetSoundVelocity () const

PlusStatus	GetTimeGainCompensation (std::vector< double > &tgc) const

std::vector< double >	GetTimeGainCompensation () const

template<typename T >
PlusStatus	GetValue (const std::string &paramName, T &outputValue) const

PlusStatus	GetZoomFactor (double &aZoomFactor) const

double	GetZoomFactor () const

virtual int	IsA (const char *type)

bool	IsPending (const std::string &paramName) const

bool	IsSet (const std::string &paramName) const

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

virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *deviceConfig)

PlusStatus	SetContrast (double aContrast)

PlusStatus	SetDepthMm (double aDepthMm)

PlusStatus	SetDynRangeDb (double aDynRangeDb)

PlusStatus	SetFocusDepthPercent (double aFocusDepthPercent)

PlusStatus	SetFrequencyMhz (double aFrequencyMhz)

PlusStatus	SetGainPercent (double aGainPercent)

PlusStatus	SetImageSize (const FrameSizeType &imageSize)

PlusStatus	SetImageSize (unsigned int x, unsigned int y, unsigned int z)

PlusStatus	SetIntensity (double aIntensity)

PlusStatus	SetPending (const std::string &paramName, bool pending)

PlusStatus	SetPowerDb (double aPower)

PlusStatus	SetProbeVoltage (float aVoltage)

PlusStatus	SetSectorPercent (double aSectorPercent)

PlusStatus	SetSoundVelocity (float aSoundVelocity)

PlusStatus	SetTimeGainCompensation (const std::vector< double > &tgc)

PlusStatus	SetTimeGainCompensation (double *tgc, int length)

template<typename T >
PlusStatus	SetValue (const std::string &paramName, T aValue)

PlusStatus	SetZoomFactor (double aZoomFactor)

virtual PlusStatus	WriteConfiguration (vtkXMLDataElement *deviceConfig)

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

static vtkPlusUsImagingParameters *	New ()

static vtkPlusUsImagingParameters *	SafeDownCast (vtkObject *o)

Static Public Attributes
static const char *	KEY_CONTRAST = "Contrast"

static const char *	KEY_DEPTH = "DepthMm"

static const char *	KEY_DYNRANGE = "DynRangeDb"

static const char *	KEY_FOCUS_DEPTH = "FocusDepthPercent"

static const char *	KEY_FREQUENCY = "FrequencyMhz"

static const char *	KEY_GAIN = "GainPercent"

static const char *	KEY_IMAGESIZE = "ImageSize"

static const char *	KEY_INTENSITY = "Intensity"

static const char *	KEY_POWER = "PowerDb"

static const char *	KEY_SECTOR = "SectorPercent"

static const char *	KEY_SOUNDVELOCITY = "SoundVelocity"

static const char *	KEY_TGC = "TimeGainCompensation"

static const char *	KEY_VOLTAGE = "Voltage"

static const char *	KEY_ZOOM = "ZoomFactor"

static const char *	NAME_TAG = "name"

static const char *	US_PARAMETER_TAG = "UsParameter"

static const char *	VALUE_TAG = "value"

static const char *	XML_ELEMENT_TAG = "UsImagingParameters"

Protected Types
typedef std::map< std::string, ParameterInfo >	ParameterMap

typedef ParameterMap::const_iterator	ParameterMapConstIterator

typedef ParameterMap::iterator	ParameterMapIterator

Protected Member Functions
ParameterMapConstIterator	begin () const

ParameterMapConstIterator	end () const

	vtkPlusUsImagingParameters ()

virtual	~vtkPlusUsImagingParameters ()

Protected Attributes
ParameterMap	Parameters

Detailed Description

This class is used to store a configuration of the imaging parameters of an ultrasound video device. Ultrasound video devices should contain a member variable of this class that is used to set/query the depth, gain, etc. This class exists mainly for two reasons: Provide a standard interface for accessing ultrasound parameters Enable standardized API for operating on ultrasound parameters

Currently contains the following items FrequencyMhz DepthMm FocusDepthPercent (normalized [0,100]) SectorPercent GainPercent TGC [initialgain, midgain, fargain] Intensity (brightness) Contrast PowerDb DynRangeDb ZoomFactor Voltage ImageSize [x, y, z] SoundVelocity.

Definition at line 41 of file vtkPlusUsImagingParameters.h.

Member Typedef Documentation

◆ ParameterMap

typedef std::map<std::string, ParameterInfo> vtkPlusUsImagingParameters::ParameterMap

protected

Definition at line 58 of file vtkPlusUsImagingParameters.h.

◆ ParameterMapConstIterator

typedef ParameterMap::const_iterator vtkPlusUsImagingParameters::ParameterMapConstIterator

protected

Definition at line 60 of file vtkPlusUsImagingParameters.h.

◆ ParameterMapIterator

typedef ParameterMap::iterator vtkPlusUsImagingParameters::ParameterMapIterator

protected

Definition at line 59 of file vtkPlusUsImagingParameters.h.

◆ Superclass

typedef vtkObject vtkPlusUsImagingParameters::Superclass

Definition at line 89 of file vtkPlusUsImagingParameters.h.

Member Enumeration Documentation

◆ DataType

enum vtkPlusUsImagingParameters::DataType

Enumerator
DataTypeScreen
DataTypeBPre
DataTypeBPost
DataTypeBPost32
DataTypeRF
DataTypeMPre
DataTypeMPost
DataTypePWRF
DataTypePWSpectrum
DataTypeColorRF
DataTypeColorCombined
DataTypeColorVelocityVariance
DataTypeContrast
DataTypeElastoCombined
DataTypeElastoOverlay
DataTypeElastoPre
DataTypeECG
DataTypeGPS1
DataTypeGPS2
DataTypeTimeStamp
DataTypeColorSpectrumRF
DataTypeMRF
DataTypeDAQRF
DataType3DPre
DataType3DPost
DataTypePNG

Definition at line 288 of file vtkPlusUsImagingParameters.h.

◆ ImagingMode

enum vtkPlusUsImagingParameters::ImagingMode

Enumerator
BMode
MMode
ColourMode
PwMode
TriplexMode
PanoMode
DualMode
QuadMode
CompoundMode
DualColourMode
DualCompoundMode
CwMode
RfMode
ColorSplitMode
F4DMode
TriplexCwMode
ColourMMode
ElastoMode
SDUVMode
AnatomicalMMode
ElastoComparativeMode
FusionMode
VecDopMode
BiplaneMode
ClinicalRfMode
RfCompoundMode
SHINEMode
ColourRfMode

Definition at line 256 of file vtkPlusUsImagingParameters.h.

Constructor & Destructor Documentation

◆ vtkPlusUsImagingParameters()

vtkPlusUsImagingParameters::vtkPlusUsImagingParameters ( )

protected

Definition at line 38 of file vtkPlusUsImagingParameters.cxx.

◆ ~vtkPlusUsImagingParameters()

vtkPlusUsImagingParameters::~vtkPlusUsImagingParameters ( )

protectedvirtual

Definition at line 58 of file vtkPlusUsImagingParameters.cxx.

Member Function Documentation

◆ begin()

vtkPlusUsImagingParameters::ParameterMapConstIterator vtkPlusUsImagingParameters::begin ( ) const

protected

Return an iterator to the beginning of the parameter space

Definition at line 337 of file vtkPlusUsImagingParameters.cxx.

◆ DeepCopy()

PlusStatus vtkPlusUsImagingParameters::DeepCopy ( const vtkPlusUsImagingParameters & otherParameters )

virtual

Copy the values from another imaging parameters

Definition at line 577 of file vtkPlusUsImagingParameters.cxx.

◆ end()

vtkPlusUsImagingParameters::ParameterMapConstIterator vtkPlusUsImagingParameters::end ( ) const

protected

Return an iterator to the end of the parameter space

Definition at line 343 of file vtkPlusUsImagingParameters.cxx.

◆ GetClassName()

virtual const char* vtkPlusUsImagingParameters::GetClassName ( )

virtual

◆ GetContrast() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetContrast ( double & aContrast ) const

Get the contrast of B-mode ultrasound

Definition at line 222 of file vtkPlusUsImagingParameters.cxx.

◆ GetContrast() [2/2]

double vtkPlusUsImagingParameters::GetContrast ( ) const

Definition at line 228 of file vtkPlusUsImagingParameters.cxx.

◆ GetDepthMm() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetDepthMm ( double & aDepthMm ) const

Get the depth (mm) of B-mode ultrasound

Definition at line 90 of file vtkPlusUsImagingParameters.cxx.

◆ GetDepthMm() [2/2]

double vtkPlusUsImagingParameters::GetDepthMm ( ) const

Definition at line 96 of file vtkPlusUsImagingParameters.cxx.

◆ GetDynRangeDb() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetDynRangeDb ( double & aDynRangeDb ) const

Get the DynRange (dB) of B-mode ultrasound

Definition at line 262 of file vtkPlusUsImagingParameters.cxx.

◆ GetDynRangeDb() [2/2]

double vtkPlusUsImagingParameters::GetDynRangeDb ( ) const

Definition at line 268 of file vtkPlusUsImagingParameters.cxx.

◆ GetFocusDepthPercent() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetFocusDepthPercent ( double & aFocusDepthPercent ) const

Get the focus depth (normalized [0,1]) of B-mode ultrasound

Definition at line 110 of file vtkPlusUsImagingParameters.cxx.

◆ GetFocusDepthPercent() [2/2]

double vtkPlusUsImagingParameters::GetFocusDepthPercent ( ) const

Definition at line 116 of file vtkPlusUsImagingParameters.cxx.

◆ GetFrequencyMhz() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetFrequencyMhz ( double & aFrequencyMhz ) const

Get ultrasound transmitter frequency (MHz)

Definition at line 70 of file vtkPlusUsImagingParameters.cxx.

◆ GetFrequencyMhz() [2/2]

double vtkPlusUsImagingParameters::GetFrequencyMhz ( ) const

Definition at line 76 of file vtkPlusUsImagingParameters.cxx.

◆ GetGainPercent() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetGainPercent ( double aGainPercent ) const

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

Definition at line 130 of file vtkPlusUsImagingParameters.cxx.

◆ GetGainPercent() [2/2]

double vtkPlusUsImagingParameters::GetGainPercent ( ) const

Definition at line 136 of file vtkPlusUsImagingParameters.cxx.

◆ GetImageSize() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetImageSize ( FrameSizeType & imageSize ) const

Get the image size of B-mode ultrasound

Definition at line 393 of file vtkPlusUsImagingParameters.cxx.

◆ GetImageSize() [2/2]

FrameSizeType vtkPlusUsImagingParameters::GetImageSize ( ) const

Definition at line 427 of file vtkPlusUsImagingParameters.cxx.

◆ GetIntensity() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetIntensity ( double & aIntensity ) const

Get the Intensity of B-mode ultrasound

Definition at line 202 of file vtkPlusUsImagingParameters.cxx.

◆ GetIntensity() [2/2]

double vtkPlusUsImagingParameters::GetIntensity ( ) const

Definition at line 208 of file vtkPlusUsImagingParameters.cxx.

◆ GetPowerDb() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetPowerDb ( double & aPower ) const

Get the Power of B-mode ultrasound

Definition at line 242 of file vtkPlusUsImagingParameters.cxx.

◆ GetPowerDb() [2/2]

double vtkPlusUsImagingParameters::GetPowerDb ( ) const

Definition at line 248 of file vtkPlusUsImagingParameters.cxx.

◆ GetProbeVoltage() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetProbeVoltage ( float & aVoltage ) const

Get the voltage of ultrasound probe (depends on an ultrasound system)

Definition at line 355 of file vtkPlusUsImagingParameters.cxx.

◆ GetProbeVoltage() [2/2]

float vtkPlusUsImagingParameters::GetProbeVoltage ( ) const

Definition at line 361 of file vtkPlusUsImagingParameters.cxx.

◆ GetSectorPercent() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetSectorPercent ( double & aSectorPercent ) const

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

Definition at line 302 of file vtkPlusUsImagingParameters.cxx.

◆ GetSectorPercent() [2/2]

double vtkPlusUsImagingParameters::GetSectorPercent ( ) const

Definition at line 308 of file vtkPlusUsImagingParameters.cxx.

◆ GetSoundVelocity() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetSoundVelocity ( float & aSoundVelocity ) const

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

Definition at line 322 of file vtkPlusUsImagingParameters.cxx.

◆ GetSoundVelocity() [2/2]

float vtkPlusUsImagingParameters::GetSoundVelocity ( ) const

Definition at line 328 of file vtkPlusUsImagingParameters.cxx.

◆ GetTimeGainCompensation() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetTimeGainCompensation ( std::vector< double > & tgc ) const

Get the TGC [initialgain, midgain, fargain] of B-mode ultrasound; valid range: 0-100

Definition at line 167 of file vtkPlusUsImagingParameters.cxx.

◆ GetTimeGainCompensation() [2/2]

std::vector< double > vtkPlusUsImagingParameters::GetTimeGainCompensation ( ) const

Definition at line 188 of file vtkPlusUsImagingParameters.cxx.

◆ GetValue()

template<typename T >

PlusStatus vtkPlusUsImagingParameters::GetValue	(	const std::string &	paramName,
		T &	outputValue
	)		const

inline

Request a stored value by key name

Parameters

paramName	the key value to retrieve
outputValue	the output variable to write to

Definition at line 115 of file vtkPlusUsImagingParameters.h.

◆ GetZoomFactor() [1/2]

PlusStatus vtkPlusUsImagingParameters::GetZoomFactor ( double & aZoomFactor ) const

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

Definition at line 282 of file vtkPlusUsImagingParameters.cxx.

◆ GetZoomFactor() [2/2]

double vtkPlusUsImagingParameters::GetZoomFactor ( ) const

Definition at line 288 of file vtkPlusUsImagingParameters.cxx.

◆ IsA()

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

virtual

◆ IsPending()

bool vtkPlusUsImagingParameters::IsPending ( const std::string & paramName ) const

Request the pending status of a parameter

Parameters

paramName the key value to retrieve

Definition at line 542 of file vtkPlusUsImagingParameters.cxx.

◆ IsSet()

bool vtkPlusUsImagingParameters::IsSet ( const std::string & paramName ) const

Request the set status of a parameter (whether it is not the default value)

Parameters

paramName the key value to retrieve

Definition at line 529 of file vtkPlusUsImagingParameters.cxx.

◆ IsTypeOf()

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

static

◆ New()

static vtkPlusUsImagingParameters* vtkPlusUsImagingParameters::New ( )

static

◆ PrintSelf()

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

virtual

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

Definition at line 435 of file vtkPlusUsImagingParameters.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusUsImagingParameters::ReadConfiguration ( vtkXMLDataElement * deviceConfig )

virtual

Read main configuration from/to XML data Assumes that the data element passed is the device element, not the root!

Parameters

deviceConfig the XML element of the device

Definition at line 450 of file vtkPlusUsImagingParameters.cxx.

◆ SafeDownCast()

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

static

◆ SetContrast()

PlusStatus vtkPlusUsImagingParameters::SetContrast ( double aContrast )

Set the contrast of B-mode ultrasound

Definition at line 216 of file vtkPlusUsImagingParameters.cxx.

◆ SetDepthMm()

PlusStatus vtkPlusUsImagingParameters::SetDepthMm ( double aDepthMm )

Set the depth (mm) of B-mode ultrasound

Definition at line 84 of file vtkPlusUsImagingParameters.cxx.

◆ SetDynRangeDb()

PlusStatus vtkPlusUsImagingParameters::SetDynRangeDb ( double aDynRangeDb )

Set the DynRange (dB) of B-mode ultrasound

Definition at line 256 of file vtkPlusUsImagingParameters.cxx.

◆ SetFocusDepthPercent()

PlusStatus vtkPlusUsImagingParameters::SetFocusDepthPercent ( double aFocusDepthPercent )

Set the focus depth (normalized [0,1]) of B-mode ultrasound

Definition at line 104 of file vtkPlusUsImagingParameters.cxx.

◆ SetFrequencyMhz()

PlusStatus vtkPlusUsImagingParameters::SetFrequencyMhz ( double aFrequencyMhz )

Set ultrasound transmitter frequency (MHz)

Definition at line 64 of file vtkPlusUsImagingParameters.cxx.

◆ SetGainPercent()

PlusStatus vtkPlusUsImagingParameters::SetGainPercent ( double aGainPercent )

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

Definition at line 124 of file vtkPlusUsImagingParameters.cxx.

◆ SetImageSize() [1/2]

PlusStatus vtkPlusUsImagingParameters::SetImageSize ( const FrameSizeType & imageSize )

Set the image size [width, height, depth(elevational dimension)] of the B-mode ultrasound

Definition at line 369 of file vtkPlusUsImagingParameters.cxx.

◆ SetImageSize() [2/2]

PlusStatus vtkPlusUsImagingParameters::SetImageSize	(	unsigned int	x,
		unsigned int	y,
		unsigned int	z
	)

Definition at line 386 of file vtkPlusUsImagingParameters.cxx.

◆ SetIntensity()

PlusStatus vtkPlusUsImagingParameters::SetIntensity ( double aIntensity )

Set the intensity of B-mode ultrasound

Definition at line 196 of file vtkPlusUsImagingParameters.cxx.

◆ SetPending()

PlusStatus vtkPlusUsImagingParameters::SetPending	(	const std::string &	paramName,
		bool	pending
	)

Set the pending status of a parameter

Definition at line 555 of file vtkPlusUsImagingParameters.cxx.

◆ SetPowerDb()

PlusStatus vtkPlusUsImagingParameters::SetPowerDb ( double aPower )

Set the power of B-mode ultrasound

Definition at line 236 of file vtkPlusUsImagingParameters.cxx.

◆ SetProbeVoltage()

PlusStatus vtkPlusUsImagingParameters::SetProbeVoltage ( float aVoltage )

Set the voltage of ultrasound probe (depends on an ultrasound system)

Definition at line 349 of file vtkPlusUsImagingParameters.cxx.

◆ SetSectorPercent()

PlusStatus vtkPlusUsImagingParameters::SetSectorPercent ( double aSectorPercent )

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

Definition at line 296 of file vtkPlusUsImagingParameters.cxx.

◆ SetSoundVelocity()

PlusStatus vtkPlusUsImagingParameters::SetSoundVelocity ( float aSoundVelocity )

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

Definition at line 316 of file vtkPlusUsImagingParameters.cxx.

◆ SetTimeGainCompensation() [1/2]

PlusStatus vtkPlusUsImagingParameters::SetTimeGainCompensation ( const std::vector< double > & tgc )

Set the TGC [initialgain, midgain, fargain] of B-mode ultrasound; valid range: 0-100

Definition at line 144 of file vtkPlusUsImagingParameters.cxx.

◆ SetTimeGainCompensation() [2/2]

PlusStatus vtkPlusUsImagingParameters::SetTimeGainCompensation	(	double *	tgc,
		int	length
	)

Definition at line 160 of file vtkPlusUsImagingParameters.cxx.

◆ SetValue()

template<typename T >

PlusStatus vtkPlusUsImagingParameters::SetValue	(	const std::string &	paramName,
		T	aValue
	)

inline

Set a stored value by key name Defined in the header to make it available externally

Parameters

paramName	the key value to retrieve
aValue	the value to write

Definition at line 140 of file vtkPlusUsImagingParameters.h.

◆ SetZoomFactor()

PlusStatus vtkPlusUsImagingParameters::SetZoomFactor ( double aZoomFactor )

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

Definition at line 276 of file vtkPlusUsImagingParameters.cxx.

◆ WriteConfiguration()

PlusStatus vtkPlusUsImagingParameters::WriteConfiguration ( vtkXMLDataElement * deviceConfig )

virtual

Write main configuration from/to XML data Assumes that the data element passed is the device element, not the root!

Parameters

deviceConfig the XML element of the device

Definition at line 492 of file vtkPlusUsImagingParameters.cxx.

Member Data Documentation

◆ KEY_CONTRAST

const char * vtkPlusUsImagingParameters::KEY_CONTRAST = "Contrast"

static

Definition at line 79 of file vtkPlusUsImagingParameters.h.

◆ KEY_DEPTH

const char * vtkPlusUsImagingParameters::KEY_DEPTH = "DepthMm"

static

Definition at line 73 of file vtkPlusUsImagingParameters.h.

◆ KEY_DYNRANGE

const char * vtkPlusUsImagingParameters::KEY_DYNRANGE = "DynRangeDb"

static

Definition at line 75 of file vtkPlusUsImagingParameters.h.

◆ KEY_FOCUS_DEPTH

const char * vtkPlusUsImagingParameters::KEY_FOCUS_DEPTH = "FocusDepthPercent"

static

Definition at line 74 of file vtkPlusUsImagingParameters.h.

◆ KEY_FREQUENCY

const char * vtkPlusUsImagingParameters::KEY_FREQUENCY = "FrequencyMhz"

static

Definition at line 72 of file vtkPlusUsImagingParameters.h.

◆ KEY_GAIN

const char * vtkPlusUsImagingParameters::KEY_GAIN = "GainPercent"

static

Definition at line 76 of file vtkPlusUsImagingParameters.h.

◆ KEY_IMAGESIZE

const char * vtkPlusUsImagingParameters::KEY_IMAGESIZE = "ImageSize"

static

Definition at line 85 of file vtkPlusUsImagingParameters.h.

◆ KEY_INTENSITY

const char * vtkPlusUsImagingParameters::KEY_INTENSITY = "Intensity"

static

Definition at line 78 of file vtkPlusUsImagingParameters.h.

◆ KEY_POWER

const char * vtkPlusUsImagingParameters::KEY_POWER = "PowerDb"

static

Definition at line 80 of file vtkPlusUsImagingParameters.h.

◆ KEY_SECTOR

const char * vtkPlusUsImagingParameters::KEY_SECTOR = "SectorPercent"

static

Definition at line 81 of file vtkPlusUsImagingParameters.h.

◆ KEY_SOUNDVELOCITY

const char * vtkPlusUsImagingParameters::KEY_SOUNDVELOCITY = "SoundVelocity"

static

Definition at line 83 of file vtkPlusUsImagingParameters.h.

◆ KEY_TGC

const char * vtkPlusUsImagingParameters::KEY_TGC = "TimeGainCompensation"

static

Definition at line 77 of file vtkPlusUsImagingParameters.h.

◆ KEY_VOLTAGE

const char * vtkPlusUsImagingParameters::KEY_VOLTAGE = "Voltage"

static

Definition at line 84 of file vtkPlusUsImagingParameters.h.

◆ KEY_ZOOM

const char * vtkPlusUsImagingParameters::KEY_ZOOM = "ZoomFactor"

static

Definition at line 82 of file vtkPlusUsImagingParameters.h.

◆ NAME_TAG

const char * vtkPlusUsImagingParameters::NAME_TAG = "name"

static

Definition at line 70 of file vtkPlusUsImagingParameters.h.

◆ Parameters

ParameterMap vtkPlusUsImagingParameters::Parameters

protected

Definition at line 322 of file vtkPlusUsImagingParameters.h.

◆ US_PARAMETER_TAG

const char * vtkPlusUsImagingParameters::US_PARAMETER_TAG = "UsParameter"

static

Definition at line 69 of file vtkPlusUsImagingParameters.h.

◆ VALUE_TAG

const char * vtkPlusUsImagingParameters::VALUE_TAG = "value"

static

Definition at line 71 of file vtkPlusUsImagingParameters.h.

◆ XML_ELEMENT_TAG

const char * vtkPlusUsImagingParameters::XML_ELEMENT_TAG = "UsImagingParameters"

static

Definition at line 68 of file vtkPlusUsImagingParameters.h.

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

src/PlusDataCollection/vtkPlusUsImagingParameters.h
src/PlusDataCollection/vtkPlusUsImagingParameters.cxx

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ParameterMap

◆ ParameterMapConstIterator

◆ ParameterMapIterator

◆ Superclass

Member Enumeration Documentation

◆ DataType

◆ ImagingMode

Constructor & Destructor Documentation

◆ vtkPlusUsImagingParameters()

◆ ~vtkPlusUsImagingParameters()

Member Function Documentation

◆ begin()

◆ DeepCopy()

◆ end()

◆ GetClassName()

◆ GetContrast() [1/2]

◆ GetContrast() [2/2]

◆ GetDepthMm() [1/2]

◆ GetDepthMm() [2/2]

◆ GetDynRangeDb() [1/2]

◆ GetDynRangeDb() [2/2]

◆ GetFocusDepthPercent() [1/2]

◆ GetFocusDepthPercent() [2/2]

◆ GetFrequencyMhz() [1/2]

◆ GetFrequencyMhz() [2/2]

◆ GetGainPercent() [1/2]

◆ GetGainPercent() [2/2]

◆ GetImageSize() [1/2]

◆ GetImageSize() [2/2]

◆ GetIntensity() [1/2]

◆ GetIntensity() [2/2]

◆ GetPowerDb() [1/2]

◆ GetPowerDb() [2/2]

◆ GetProbeVoltage() [1/2]

◆ GetProbeVoltage() [2/2]

◆ GetSectorPercent() [1/2]

◆ GetSectorPercent() [2/2]

◆ GetSoundVelocity() [1/2]

◆ GetSoundVelocity() [2/2]

◆ GetTimeGainCompensation() [1/2]

◆ GetTimeGainCompensation() [2/2]

◆ GetValue()

◆ GetZoomFactor() [1/2]

◆ GetZoomFactor() [2/2]

◆ IsA()

◆ IsPending()

◆ IsSet()

◆ IsTypeOf()

◆ New()

◆ PrintSelf()

◆ ReadConfiguration()

◆ SafeDownCast()

◆ SetContrast()

◆ SetDepthMm()

◆ SetDynRangeDb()

◆ SetFocusDepthPercent()

◆ SetFrequencyMhz()

◆ SetGainPercent()

◆ SetImageSize() [1/2]

◆ SetImageSize() [2/2]

◆ SetIntensity()

◆ SetPending()

◆ SetPowerDb()

◆ SetProbeVoltage()

◆ SetSectorPercent()

◆ SetSoundVelocity()

◆ SetTimeGainCompensation() [1/2]

◆ SetTimeGainCompensation() [2/2]

◆ SetValue()

◆ SetZoomFactor()