Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::USTelemedBModeControls Class Reference

Implementation of mitk::USControlInterfaceBMode for Telemed ultrasound devices. See documentation of mitk::USControlInterfaceBMode for a description of the interface methods. More...

#include <mitkUSTelemedBModeControls.h>

Inheritance diagram for mitk::USTelemedBModeControls:
Collaboration diagram for mitk::USTelemedBModeControls:

Public Member Functions

 mitkClassMacro (USTelemedBModeControls, USControlInterfaceBMode)
 
 mitkNewMacro1Param (Self, itk::SmartPointer< USTelemedDevice >)
 
virtual void SetIsActive (bool)
 
virtual bool GetIsActive ()
 
virtual double GetScanningFrequency ()
 
virtual void OnSetScanningFrequency (double frequency)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningFrequency. More...
 
virtual std::vector< double > GetScanningFrequencyValues ()
 
virtual double GetScanningPower ()
 
virtual void OnSetScanningPower (double power)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningPower. Implement this method to handle the actual setting of the value at the device api. More...
 
virtual double GetScanningPowerMin ()
 
virtual double GetScanningPowerMax ()
 
virtual double GetScanningPowerTick ()
 
virtual double GetScanningDepth ()
 
virtual void OnSetScanningDepth (double)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningDepth. Implement this method to handle the actual setting of the value at the device api. More...
 
virtual std::vector< double > GetScanningDepthValues ()
 
virtual double GetScanningGain ()
 
virtual void OnSetScanningGain (double)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningGain. Implement this method to handle the actual setting of the value at the device api. More...
 
virtual double GetScanningGainMin ()
 
virtual double GetScanningGainMax ()
 
virtual double GetScanningGainTick ()
 
virtual double GetScanningRejection ()
 
virtual void OnSetScanningRejection (double)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningRejection. Implement this method to handle the actual setting of the value at the device api. More...
 
virtual double GetScanningRejectionMin ()
 
virtual double GetScanningRejectionMax ()
 
virtual double GetScanningRejectionTick ()
 
virtual double GetScanningDynamicRange ()
 
virtual void OnSetScanningDynamicRange (double)
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningDynamicRange. Implement this method to handle the actual setting of the value at the device api. More...
 
virtual double GetScanningDynamicRangeMin ()
 
virtual double GetScanningDynamicRangeMax ()
 
virtual double GetScanningDynamicRangeTick ()
 
void SetUsgDataView (Usgfw2Lib::IUsgDataView *)
 Setter for the IUsgDataView necesary for communicating with the Telemed API. This method is just for internal use of the mitk::USTelemedDevice. More...
 
void ReinitializeControls ()
 
- Public Member Functions inherited from mitk::USControlInterfaceBMode
 mitkClassMacro (USControlInterfaceBMode, USAbstractControlInterface)
 
void Initialize ()
 Initializes the microservice properties with the current values from the device. This method must be called before one would like to get the b mode values (e.g. frequency, power, ...) from the microservice and after the device is ready to deliver the values by the methods of this control interface. More...
 
void SetScanningFrequency (double frequency)
 
void SetScanningPower (double power)
 
void SetScanningDepth (double depth)
 
void SetScanningGain (double gain)
 
void SetScanningRejection (double rejection)
 
virtual void SetScanningDynamicRange (double dynamicRange)
 
- Public Member Functions inherited from mitk::USAbstractControlInterface
 mitkClassMacroItkParent (USAbstractControlInterface, itk::Object)
 

Protected Member Functions

 USTelemedBModeControls (itk::SmartPointer< USTelemedDevice > device)
 
virtual ~USTelemedBModeControls ()
 
void CreateControls ()
 
void ReleaseControls ()
 
double GetScanningFrequencyAPI ()
 
- Protected Member Functions inherited from mitk::USControlInterfaceBMode
 USControlInterfaceBMode (itk::SmartPointer< USDevice > device)
 
 ~USControlInterfaceBMode () override
 
- Protected Member Functions inherited from mitk::USAbstractControlInterface
 USAbstractControlInterface (itk::SmartPointer< USDevice > device)
 
 ~USAbstractControlInterface () override
 

Protected Attributes

Usgfw2Lib::IUsgDataView * m_UsgDataView
 
Usgfw2Lib::IUsgPower * m_PowerControl
 
