Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::USDiPhASDeviceCustomControls Class Reference

Custom controls for mitk::USDiPhASDevice. More...

#include <mitkUSDiPhASDeviceCustomControls.h>

Inheritance diagram for mitk::USDiPhASDeviceCustomControls:
Inheritance graph
[legend]
Collaboration diagram for mitk::USDiPhASDeviceCustomControls:
Collaboration graph
[legend]

Classes

struct  SavingSettings
 

Public Types

enum  DataType { Image_uChar, Beamformed_Short }
 

Public Member Functions

 mitkClassMacro (USDiPhASDeviceCustomControls, USAbstractControlInterface)
 
 mitkNewMacro1Param (Self, itk::SmartPointer< USDevice >)
 
void SetIsActive (bool isActive) override
 
bool GetIsActive () override
 
virtual void SetCompensateEnergy (bool compensate)
 
virtual void SetUseBModeFilter (bool isSet)
 
virtual void SetVerticalSpacing (float mm)
 
virtual void SetRecord (bool record)
 
virtual void SetScatteringCoefficient (float coeff)
 
virtual void SetCompensateScattering (bool compensate)
 
virtual void SetSavingSettings (SavingSettings settings)
 
virtual void SetTransmitPhaseLength (double us)
 
virtual void SetExcitationFrequency (double MHz)
 
virtual void SetTransmitEvents (int events)
 
virtual void SetVoltage (int voltage)
 
virtual void SetMode (bool interleaved)
 
virtual void SetScanDepth (double mm)
 
virtual void SetAveragingCount (int count)
 
virtual void SetTGCMin (int min)
 
virtual void SetTGCMax (int max)
 
virtual void SetDataType (DataType type)
 
virtual void SetPitch (double mm)
 
virtual void SetReconstructedSamples (int samples)
 
virtual void SetReconstructedLines (int lines)
 
virtual void SetSpeedOfSound (int mps)
 
virtual void SetBandpassEnabled (bool bandpass)
 
virtual void SetLowCut (double MHz)
 
virtual void SetHighCut (double MHz)
 
virtual void passGUIOut (std::function< void(QString)>)
 
virtual void SetSilentUpdate (bool silent)
 
virtual bool GetSilentUpdate ()
 
- Public Member Functions inherited from mitk::USAbstractControlInterface
 mitkClassMacroItkParent (USAbstractControlInterface, itk::Object)
 

Protected Member Functions

 USDiPhASDeviceCustomControls (itk::SmartPointer< USDevice > device)
 
 ~USDiPhASDeviceCustomControls () override
 
virtual void OnSetCompensateEnergy (bool)
 
virtual void OnSetSavingSettings (SavingSettings)
 
virtual void OnSetUseBModeFilter (bool)
 
virtual void OnSetRecord (bool)
 
virtual void OnSetVerticalSpacing (float)
 
virtual void OnSetScatteringCoefficient (float)
 
virtual void OnSetCompensateScattering (bool)
 
virtual void OnSetTransmitPhaseLength (double)
 
virtual void OnSetExcitationFrequency (double)
 
virtual void OnSetTransmitEvents (int)
 
virtual void OnSetVoltage (int)
 
virtual void OnSetMode (bool)
 
virtual void OnSetScanDepth (double)
 
virtual void OnSetAveragingCount (int)
 
virtual void OnSetTGCMin (int)
 
virtual void OnSetTGCMax (int)
 
virtual void OnSetDataType (DataType)
 
virtual void OnSetPitch (double)
 
virtual void OnSetReconstructedSamples (int)
 
virtual void OnSetReconstructedLines (int)
 
virtual void OnSetSpeedOfSound (int)
 
virtual void OnSetBandpassEnabled (bool)
 
virtual void OnSetLowCut (double)
 
virtual void OnSetHighCut (double)
 
- Protected Member Functions inherited from mitk::USAbstractControlInterface
 USAbstractControlInterface (itk::SmartPointer< USDevice > device)
 
 ~USAbstractControlInterface () override
 

Protected Attributes

bool m_IsActive
 
USImageVideoSource::Pointer m_ImageSource
 
bool silentUpdate
 
