Medical Imaging Interaction Toolkit  2021.02.99-b9f34b51
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

◆ ~USTelemedBModeControls()

virtual mitk::USTelemedBModeControls::~USTelemedBModeControls ( )
protectedvirtual

Member Function Documentation

◆ CreateControls()

void mitk::USTelemedBModeControls::CreateControls ( )
protected

◆ GetIsActive()

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

Implements mitk::USAbstractControlInterface.

◆ GetScanningDepth()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningDepthValues()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningDynamicRange()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningDynamicRangeMax()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningDynamicRangeMin()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningDynamicRangeTick()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningFrequency()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningFrequencyAPI()

double mitk::USTelemedBModeControls::GetScanningFrequencyAPI ( )
protected

◆ GetScanningFrequencyValues()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningGain()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningGainMax()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningGainMin()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningGainTick()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningPower()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningPowerMax()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningPowerMin()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningPowerTick()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningRejection()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningRejectionMax()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningRejectionMin()

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

Implements mitk::USControlInterfaceBMode.

◆ GetScanningRejectionTick()

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

Implements mitk::USControlInterfaceBMode.

◆ mitkClassMacro()

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

◆ mitkNewMacro1Param()

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

◆ OnSetScanningDepth()

virtual 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.

◆ OnSetScanningDynamicRange()

virtual 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.

◆ OnSetScanningFrequency()

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

Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningFrequency.

Implements mitk::USControlInterfaceBMode.

◆ OnSetScanningGain()

virtual 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.

◆ OnSetScanningPower()

virtual 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.

◆ OnSetScanningRejection()

virtual 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.

◆ ReinitializeControls()

void mitk::USTelemedBModeControls::ReinitializeControls ( )

◆ ReleaseControls()

void mitk::USTelemedBModeControls::ReleaseControls ( )
protected

◆ SetIsActive()

virtual void mitk::USTelemedBModeControls::SetIsActive ( bool  )
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.

◆ SetUsgDataView()

void mitk::USTelemedBModeControls::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.

Member Data Documentation

◆ m_Active

bool mitk::USTelemedBModeControls::m_Active
protected

Definition at line 102 of file mitkUSTelemedBModeControls.h.

◆ m_DepthControl

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

Definition at line 97 of file mitkUSTelemedBModeControls.h.

◆ m_DynamicRangeControl

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

Definition at line 100 of file mitkUSTelemedBModeControls.h.

◆ m_DynamicRangeSteps

double* mitk::USTelemedBModeControls::m_DynamicRangeSteps
protected

Definition at line 107 of file mitkUSTelemedBModeControls.h.

◆ m_FrequencyControl

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

Definition at line 96 of file mitkUSTelemedBModeControls.h.

◆ m_GainControl

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

Definition at line 98 of file mitkUSTelemedBModeControls.h.

◆ m_GainSteps

double* mitk::USTelemedBModeControls::m_GainSteps
protected

Definition at line 105 of file mitkUSTelemedBModeControls.h.

◆ m_PowerControl

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

Definition at line 95 of file mitkUSTelemedBModeControls.h.

◆ m_PowerSteps

double* mitk::USTelemedBModeControls::m_PowerSteps
protected

Definition at line 104 of file mitkUSTelemedBModeControls.h.

◆ m_RejectionControl

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

Definition at line 99 of file mitkUSTelemedBModeControls.h.

◆ m_RejectionSteps

double* mitk::USTelemedBModeControls::m_RejectionSteps
protected

Definition at line 106 of file mitkUSTelemedBModeControls.h.

◆ m_UsgDataView

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

Definition at line 94 of file mitkUSTelemedBModeControls.h.


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