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< USDevice >)
void	SetIsActive (bool isActive) override
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::USProbe::USProbeCropping	GetCropArea ()
void	UpdateProbeCropping (mitk::USImageVideoSource::USImageCropping cropping)
	Updates the cropping of the current probe given by the crop area of the USImageVideoSource. More...
void	SetNewDepth (double depth)
	Sets a new depth value to the current probe. 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...
void	SetDefaultProbeAsCurrentProbe ()
	Sets the first existing probe or the default probe of a USVideoDevice as the current probe of the USVideoDevice. More...
Public Member Functions inherited from mitk::USAbstractControlInterface
	mitkClassMacroItkParent (USAbstractControlInterface, itk::Object)

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

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

Detailed Description

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

Definition at line 27 of file mitkUSVideoDeviceCustomControls.h.

Constructor & Destructor Documentation

USVideoDeviceCustomControls()

mitk::USVideoDeviceCustomControls::USVideoDeviceCustomControls ( itk::SmartPointer< USDevice >  device )

protected

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

~USVideoDeviceCustomControls()

mitk::USVideoDeviceCustomControls::~USVideoDeviceCustomControls ( )

overrideprotected

Member Function Documentation

GetCropArea()

mitk::USProbe::USProbeCropping mitk::USVideoDeviceCustomControls::GetCropArea

(

)

Returns

area currently set for image cropping defined by the actual current probe.

GetDepthsForProbe()

std::vector<int> mitk::USVideoDeviceCustomControls::GetDepthsForProbe

(

std::string

name

)

Get the scanning dephts of the given probe.

GetIsActive()

bool mitk::USVideoDeviceCustomControls::GetIsActive ( )

overridevirtual

Returns

if this custom controls are currently activated

Implements mitk::USAbstractControlInterface.

GetProbes()

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

(

)

Get all the probes for the current device.

mitkClassMacro()

mitk::USVideoDeviceCustomControls::mitkClassMacro	(	USVideoDeviceCustomControls	,
		USAbstractControlInterface
	)

mitkNewMacro1Param()

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

SetCropArea()

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.

SetDefaultProbeAsCurrentProbe()

void mitk::USVideoDeviceCustomControls::SetDefaultProbeAsCurrentProbe

(

)

Sets the first existing probe or the default probe of a USVideoDevice as the current probe of the USVideoDevice.

SetIsActive()

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.

SetNewDepth()

void mitk::USVideoDeviceCustomControls::SetNewDepth

(

double

depth

)

Sets a new depth value to the current probe.

SetNewProbeIdentifier()

void mitk::USVideoDeviceCustomControls::SetNewProbeIdentifier

(

std::string

probename

)

\ brief Sets new probe identifier

UpdateProbeCropping()

void mitk::USVideoDeviceCustomControls::UpdateProbeCropping

(

mitk::USImageVideoSource::USImageCropping

cropping

)

Updates the cropping of the current probe given by the crop area of the USImageVideoSource.

Member Data Documentation

m_ImageSource

USImageVideoSource::Pointer mitk::USVideoDeviceCustomControls::m_ImageSource

protected

Definition at line 99 of file mitkUSVideoDeviceCustomControls.h.

m_IsActive

bool mitk::USVideoDeviceCustomControls::m_IsActive

protected

Definition at line 98 of file mitkUSVideoDeviceCustomControls.h.

---

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

• mitkUSVideoDeviceCustomControls.h