Medical Imaging Interaction Toolkit  2018.4.99-65942676
Medical Imaging Interaction Toolkit
mitk::USControlInterfaceBMode Class Referenceabstract

Interface defining methods for scanning mode b of ultrasound devices. It consists of methods for scanning depth, scanning gaing and scanning rejection. More...

#include <mitkUSControlInterfaceBMode.h>

Inheritance diagram for mitk::USControlInterfaceBMode:
Collaboration diagram for mitk::USControlInterfaceBMode:

Public Member Functions

 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...
 
virtual double GetScanningFrequency ()=0
 
void SetScanningFrequency (double frequency)
 
virtual void OnSetScanningFrequency (double frequency)=0
 Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningFrequency. More...
 
virtual std::vector< double > GetScanningFrequencyValues ()=0
 
virtual double GetScanningPower ()=0
 
void SetScanningPower (double power)
 
virtual void OnSetScanningPower (double power)=0
 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 ()=0
 
virtual double GetScanningPowerMax ()=0
 
virtual double GetScanningPowerTick ()=0
 
virtual double GetScanningDepth ()=0
 
void SetScanningDepth (double depth)
 
virtual void OnSetScanningDepth (double depth)=0
 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 ()=0
 
virtual double GetScanningGain ()=0
 
void SetScanningGain (double gain)
 
virtual void OnSetScanningGain (double gain)=0
 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 ()=0
 
virtual double GetScanningGainMax ()=0
 
virtual double GetScanningGainTick ()=0
 
virtual double GetScanningRejection ()=0
 
void SetScanningRejection (double rejection)
 
virtual void OnSetScanningRejection (double rejection)=0
 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 ()=0
 
virtual double GetScanningRejectionMax ()=0
 
virtual double GetScanningRejectionTick ()=0
 
virtual double GetScanningDynamicRange ()=0
 
virtual void SetScanningDynamicRange (double dynamicRange)
 
virtual void OnSetScanningDynamicRange (double dynamicRange)=0
 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 ()=0
 
virtual double GetScanningDynamicRangeMax ()=0
 
virtual double GetScanningDynamicRangeTick ()=0
 
- Public Member Functions inherited from mitk::USAbstractControlInterface
 mitkClassMacroItkParent (USAbstractControlInterface, itk::Object)
 
virtual void SetIsActive (bool isActive)=0
 
virtual bool GetIsActive ()=0
 

Protected Member Functions

 USControlInterfaceBMode (itk::SmartPointer< USDevice > device)
 
 ~USControlInterfaceBMode () override
 
- Protected Member Functions inherited from mitk::USAbstractControlInterface
 USAbstractControlInterface (itk::SmartPointer< USDevice > device)
 
 ~USAbstractControlInterface () override
 

Additional Inherited Members

- Protected Attributes inherited from mitk::USAbstractControlInterface
itk::WeakPointer< USDevicem_Device
 

Detailed Description

Interface defining methods for scanning mode b of ultrasound devices. It consists of methods for scanning depth, scanning gaing and scanning rejection.

Scanning Depth: Defines the clipping of the ultrasound image. Small depth for looking at structures just below the skin. Great depth for seeing deeper structures.

Scanning Gain: Defines amplification of ultrasound echo.

Scanning Rejection: Defines range of the received values from the ultrasound signal.

Scanning Dynamic Range: Ability of displaying strong and weak signals at the same time. High dynamic range means that strong and weak signals can be distinguished. Lower dynamic range can lead to more contrast.

There is a getter and a setter defined for each kind of value. Additionaly there are methods for getting the range of the possible values. For uniformly distributed values there are three methods Get<VALUE>Min(), Get<VALUE>Max() and Get<VALUE>Tick(). For non-uniformly distributed values there is one method Get<VALUE>Values() which shoule return a list of all possible values.

All getters of this interface must be implemented in a concrete subclass. Additionally all OnSet* methods must be implemented. They handle the acutal setting of the values at the device api. The Set* methods are already implemented in this class and should not be overwritten. There are some pure virtual methods in the superclass mitk::USAbstractControlInterface which must be implemented, too.

Definition at line 52 of file mitkUSControlInterfaceBMode.h.

Constructor & Destructor Documentation

◆ USControlInterfaceBMode()

mitk::USControlInterfaceBMode::USControlInterfaceBMode ( itk::SmartPointer< USDevice device)
protected

◆ ~USControlInterfaceBMode()