Usgfw2Lib::IUsgProbeFrequency2 * m_FrequencyControl
 
Usgfw2Lib::IUsgDepth * m_DepthControl
 
Usgfw2Lib::IUsgGain * m_GainControl
 
Usgfw2Lib::IUsgRejection2 * m_RejectionControl
 
Usgfw2Lib::IUsgDynamicRange * m_DynamicRangeControl
 
bool m_Active
 
double * m_PowerSteps
 
double * m_GainSteps
 
double * m_RejectionSteps
 
double * m_DynamicRangeSteps
 
- Protected Attributes inherited from mitk::USAbstractControlInterface
itk::WeakPointer< USDevicem_Device
 

Detailed Description

Implementation of mitk::USControlInterfaceBMode for Telemed ultrasound devices. See documentation of mitk::USControlInterfaceBMode for a description of the interface methods.

Definition at line 28 of file mitkUSTelemedBModeControls.h.

Constructor & Destructor Documentation

◆ USTelemedBModeControls()

mitk::USTelemedBModeControls::USTelemedBModeControls ( itk::SmartPointer< USTelemedDevice device)
protected

Definition at line 19 of file mitkUSTelemedBModeControls.cpp.

◆ ~USTelemedBModeControls()

mitk::USTelemedBModeControls::~USTelemedBModeControls ( )
protectedvirtual

Member Function Documentation

◆ CreateControls()

◆ GetIsActive()

bool mitk::USTelemedBModeControls::GetIsActive ( )
virtual
Returns
true if API controls are created and scan mode is set to b mode

Implements mitk::USAbstractControlInterface.

Definition at line 77 of file mitkUSTelemedBModeControls.cpp.

References m_Active, m_UsgDataView, and mitkThrow.

◆ GetScanningDepth()

double mitk::USTelemedBModeControls::GetScanningDepth ( )
virtual
Returns
current depth value

Implements mitk::USControlInterfaceBMode.

Definition at line 133 of file mitkUSTelemedBModeControls.cpp.

References m_DepthControl, and RETURN_TelemedValue.

◆ GetScanningDepthValues()

std::vector< double > mitk::USTelemedBModeControls::GetScanningDepthValues ( )
virtual
Returns
vector of all possible depth values for the utrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 143 of file mitkUSTelemedBModeControls.cpp.

References m_DepthControl, and RETURN_TelemedAvailableValues.

◆ GetScanningDynamicRange()

double mitk::USTelemedBModeControls::GetScanningDynamicRange ( )
virtual
Returns
current scanning dynamic range

Implements mitk::USControlInterfaceBMode.

Definition at line 198 of file mitkUSTelemedBModeControls.cpp.

References m_DynamicRangeControl, and RETURN_TelemedValue.

◆ GetScanningDynamicRangeMax()

double mitk::USTelemedBModeControls::GetScanningDynamicRangeMax ( )
virtual
Returns
maximum dynamic range value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 213 of file mitkUSTelemedBModeControls.cpp.

References m_DynamicRangeSteps.

◆ GetScanningDynamicRangeMin()

double mitk::USTelemedBModeControls::GetScanningDynamicRangeMin ( )
virtual
Returns
minimum dynamic range value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 208 of file mitkUSTelemedBModeControls.cpp.

References m_DynamicRangeSteps.

◆ GetScanningDynamicRangeTick()

double mitk::USTelemedBModeControls::GetScanningDynamicRangeTick ( )
virtual
Returns
interval between two dynamic range values for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 218 of file mitkUSTelemedBModeControls.cpp.

References m_DynamicRangeSteps.

◆ GetScanningFrequency()

double mitk::USTelemedBModeControls::GetScanningFrequency ( )
virtual
Returns
current frequency value

Implements mitk::USControlInterfaceBMode.

Definition at line 93 of file mitkUSTelemedBModeControls.cpp.

References GetScanningFrequencyAPI(), and TELEMED_FREQUENCY_FACTOR.

◆ GetScanningFrequencyAPI()

double mitk::USTelemedBModeControls::GetScanningFrequencyAPI ( )
protected

Definition at line 88 of file mitkUSTelemedBModeControls.cpp.

References m_FrequencyControl, and RETURN_TelemedValue.

Referenced by GetScanningFrequency().

◆ GetScanningFrequencyValues()