- Protected Attributes inherited from mitk::USAbstractControlInterface
itk::WeakPointer< USDevice > m_Device
 

Detailed Description

Custom controls for mitk::USDiPhASDevice.

Definition at line 29 of file mitkUSDiPhASDeviceCustomControls.h.

Member Enumeration Documentation

◆ DataType

enum mitk::USDiPhASDeviceCustomControls::DataType
Enumerator
Image_uChar 
Beamformed_Short 

Definition at line 41 of file mitkUSDiPhASDeviceCustomControls.h.

Constructor & Destructor Documentation

◆ USDiPhASDeviceCustomControls()

mitk::USDiPhASDeviceCustomControls::USDiPhASDeviceCustomControls ( itk::SmartPointer< USDevice >  device)
protected

Class needs an mitk::USDevice object for beeing constructed.

Definition at line 15 of file mitkUSDiPhASDeviceCustomControls.cpp.

◆ ~USDiPhASDeviceCustomControls()

mitk::USDiPhASDeviceCustomControls::~USDiPhASDeviceCustomControls ( )
overrideprotected

Definition at line 20 of file mitkUSDiPhASDeviceCustomControls.cpp.

Member Function Documentation

◆ GetIsActive()

bool mitk::USDiPhASDeviceCustomControls::GetIsActive ( )
overridevirtual
Returns
if this custom controls are currently activated

Implements mitk::USAbstractControlInterface.

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 29 of file mitkUSDiPhASDeviceCustomControls.cpp.

References m_IsActive.

◆ GetSilentUpdate()

bool mitk::USDiPhASDeviceCustomControls::GetSilentUpdate ( )
virtual

Definition at line 41 of file mitkUSDiPhASDeviceCustomControls.cpp.

References silentUpdate.

◆ mitkClassMacro()

mitk::USDiPhASDeviceCustomControls::mitkClassMacro ( USDiPhASDeviceCustomControls  ,
USAbstractControlInterface   
)

◆ mitkNewMacro1Param()

mitk::USDiPhASDeviceCustomControls::mitkNewMacro1Param ( Self  ,
itk::SmartPointer< USDevice >   
)

◆ OnSetAveragingCount()

