PlusLib
2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
|
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>
Public Member Functions | |
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 |
PlusStatus | GetZoomFactor (double &aZoomFactor) const |
double | GetZoomFactor () const |
virtual int | IsA (const char *type) |
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 | 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) |
PlusStatus | SetZoomFactor (double aZoomFactor) |
![]() | |
virtual PlusStatus | DeepCopy (const vtkPlusParameters &otherParameters) |
template<typename T > | |
PlusStatus | GetValue (const std::string ¶mName, T &outputValue) const |
bool | IsPending (const std::string ¶mName) const |
bool | IsSet (const std::string ¶mName) const |
virtual void | PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE |
virtual PlusStatus | ReadConfiguration (vtkXMLDataElement *deviceConfig) |
PlusStatus | SetPending (const std::string ¶mName, bool pending) |
template<typename T > | |
PlusStatus | SetValue (const std::string ¶mName, T aValue) |
virtual PlusStatus | WriteConfiguration (vtkXMLDataElement *deviceConfig) |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkPlusUsImagingParameters * | New () |
static vtkPlusUsImagingParameters * | SafeDownCast (vtkObject *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkPlusParameters * | New () |
static vtkPlusParameters * | 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 * | US_XML_ELEMENT_TAG = "UsImagingParameters" |
![]() | |
static const char * | NAME_TAG = "Name" |
static const char * | PARAMETER_TAG = "Parameter" |
static const char * | VALUE_TAG = "Value" |
static const char * | XML_ELEMENT_TAG = "Parameters" |
Protected Member Functions | |
const char * | GetXMLElementName () override |
vtkPlusUsImagingParameters () | |
virtual | ~vtkPlusUsImagingParameters () |
![]() | |
ParameterMapConstIterator | begin () const |
ParameterMapConstIterator | end () const |
vtkPlusParameters () | |
virtual | ~vtkPlusParameters () |
Protected Attributes | |
ParameterMap | Parameters |
![]() | |
ParameterMap | Parameters |
Additional Inherited Members | |
![]() | |
typedef std::map< std::string, ParameterInfo > | ParameterMap |
typedef ParameterMap::const_iterator | ParameterMapConstIterator |
typedef ParameterMap::iterator | ParameterMapIterator |
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 43 of file vtkPlusUsImagingParameters.h.
Definition at line 64 of file vtkPlusUsImagingParameters.h.
Definition at line 184 of file vtkPlusUsImagingParameters.h.
Definition at line 152 of file vtkPlusUsImagingParameters.h.
|
protected |
Definition at line 35 of file vtkPlusUsImagingParameters.cxx.
|
protectedvirtual |
Definition at line 55 of file vtkPlusUsImagingParameters.cxx.
|
virtual |
Reimplemented from vtkPlusParameters.
PlusStatus vtkPlusUsImagingParameters::GetContrast | ( | double & | aContrast | ) | const |
Get the contrast of B-mode ultrasound
Definition at line 219 of file vtkPlusUsImagingParameters.cxx.
double vtkPlusUsImagingParameters::GetContrast | ( | ) | const |
Definition at line 225 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetDepthMm | ( | double & | aDepthMm | ) | const |
Get the depth (mm) of B-mode ultrasound
Definition at line 87 of file vtkPlusUsImagingParameters.cxx.
double vtkPlusUsImagingParameters::GetDepthMm | ( | ) | const |
Definition at line 93 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetDynRangeDb | ( | double & | aDynRangeDb | ) | const |
Get the DynRange (dB) of B-mode ultrasound
Definition at line 259 of file vtkPlusUsImagingParameters.cxx.
double vtkPlusUsImagingParameters::GetDynRangeDb | ( | ) | const |
Definition at line 265 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetFocusDepthPercent | ( | double & | aFocusDepthPercent | ) | const |
Get the focus depth (normalized [0,1]) of B-mode ultrasound
Definition at line 107 of file vtkPlusUsImagingParameters.cxx.
double vtkPlusUsImagingParameters::GetFocusDepthPercent | ( | ) | const |
Definition at line 113 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetFrequencyMhz | ( | double & | aFrequencyMhz | ) | const |
Get ultrasound transmitter frequency (MHz)
Definition at line 67 of file vtkPlusUsImagingParameters.cxx.
double vtkPlusUsImagingParameters::GetFrequencyMhz | ( | ) | const |
Definition at line 73 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetGainPercent | ( | double | aGainPercent | ) | const |
Get the Gain (%) of B-mode ultrasound; valid range: 0-100
Definition at line 127 of file vtkPlusUsImagingParameters.cxx.
double vtkPlusUsImagingParameters::GetGainPercent | ( | ) | const |
Definition at line 133 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetImageSize | ( | FrameSizeType & | imageSize | ) | const |
Get the image size of B-mode ultrasound
Definition at line 377 of file vtkPlusUsImagingParameters.cxx.
FrameSizeType vtkPlusUsImagingParameters::GetImageSize | ( | ) | const |
Definition at line 411 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetIntensity | ( | double & | aIntensity | ) | const |
Get the Intensity of B-mode ultrasound
Definition at line 199 of file vtkPlusUsImagingParameters.cxx.
double vtkPlusUsImagingParameters::GetIntensity | ( | ) | const |
Definition at line 205 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetPowerDb | ( | double & | aPower | ) | const |
Get the Power of B-mode ultrasound
Definition at line 239 of file vtkPlusUsImagingParameters.cxx.
double vtkPlusUsImagingParameters::GetPowerDb | ( | ) | const |
Definition at line 245 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetProbeVoltage | ( | float & | aVoltage | ) | const |
Get the voltage of ultrasound probe (depends on an ultrasound system)
Definition at line 339 of file vtkPlusUsImagingParameters.cxx.
float vtkPlusUsImagingParameters::GetProbeVoltage | ( | ) | const |
Definition at line 345 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetSectorPercent | ( | double & | aSectorPercent | ) | const |
Get the Sector (%) of B-mode ultrasound; valid range: 0-100
Definition at line 299 of file vtkPlusUsImagingParameters.cxx.
double vtkPlusUsImagingParameters::GetSectorPercent | ( | ) | const |
Definition at line 305 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::GetSoundVelocity | ( | float & | aSoundVelocity | ) | const |
Get the Sector (%) of B-mode ultrasound; valid range: 0-100
Definition at line 319 of file vtkPlusUsImagingParameters.cxx.
float vtkPlusUsImagingParameters::GetSoundVelocity | ( | ) | const |
Definition at line 325 of file vtkPlusUsImagingParameters.cxx.
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 164 of file vtkPlusUsImagingParameters.cxx.
std::vector< double > vtkPlusUsImagingParameters::GetTimeGainCompensation | ( | ) | const |
Definition at line 185 of file vtkPlusUsImagingParameters.cxx.
|
inlineoverrideprotectedvirtual |
Reimplemented from vtkPlusParameters.
Definition at line 218 of file vtkPlusUsImagingParameters.h.
PlusStatus vtkPlusUsImagingParameters::GetZoomFactor | ( | double & | aZoomFactor | ) | const |
Get the Zoom (%) of B-mode ultrasound; valid range: 0-100
Definition at line 279 of file vtkPlusUsImagingParameters.cxx.
double vtkPlusUsImagingParameters::GetZoomFactor | ( | ) | const |
Definition at line 285 of file vtkPlusUsImagingParameters.cxx.
|
virtual |
Reimplemented from vtkPlusParameters.
|
static |
|
static |
|
static |
PlusStatus vtkPlusUsImagingParameters::SetContrast | ( | double | aContrast | ) |
Set the contrast of B-mode ultrasound
Definition at line 213 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetDepthMm | ( | double | aDepthMm | ) |
Set the depth (mm) of B-mode ultrasound
Definition at line 81 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetDynRangeDb | ( | double | aDynRangeDb | ) |
Set the DynRange (dB) of B-mode ultrasound
Definition at line 253 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetFocusDepthPercent | ( | double | aFocusDepthPercent | ) |
Set the focus depth (normalized [0,1]) of B-mode ultrasound
Definition at line 101 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetFrequencyMhz | ( | double | aFrequencyMhz | ) |
Set ultrasound transmitter frequency (MHz)
Definition at line 61 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetGainPercent | ( | double | aGainPercent | ) |
Set the Gain (%) of B-mode ultrasound; valid range: 0-100
Definition at line 121 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetImageSize | ( | const FrameSizeType & | imageSize | ) |
Set the image size [width, height, depth(elevational dimension)] of the B-mode ultrasound
Definition at line 353 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetImageSize | ( | unsigned int | x, |
unsigned int | y, | ||
unsigned int | z | ||
) |
Definition at line 370 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetIntensity | ( | double | aIntensity | ) |
Set the intensity of B-mode ultrasound
Definition at line 193 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetPowerDb | ( | double | aPower | ) |
Set the power of B-mode ultrasound
Definition at line 233 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetProbeVoltage | ( | float | aVoltage | ) |
Set the voltage of ultrasound probe (depends on an ultrasound system)
Definition at line 333 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetSectorPercent | ( | double | aSectorPercent | ) |
Set the Sector (%) of B-mode ultrasound; valid range: 0-100
Definition at line 293 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetSoundVelocity | ( | float | aSoundVelocity | ) |
Set the Sector (%) of B-mode ultrasound; valid range: 0-100
Definition at line 313 of file vtkPlusUsImagingParameters.cxx.
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 141 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetTimeGainCompensation | ( | double * | tgc, |
int | length | ||
) |
Definition at line 157 of file vtkPlusUsImagingParameters.cxx.
PlusStatus vtkPlusUsImagingParameters::SetZoomFactor | ( | double | aZoomFactor | ) |
Set the Zoom (%) of B-mode ultrasound; valid range: 0-100
Definition at line 273 of file vtkPlusUsImagingParameters.cxx.
|
static |
Definition at line 54 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 48 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 50 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 49 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 47 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 51 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 60 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 53 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 55 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 56 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 58 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 52 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 59 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 57 of file vtkPlusUsImagingParameters.h.
|
protected |
Definition at line 220 of file vtkPlusUsImagingParameters.h.
|
static |
Definition at line 46 of file vtkPlusUsImagingParameters.h.