std::vector< double > mitk::USTelemedBModeControls::GetScanningFrequencyValues ( )
virtual
Returns
vector of all possible frequency values for the utrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 103 of file mitkUSTelemedBModeControls.cpp.

References m_FrequencyControl, RETURN_TelemedAvailableValuesWithFactor, and TELEMED_FREQUENCY_FACTOR.

◆ GetScanningGain()

double mitk::USTelemedBModeControls::GetScanningGain ( )
virtual
Returns
current scanning gain

Implements mitk::USControlInterfaceBMode.

Definition at line 148 of file mitkUSTelemedBModeControls.cpp.

References m_GainControl, and RETURN_TelemedValue.

◆ GetScanningGainMax()

double mitk::USTelemedBModeControls::GetScanningGainMax ( )
virtual
Returns
maximum gain value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 163 of file mitkUSTelemedBModeControls.cpp.

References m_GainSteps.

◆ GetScanningGainMin()

double mitk::USTelemedBModeControls::GetScanningGainMin ( )
virtual
Returns
minimum gain value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 158 of file mitkUSTelemedBModeControls.cpp.

References m_GainSteps.

◆ GetScanningGainTick()

double mitk::USTelemedBModeControls::GetScanningGainTick ( )
virtual
Returns
interval between two gain values for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 168 of file mitkUSTelemedBModeControls.cpp.

References m_GainSteps.

◆ GetScanningPower()

double mitk::USTelemedBModeControls::GetScanningPower ( )
virtual
Returns
current power value

Implements mitk::USControlInterfaceBMode.

Definition at line 108 of file mitkUSTelemedBModeControls.cpp.

References m_PowerControl, and RETURN_TelemedValue.

◆ GetScanningPowerMax()

double mitk::USTelemedBModeControls::GetScanningPowerMax ( )
virtual
Returns
maximum power value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 123 of file mitkUSTelemedBModeControls.cpp.

References m_PowerSteps.

◆ GetScanningPowerMin()

double mitk::USTelemedBModeControls::GetScanningPowerMin ( )
virtual
Returns
minimum power value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 118 of file mitkUSTelemedBModeControls.cpp.

References m_PowerSteps.

◆ GetScanningPowerTick()

double mitk::USTelemedBModeControls::GetScanningPowerTick ( )
virtual
Returns
interval between two power values for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 128 of file mitkUSTelemedBModeControls.cpp.

References m_PowerSteps.

◆ GetScanningRejection()

double mitk::USTelemedBModeControls::GetScanningRejection ( )
virtual
Returns
current scanning rejection

Implements mitk::USControlInterfaceBMode.

Definition at line 173 of file mitkUSTelemedBModeControls.cpp.

References m_RejectionControl, and RETURN_TelemedValue.

◆ GetScanningRejectionMax()

double mitk::USTelemedBModeControls::GetScanningRejectionMax ( )
virtual
Returns
maximum rejection value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 188 of file mitkUSTelemedBModeControls.cpp.

References m_RejectionSteps.

◆ GetScanningRejectionMin()

double mitk::USTelemedBModeControls::GetScanningRejectionMin ( )
virtual
Returns
minimum rejection value for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 183 of file mitkUSTelemedBModeControls.cpp.

References m_RejectionSteps.

◆ GetScanningRejectionTick()

double mitk::USTelemedBModeControls::GetScanningRejectionTick ( )
virtual
Returns
interval between two rejection values for the ultrasound device

Implements mitk::USControlInterfaceBMode.

Definition at line 193 of file mitkUSTelemedBModeControls.cpp.

References m_RejectionSteps.

◆ mitkClassMacro()

mitk::USTelemedBModeControls::mitkClassMacro ( USTelemedBModeControls  ,
USControlInterfaceBMode   
)

◆ mitkNewMacro1Param()

mitk::USTelemedBModeControls::mitkNewMacro1Param ( Self  ,
itk::SmartPointer< USTelemedDevice  
)

◆ OnSetScanningDepth()

void mitk::USTelemedBModeControls::OnSetScanningDepth ( double  depth)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningDepth. Implement this method to handle the actual setting of the value at the device api.

Implements mitk::USControlInterfaceBMode.

Definition at line 138 of file mitkUSTelemedBModeControls.cpp.

References m_DepthControl, and SET_TelemedValue.

◆ OnSetScanningDynamicRange()

void mitk::USTelemedBModeControls::OnSetScanningDynamicRange ( double  dynamicRange)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningDynamicRange. Implement this method to handle the actual setting of the value at the device api.

