Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::USVideoDeviceCustomControls Class Reference

Custom controls for mitk::USVideoDevice. Controls image cropping of the corresponding mitk::USImageVideoSource. More...

#include <mitkUSVideoDeviceCustomControls.h>

Inheritance diagram for mitk::USVideoDeviceCustomControls:
Collaboration diagram for mitk::USVideoDeviceCustomControls:

Public Member Functions

 mitkClassMacro (USVideoDeviceCustomControls, USAbstractControlInterface)
 
 mitkNewMacro1Param (Self, itk::SmartPointer< USVideoDevice >)
 
virtual void SetIsActive (bool isActive) override
 
virtual bool GetIsActive () override
 
void SetCropArea (USImageVideoSource::USImageCropping newArea)
 Sets the area that will be cropped from the US image. Set [0,0,0,0] to disable it, which is also default. More...
 
mitk::USImageVideoSource::USImageCropping GetCropArea ()
 
void SetNewDepth (double depth)
 Sets new depth value. More...
 
void SetNewProbeIdentifier (std::string probename)
 
std::vector< mitk::USProbe::Pointer > GetProbes ()
 Get all the probes for the current device. More...
 
std::vector< int > GetDepthsForProbe (std::string name)
 Get the scanning dephts of the given probe. More...
 
- Public Member Functions inherited from mitk::USAbstractControlInterface
 mitkClassMacroItkParent (USAbstractControlInterface, itk::Object)
 

Protected Member Functions

 USVideoDeviceCustomControls (itk::SmartPointer< USVideoDevice > device)
 
virtual ~USVideoDeviceCustomControls ()
 
- Protected Member Functions inherited from mitk::USAbstractControlInterface
 USAbstractControlInterface (itk::SmartPointer< USDevice > device)
 
virtual ~USAbstractControlInterface ()
 

Protected Attributes

bool m_IsActive
 
USImageVideoSource::Pointer m_ImageSource
 
- Protected Attributes inherited from mitk::USAbstractControlInterface
itk::SmartPointer< USDevicem_Device
 

Detailed Description

Custom controls for mitk::USVideoDevice. Controls image cropping of the corresponding mitk::USImageVideoSource.

Definition at line 31 of file mitkUSVideoDeviceCustomControls.h.

Constructor & Destructor Documentation

mitk::USVideoDeviceCustomControls::USVideoDeviceCustomControls ( itk::SmartPointer< USVideoDevice device)
protected

Class needs an mitk::USImageVideoSource object for beeing constructed. This object will be manipulated by the custom controls methods.

Definition at line 19 of file mitkUSVideoDeviceCustomControls.cpp.

References mitk::USAbstractControlInterface::m_Device, and m_ImageSource.

mitk::USVideoDeviceCustomControls::~USVideoDeviceCustomControls ( )
protectedvirtual

Definition at line 25 of file mitkUSVideoDeviceCustomControls.cpp.

Member Function Documentation

mitk::USImageVideoSource::USImageCropping mitk::USVideoDeviceCustomControls::GetCropArea ( )
Returns
area currently set for image cropping

Definition at line 73 of file mitkUSVideoDeviceCustomControls.cpp.

std::vector< int > mitk::USVideoDeviceCustomControls::GetDepthsForProbe ( std::string  name)

Get the scanning dephts of the given probe.

Definition at line 85 of file mitkUSVideoDeviceCustomControls.cpp.

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

Implements mitk::USAbstractControlInterface.

Definition at line 34 of file mitkUSVideoDeviceCustomControls.cpp.

std::vector< mitk::USProbe::Pointer > mitk::USVideoDeviceCustomControls::GetProbes ( )

Get all the probes for the current device.

Definition at line 79 of file mitkUSVideoDeviceCustomControls.cpp.

mitk::USVideoDeviceCustomControls::mitkClassMacro ( USVideoDeviceCustomControls  ,
USAbstractControlInterface   
)
mitk::USVideoDeviceCustomControls::mitkNewMacro1Param ( Self  ,
itk::SmartPointer< USVideoDevice  
)
void mitk::USVideoDeviceCustomControls::SetCropArea ( USImageVideoSource::USImageCropping  newArea)

Sets the area that will be cropped from the US image. Set [0,0,0,0] to disable it, which is also default.

Definition at line 39 of file mitkUSVideoDeviceCustomControls.cpp.

References mitk::USImageVideoSource::USImageCropping::bottom, mitk::USImageVideoSource::USImageCropping::left, MITK_INFO, MITK_WARN, mitk::USImageVideoSource::USImageCropping::right, and mitk::USImageVideoSource::USImageCropping::top.

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

Activate or deactivate the custom controls. This is just for handling widget visibility in a GUI for example. Cropping will not be deactivated if this method is called with false. Use mitk::USVideoDeviceCustomControls::SetCropArea() with an empty are instead.

Implements mitk::USAbstractControlInterface.

Definition at line 29 of file mitkUSVideoDeviceCustomControls.cpp.

void mitk::USVideoDeviceCustomControls::SetNewDepth ( double  depth)

Sets new depth value.

Definition at line 63 of file mitkUSVideoDeviceCustomControls.cpp.

void mitk::USVideoDeviceCustomControls::SetNewProbeIdentifier ( std::string  probename)

\ brief Sets new probe identifier

Definition at line 68 of file mitkUSVideoDeviceCustomControls.cpp.

Member Data Documentation

USImageVideoSource::Pointer mitk::USVideoDeviceCustomControls::m_ImageSource
protected

Definition at line 91 of file mitkUSVideoDeviceCustomControls.h.

Referenced by USVideoDeviceCustomControls().

bool mitk::USVideoDeviceCustomControls::m_IsActive
protected

Definition at line 90 of file mitkUSVideoDeviceCustomControls.h.


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