Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
mitkUSTelemedBModeControls.h
Go to the documentation of this file.
1 /*============================================================================
2 
3 The Medical Imaging Interaction Toolkit (MITK)
4 
5 Copyright (c) German Cancer Research Center (DKFZ)
6 All rights reserved.
7 
8 Use of this source code is governed by a 3-clause BSD license that can be
9 found in the LICENSE file.
10 
11 ============================================================================*/
12 
13 #ifndef mitkUSTelemedBModeControls_h
14 #define mitkUSTelemedBModeControls_h
15 
16 #include "mitkUSTelemedSDKHeader.h"
18 
19 #include <itkObjectFactory.h>
20 
21 namespace mitk {
22  class USTelemedDevice;
23 
29  {
30  public:
33 
38  virtual void SetIsActive( bool );
39 
43  virtual bool GetIsActive( );
44 
45  virtual double GetScanningFrequency( );
46  virtual void OnSetScanningFrequency( double frequency );
47  virtual std::vector<double> GetScanningFrequencyValues( );
48 
49  virtual double GetScanningPower( );
50  virtual void OnSetScanningPower( double power );
51  virtual double GetScanningPowerMin( );
52  virtual double GetScanningPowerMax( );
53  virtual double GetScanningPowerTick( );
54 
55  virtual double GetScanningDepth( );
56  virtual void OnSetScanningDepth( double );
57  virtual std::vector<double> GetScanningDepthValues( );
58 
59  virtual double GetScanningGain( );
60  virtual void OnSetScanningGain( double );
61  virtual double GetScanningGainMin( );
62  virtual double GetScanningGainMax( );
63  virtual double GetScanningGainTick( );
64 
65  virtual double GetScanningRejection( );
66  virtual void OnSetScanningRejection( double );
67  virtual double GetScanningRejectionMin( );
68  virtual double GetScanningRejectionMax( );
69  virtual double GetScanningRejectionTick( );
70 
71  virtual double GetScanningDynamicRange( );
72  virtual void OnSetScanningDynamicRange( double );
73  virtual double GetScanningDynamicRangeMin( );
74  virtual double GetScanningDynamicRangeMax( );
75  virtual double GetScanningDynamicRangeTick( );
76 
81  void SetUsgDataView( Usgfw2Lib::IUsgDataView* );
82 
83  void ReinitializeControls( );
84 
85  protected:
87  virtual ~USTelemedBModeControls();
88 
89  void CreateControls( );
90  void ReleaseControls( );
91 
92  double GetScanningFrequencyAPI( );
93 
94  Usgfw2Lib::IUsgDataView* m_UsgDataView; // main SDK object for comminucating with the Telemed API
95  Usgfw2Lib::IUsgPower* m_PowerControl; // control for scanning power
96  Usgfw2Lib::IUsgProbeFrequency2* m_FrequencyControl; // control for scanning frequency
97  Usgfw2Lib::IUsgDepth* m_DepthControl; // control for B mode scanning depth
98  Usgfw2Lib::IUsgGain* m_GainControl; // control for B mode scanning gain
99  Usgfw2Lib::IUsgRejection2* m_RejectionControl; // control for B mode scanning rejection
100  Usgfw2Lib::IUsgDynamicRange* m_DynamicRangeControl; // control for B mode dynamic range
101 
102  bool m_Active;
103 
104  double* m_PowerSteps; // array holding possible power values: [min, max, tick]
105  double* m_GainSteps; // array holding possible gains: [min, max, tick]
106  double* m_RejectionSteps; // array holding possible rejections: [min, max, tick]
107  double* m_DynamicRangeSteps; // array holding possible dynamic range values: [min, max, tick]
108  };
109 } // namespace mitk
110 
111 #endif
mitk::USTelemedBModeControls::m_DynamicRangeSteps
double * m_DynamicRangeSteps
Definition: mitkUSTelemedBModeControls.h:107
mitk::USTelemedBModeControls::ReinitializeControls
void ReinitializeControls()
mitk::USTelemedBModeControls::m_RejectionSteps
double * m_RejectionSteps
Definition: mitkUSTelemedBModeControls.h:106
mitkUSTelemedSDKHeader.h
mitk::USTelemedBModeControls::GetScanningDynamicRange
virtual double GetScanningDynamicRange()
mitk::USTelemedBModeControls::GetScanningDepthValues
virtual std::vector< double > GetScanningDepthValues()
mitk::USTelemedBModeControls::GetScanningRejectionMin
virtual double GetScanningRejectionMin()
mitk::USTelemedBModeControls::GetScanningDynamicRangeMin
virtual double GetScanningDynamicRangeMin()
mitk::USTelemedBModeControls::GetScanningGainMin
virtual double GetScanningGainMin()
mitk::USTelemedBModeControls
Implementation of mitk::USControlInterfaceBMode for Telemed ultrasound devices. See documentation of ...
Definition: mitkUSTelemedBModeControls.h:28
mitk::USTelemedBModeControls::OnSetScanningPower
virtual void OnSetScanningPower(double power)
Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningPower....
mitk::USTelemedBModeControls::USTelemedBModeControls
USTelemedBModeControls(itk::SmartPointer< USTelemedDevice > device)
mitk::USTelemedBModeControls::OnSetScanningGain
virtual void OnSetScanningGain(double)
Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningGain....
mitk::USTelemedBModeControls::SetIsActive
virtual void SetIsActive(bool)
mitk::USTelemedBModeControls::m_Active
bool m_Active
Definition: mitkUSTelemedBModeControls.h:102
mitk::USTelemedBModeControls::OnSetScanningDepth
virtual void OnSetScanningDepth(double)
Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningDepth....
mitk::USTelemedBModeControls::GetScanningPower
virtual double GetScanningPower()
mitk::USTelemedBModeControls::GetScanningDynamicRangeTick
virtual double GetScanningDynamicRangeTick()
itk::SmartPointer
Definition: mitkIFileReader.h:30
mitk::USTelemedBModeControls::SetUsgDataView
void SetUsgDataView(Usgfw2Lib::IUsgDataView *)
Setter for the IUsgDataView necesary for communicating with the Telemed API. This method is just for ...
mitk::USTelemedBModeControls::m_PowerControl
Usgfw2Lib::IUsgPower * m_PowerControl
Definition: mitkUSTelemedBModeControls.h:95
mitk::USTelemedBModeControls::m_DynamicRangeControl
Usgfw2Lib::IUsgDynamicRange * m_DynamicRangeControl
Definition: mitkUSTelemedBModeControls.h:100
mitk::USTelemedBModeControls::GetScanningDynamicRangeMax
virtual double GetScanningDynamicRangeMax()
mitkUSControlInterfaceBMode.h
mitk::USTelemedBModeControls::GetScanningDepth
virtual double GetScanningDepth()
mitk::USTelemedBModeControls::GetScanningRejectionTick
virtual double GetScanningRejectionTick()
mitk::USTelemedBModeControls::ReleaseControls
void ReleaseControls()
mitk::USTelemedBModeControls::mitkClassMacro
mitkClassMacro(USTelemedBModeControls, USControlInterfaceBMode)
mitk::USTelemedBModeControls::mitkNewMacro1Param
mitkNewMacro1Param(Self, itk::SmartPointer< USTelemedDevice >)
mitk::USTelemedBModeControls::GetScanningFrequencyAPI
double GetScanningFrequencyAPI()
mitk
DataCollection - Class to facilitate loading/accessing structured data.
Definition: RenderingTests.dox:1
mitk::USTelemedBModeControls::GetScanningGainMax
virtual double GetScanningGainMax()
mitk::USTelemedBModeControls::m_UsgDataView
Usgfw2Lib::IUsgDataView * m_UsgDataView
Definition: mitkUSTelemedBModeControls.h:94
mitk::USTelemedBModeControls::m_PowerSteps
double * m_PowerSteps
Definition: mitkUSTelemedBModeControls.h:104
mitk::USTelemedBModeControls::m_DepthControl
Usgfw2Lib::IUsgDepth * m_DepthControl
Definition: mitkUSTelemedBModeControls.h:97
mitk::USTelemedBModeControls::GetScanningPowerTick
virtual double GetScanningPowerTick()
mitk::USTelemedBModeControls::GetIsActive
virtual bool GetIsActive()
mitk::USTelemedBModeControls::m_RejectionControl
Usgfw2Lib::IUsgRejection2 * m_RejectionControl
Definition: mitkUSTelemedBModeControls.h:99
mitk::USTelemedBModeControls::OnSetScanningDynamicRange
virtual void OnSetScanningDynamicRange(double)
Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningDynamicRange....
mitk::USTelemedBModeControls::GetScanningPowerMax
virtual double GetScanningPowerMax()
mitk::USTelemedBModeControls::GetScanningGainTick
virtual double GetScanningGainTick()
mitk::USTelemedBModeControls::~USTelemedBModeControls
virtual ~USTelemedBModeControls()
mitk::USTelemedBModeControls::GetScanningFrequency
virtual double GetScanningFrequency()
mitk::USTelemedBModeControls::m_GainControl
Usgfw2Lib::IUsgGain * m_GainControl
Definition: mitkUSTelemedBModeControls.h:98
mitk::USTelemedBModeControls::GetScanningGain
virtual double GetScanningGain()
mitk::USTelemedBModeControls::CreateControls
void CreateControls()
mitk::USTelemedBModeControls::OnSetScanningRejection
virtual void OnSetScanningRejection(double)
Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningRejection....
mitk::USControlInterfaceBMode
Interface defining methods for scanning mode b of ultrasound devices. It consists of methods for scan...
Definition: mitkUSControlInterfaceBMode.h:52
mitk::USTelemedBModeControls::OnSetScanningFrequency
virtual void OnSetScanningFrequency(double frequency)
Virtual method which is called inside mitk::USControlInterfaceBMode::SetScanningFrequency.
mitk::USTelemedBModeControls::GetScanningRejectionMax
virtual double GetScanningRejectionMax()
mitk::USTelemedBModeControls::GetScanningRejection
virtual double GetScanningRejection()
mitk::USTelemedBModeControls::GetScanningPowerMin
virtual double GetScanningPowerMin()
mitk::USTelemedBModeControls::m_GainSteps
double * m_GainSteps
Definition: mitkUSTelemedBModeControls.h:105
mitk::USTelemedBModeControls::GetScanningFrequencyValues
virtual std::vector< double > GetScanningFrequencyValues()
mitk::USTelemedBModeControls::m_FrequencyControl
Usgfw2Lib::IUsgProbeFrequency2 * m_FrequencyControl
Definition: mitkUSTelemedBModeControls.h:96