Implements mitk::USControlInterfaceBMode.

Definition at line 203 of file mitkUSTelemedBModeControls.cpp.

References m_DynamicRangeControl, and SET_TelemedValue.

◆ OnSetScanningFrequency()

void mitk::USTelemedBModeControls::OnSetScanningFrequency ( double  frequency)
virtual

◆ OnSetScanningGain()

void mitk::USTelemedBModeControls::OnSetScanningGain ( double  gain)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningGain. Implement this method to handle the actual setting of the value at the device api.

Implements mitk::USControlInterfaceBMode.

Definition at line 153 of file mitkUSTelemedBModeControls.cpp.

References m_GainControl, and SET_TelemedValue.

◆ OnSetScanningPower()

void mitk::USTelemedBModeControls::OnSetScanningPower ( double  power)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningPower. Implement this method to handle the actual setting of the value at the device api.

Implements mitk::USControlInterfaceBMode.

Definition at line 113 of file mitkUSTelemedBModeControls.cpp.

References m_PowerControl, and SET_TelemedValue.

◆ OnSetScanningRejection()

void mitk::USTelemedBModeControls::OnSetScanningRejection ( double  rejection)
virtual

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningRejection. Implement this method to handle the actual setting of the value at the device api.

Implements mitk::USControlInterfaceBMode.

Definition at line 178 of file mitkUSTelemedBModeControls.cpp.

References m_RejectionControl, and SET_TelemedValue.

◆ ReinitializeControls()

void mitk::USTelemedBModeControls::ReinitializeControls ( )

Definition at line 45 of file mitkUSTelemedBModeControls.cpp.

References CreateControls(), and ReleaseControls().

◆ ReleaseControls()

void mitk::USTelemedBModeControls::ReleaseControls ( )
protected

◆ SetIsActive()

void mitk::USTelemedBModeControls::SetIsActive ( bool  active)
virtual

Scan mode is set to b mode when this controls are activated. All necessary controls are created at the Telemed API.

Implements mitk::USAbstractControlInterface.

Definition at line 51 of file mitkUSTelemedBModeControls.cpp.

References CreateControls(), m_Active, m_UsgDataView, mitkThrow, and ReleaseControls().

◆ SetUsgDataView()

void mitk::USTelemedBModeControls::SetUsgDataView ( Usgfw2Lib::IUsgDataView *  usgDataView)

Setter for the IUsgDataView necesary for communicating with the Telemed API. This method is just for internal use of the mitk::USTelemedDevice.

Definition at line 40 of file mitkUSTelemedBModeControls.cpp.

References m_UsgDataView.

Member Data Documentation

◆ m_Active

bool mitk::USTelemedBModeControls::m_Active
protected

Definition at line 102 of file mitkUSTelemedBModeControls.h.

Referenced by GetIsActive(), and SetIsActive().

◆ m_DepthControl

Usgfw2Lib::IUsgDepth* mitk::USTelemedBModeControls::m_DepthControl
protected

◆ m_DynamicRangeControl

Usgfw2Lib::IUsgDynamicRange* mitk::USTelemedBModeControls::m_DynamicRangeControl
protected

◆ m_DynamicRangeSteps

double* mitk::USTelemedBModeControls::m_DynamicRangeSteps
protected

◆ m_FrequencyControl

Usgfw2Lib::IUsgProbeFrequency2* mitk::USTelemedBModeControls::m_FrequencyControl
protected

◆ m_GainControl

Usgfw2Lib::IUsgGain* mitk::USTelemedBModeControls::m_GainControl
protected

◆ m_GainSteps

double* mitk::USTelemedBModeControls::m_GainSteps
protected

◆ m_PowerControl

Usgfw2Lib::IUsgPower* mitk::USTelemedBModeControls::m_PowerControl
protected

◆ m_PowerSteps

double* mitk::USTelemedBModeControls::m_PowerSteps
protected

◆ m_RejectionControl

Usgfw2Lib::IUsgRejection2* mitk::USTelemedBModeControls::m_RejectionControl
protected

◆ m_RejectionSteps

double* mitk::USTelemedBModeControls::m_RejectionSteps
protected

◆ m_UsgDataView

Usgfw2Lib::IUsgDataView* mitk::USTelemedBModeControls::m_UsgDataView
protected

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