mitk::USControlInterfaceBMode::~USControlInterfaceBMode ( )
overrideprotected

Member Function Documentation

◆ GetScanningDepth()

virtual double mitk::USControlInterfaceBMode::GetScanningDepth ( )
pure virtual
Returns
current depth value

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningDepthValues()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningDynamicRange()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningDynamicRangeMax()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningDynamicRangeMin()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningDynamicRangeTick()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningFrequency()

virtual double mitk::USControlInterfaceBMode::GetScanningFrequency ( )
pure virtual
Returns
current frequency value

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningFrequencyValues()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningGain()

virtual double mitk::USControlInterfaceBMode::GetScanningGain ( )
pure virtual
Returns
current scanning gain

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningGainMax()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningGainMin()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningGainTick()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningPower()

virtual double mitk::USControlInterfaceBMode::GetScanningPower ( )
pure virtual
Returns
current power value

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningPowerMax()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningPowerMin()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningPowerTick()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningRejection()

virtual double mitk::USControlInterfaceBMode::GetScanningRejection ( )
pure virtual
Returns
current scanning rejection

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningRejectionMax()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningRejectionMin()

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

Implemented in mitk::USTelemedBModeControls.

◆ GetScanningRejectionTick()

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

Implemented in mitk::USTelemedBModeControls.

◆ Initialize()

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

◆ mitkClassMacro()

mitk::USControlInterfaceBMode::mitkClassMacro ( USControlInterfaceBMode  ,
USAbstractControlInterface   
)

◆ OnSetScanningDepth()

virtual void mitk::USControlInterfaceBMode::OnSetScanningDepth ( double  depth)
pure 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.

Implemented in mitk::USTelemedBModeControls.

◆ OnSetScanningDynamicRange()

virtual void mitk::USControlInterfaceBMode::OnSetScanningDynamicRange ( double  dynamicRange)
pure 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.

Implemented in mitk::USTelemedBModeControls.

◆ OnSetScanningFrequency()

virtual void mitk::USControlInterfaceBMode::OnSetScanningFrequency ( double  frequency)
pure virtual

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

Implemented in mitk::USTelemedBModeControls.

◆ OnSetScanningGain()

virtual void mitk::USControlInterfaceBMode::OnSetScanningGain ( double  gain)
pure 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.

Implemented in mitk::USTelemedBModeControls.

◆ OnSetScanningPower()

virtual void mitk::USControlInterfaceBMode::OnSetScanningPower ( double  power)
pure 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.

Implemented in mitk::USTelemedBModeControls.

◆ OnSetScanningRejection()

virtual void mitk::USControlInterfaceBMode::OnSetScanningRejection ( double  rejection)
pure 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.

Implemented in mitk::USTelemedBModeControls.

◆ SetScanningDepth()

void mitk::USControlInterfaceBMode::SetScanningDepth ( double  depth)
Parameters
depthnew depth value Do not override this method in a subclass. Implement mitk::USControlInterfaceBMode::OnSetScanningDepth instead.

◆ SetScanningDynamicRange()

virtual void mitk::USControlInterfaceBMode::SetScanningDynamicRange ( double  dynamicRange)
virtual
Parameters
rejectionnew dynamic range value Do not override this method in a subclass. Implement mitk::USControlInterfaceBMode::OnSetScanningDynamicRange instead.

◆ SetScanningFrequency()

void mitk::USControlInterfaceBMode::SetScanningFrequency ( double  frequency)
Parameters
depthnew frequency value Do not override this method in a subclass. Implement mitk::USControlInterfaceBMode::OnSetScanningFrequency instead.

◆ SetScanningGain()

void mitk::USControlInterfaceBMode::SetScanningGain ( double  gain)
Parameters
gainnew gain value Do not override this method in a subclass. Implement mitk::USControlInterfaceBMode::OnSetScanningGain instead.

◆ SetScanningPower()

void mitk::USControlInterfaceBMode::SetScanningPower ( double  power)
Parameters
depthnew power value Do not override this method in a subclass. Implement mitk::USControlInterfaceBMode::OnSetScanningPower instead.

◆ SetScanningRejection()

void mitk::USControlInterfaceBMode::SetScanningRejection ( double  rejection)
Parameters
rejectionnew rejection value Do not override this method in a subclass. Implement mitk::USControlInterfaceBMode::OnSetScanningRejection instead.

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