void mitk::USDiPhASDeviceCustomControls::OnSetAveragingCount ( int  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 190 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetAveragingCount().

◆ OnSetBandpassEnabled()

void mitk::USDiPhASDeviceCustomControls::OnSetBandpassEnabled ( bool  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 200 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetBandpassEnabled().

◆ OnSetCompensateEnergy()

void mitk::USDiPhASDeviceCustomControls::OnSetCompensateEnergy ( bool  )
protectedvirtual

virtual handlers implemented in Device Controls

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 175 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetCompensateEnergy().

◆ OnSetCompensateScattering()

void mitk::USDiPhASDeviceCustomControls::OnSetCompensateScattering ( bool  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 180 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetCompensateScattering().

◆ OnSetDataType()

void mitk::USDiPhASDeviceCustomControls::OnSetDataType ( DataType  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 193 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetDataType().

◆ OnSetExcitationFrequency()

void mitk::USDiPhASDeviceCustomControls::OnSetExcitationFrequency ( double  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 184 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetExcitationFrequency().

◆ OnSetHighCut()

void mitk::USDiPhASDeviceCustomControls::OnSetHighCut ( double  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 202 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetHighCut().

◆ OnSetLowCut()

void mitk::USDiPhASDeviceCustomControls::OnSetLowCut ( double  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 201 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetLowCut().

◆ OnSetMode()

void mitk::USDiPhASDeviceCustomControls::OnSetMode ( bool  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 187 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetMode().

◆ OnSetPitch()

void mitk::USDiPhASDeviceCustomControls::OnSetPitch ( double  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 195 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetPitch().

◆ OnSetReconstructedLines()

void mitk::USDiPhASDeviceCustomControls::OnSetReconstructedLines ( int  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 197 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetReconstructedLines().

◆ OnSetReconstructedSamples()

void mitk::USDiPhASDeviceCustomControls::OnSetReconstructedSamples ( int  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 196 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetReconstructedSamples().

◆ OnSetRecord()

void mitk::USDiPhASDeviceCustomControls::OnSetRecord ( bool  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 177 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetRecord().

◆ OnSetSavingSettings()

void mitk::USDiPhASDeviceCustomControls::OnSetSavingSettings ( SavingSettings  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 181 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetSavingSettings().

◆ OnSetScanDepth()

void mitk::USDiPhASDeviceCustomControls::OnSetScanDepth ( double  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 189 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetScanDepth().

◆ OnSetScatteringCoefficient()

void mitk::USDiPhASDeviceCustomControls::OnSetScatteringCoefficient ( float  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 179 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetScatteringCoefficient().

◆ OnSetSpeedOfSound()

void mitk::USDiPhASDeviceCustomControls::OnSetSpeedOfSound ( int  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 198 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetSpeedOfSound().

◆ OnSetTGCMax()

void mitk::USDiPhASDeviceCustomControls::OnSetTGCMax ( int  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 192 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetTGCMax().

◆ OnSetTGCMin()

void mitk::USDiPhASDeviceCustomControls::OnSetTGCMin ( int  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 191 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetTGCMin().

◆ OnSetTransmitEvents()

void mitk::USDiPhASDeviceCustomControls::OnSetTransmitEvents ( int  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 185 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetTransmitEvents().

◆ OnSetTransmitPhaseLength()

void mitk::USDiPhASDeviceCustomControls::OnSetTransmitPhaseLength ( double  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 183 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetTransmitPhaseLength().

◆ OnSetUseBModeFilter()

void mitk::USDiPhASDeviceCustomControls::OnSetUseBModeFilter ( bool  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 176 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetUseBModeFilter().

◆ OnSetVerticalSpacing()

void mitk::USDiPhASDeviceCustomControls::OnSetVerticalSpacing ( float  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 178 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetVerticalSpacing().

◆ OnSetVoltage()

void mitk::USDiPhASDeviceCustomControls::OnSetVoltage ( int  )
protectedvirtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 186 of file mitkUSDiPhASDeviceCustomControls.cpp.

Referenced by SetVoltage().

◆ passGUIOut()

void mitk::USDiPhASDeviceCustomControls::passGUIOut ( std::function< void(QString)>  )
virtual

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 34 of file mitkUSDiPhASDeviceCustomControls.cpp.

◆ SetAveragingCount()

void mitk::USDiPhASDeviceCustomControls::SetAveragingCount ( int  count)
virtual

Definition at line 114 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetAveragingCount().

◆ SetBandpassEnabled()

void mitk::USDiPhASDeviceCustomControls::SetBandpassEnabled ( bool  bandpass)
virtual

Definition at line 157 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetBandpassEnabled().

◆ SetCompensateEnergy()

void mitk::USDiPhASDeviceCustomControls::SetCompensateEnergy ( bool  compensate)
virtual

Definition at line 48 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetCompensateEnergy().

◆ SetCompensateScattering()

void mitk::USDiPhASDeviceCustomControls::SetCompensateScattering ( bool  compensate)
virtual

Definition at line 72 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetCompensateScattering().

◆ SetDataType()

void mitk::USDiPhASDeviceCustomControls::SetDataType ( DataType  type)
virtual

Definition at line 130 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetDataType().

◆ SetExcitationFrequency()

void mitk::USDiPhASDeviceCustomControls::SetExcitationFrequency ( double  MHz)
virtual

Definition at line 88 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetExcitationFrequency().

◆ SetHighCut()

void mitk::USDiPhASDeviceCustomControls::SetHighCut ( double  MHz)
virtual

Definition at line 167 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetHighCut().

◆ SetIsActive()

void mitk::USDiPhASDeviceCustomControls::SetIsActive ( bool  isActive)
overridevirtual

Activate or deactivate the custom controls. This is just for handling widget visibility in a GUI for example.

Implements mitk::USAbstractControlInterface.

Reimplemented in mitk::USDiPhASCustomControls.

Definition at line 24 of file mitkUSDiPhASDeviceCustomControls.cpp.

References m_IsActive.

◆ SetLowCut()

void mitk::USDiPhASDeviceCustomControls::SetLowCut ( double  MHz)
virtual

Definition at line 162 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetLowCut().

◆ SetMode()

void mitk::USDiPhASDeviceCustomControls::SetMode ( bool  interleaved)
virtual

Definition at line 103 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetMode().

◆ SetPitch()

void mitk::USDiPhASDeviceCustomControls::SetPitch ( double  mm)
virtual

Definition at line 136 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetPitch().

◆ SetReconstructedLines()

void mitk::USDiPhASDeviceCustomControls::SetReconstructedLines ( int  lines)
virtual

Definition at line 146 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetReconstructedLines().

◆ SetReconstructedSamples()

void mitk::USDiPhASDeviceCustomControls::SetReconstructedSamples ( int  samples)
virtual

Definition at line 141 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetReconstructedSamples().

◆ SetRecord()

void mitk::USDiPhASDeviceCustomControls::SetRecord ( bool  record)
virtual

Definition at line 58 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetRecord().

◆ SetSavingSettings()

void mitk::USDiPhASDeviceCustomControls::SetSavingSettings ( SavingSettings  settings)
virtual

Definition at line 77 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetSavingSettings().

◆ SetScanDepth()

void mitk::USDiPhASDeviceCustomControls::SetScanDepth ( double  mm)
virtual

Definition at line 109 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetScanDepth().

◆ SetScatteringCoefficient()

void mitk::USDiPhASDeviceCustomControls::SetScatteringCoefficient ( float  coeff)
virtual

Definition at line 68 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetScatteringCoefficient().

◆ SetSilentUpdate()

void mitk::USDiPhASDeviceCustomControls::SetSilentUpdate ( bool  silent)
virtual

Definition at line 36 of file mitkUSDiPhASDeviceCustomControls.cpp.

References silentUpdate.

◆ SetSpeedOfSound()

void mitk::USDiPhASDeviceCustomControls::SetSpeedOfSound ( int  mps)
virtual

Definition at line 151 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetSpeedOfSound().

◆ SetTGCMax()

void mitk::USDiPhASDeviceCustomControls::SetTGCMax ( int  max)
virtual

Definition at line 124 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetTGCMax().

◆ SetTGCMin()

void mitk::USDiPhASDeviceCustomControls::SetTGCMin ( int  min)
virtual

Definition at line 119 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetTGCMin().

◆ SetTransmitEvents()

void mitk::USDiPhASDeviceCustomControls::SetTransmitEvents ( int  events)
virtual

Definition at line 93 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetTransmitEvents().

◆ SetTransmitPhaseLength()

void mitk::USDiPhASDeviceCustomControls::SetTransmitPhaseLength ( double  us)
virtual

Definition at line 83 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetTransmitPhaseLength().

◆ SetUseBModeFilter()

void mitk::USDiPhASDeviceCustomControls::SetUseBModeFilter ( bool  isSet)
virtual

Definition at line 53 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetUseBModeFilter().

◆ SetVerticalSpacing()

void mitk::USDiPhASDeviceCustomControls::SetVerticalSpacing ( float  mm)
virtual

Definition at line 63 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetVerticalSpacing().

◆ SetVoltage()

void mitk::USDiPhASDeviceCustomControls::SetVoltage ( int  voltage)
virtual

Definition at line 98 of file mitkUSDiPhASDeviceCustomControls.cpp.

References OnSetVoltage().

Member Data Documentation

◆ m_ImageSource

USImageVideoSource::Pointer mitk::USDiPhASDeviceCustomControls::m_ImageSource
protected

Definition at line 100 of file mitkUSDiPhASDeviceCustomControls.h.

◆ m_IsActive

bool mitk::USDiPhASDeviceCustomControls::m_IsActive
protected

Definition at line 99 of file mitkUSDiPhASDeviceCustomControls.h.

Referenced by GetIsActive(), and SetIsActive().

◆ silentUpdate

bool mitk::USDiPhASDeviceCustomControls::silentUpdate
protected

Definition at line 101 of file mitkUSDiPhASDeviceCustomControls.h.

Referenced by GetSilentUpdate(), and SetSilentUpdate().

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