mitk::USTelemedProbe Class Reference

Specialized mitk::USProbe for handling Telemed API probe objects. It encapsulates a probe object from the Telemed API. More...

#include <mitkUSTelemedProbe.h>

Inheritance diagram for mitk::USTelemedProbe:

Public Member Functions
	mitkClassMacro (USTelemedProbe, USProbe)
	mitkNewMacro2Param (Self, Usgfw2Lib::IProbe *, Usgfw2Lib::IUsgDataView *)
Usgfw2Lib::IProbe *	GetUsgProbe ()
Usgfw2Lib::IUsgDataView *	GetUsgDataView ()
Public Member Functions inherited from mitk::USProbe
	mitkClassMacroItkParent (USProbe, itk::Object)
	itkFactorylessNewMacro (Self)
	itkCloneMacro (Self) mitkNewMacro1Param(Self
void	SetProbeCropping (unsigned int top, unsigned int bottom, unsigned int left, unsigned int right)
	Sets the probe cropping.
USProbeCropping	GetProbeCropping ()
bool	IsEqualToProbe (mitk::USProbe::Pointer probe)
	Compares this probe to another probe and returns true if they are equal in terms of name AND NAME ONLY be sure to sufficiently extend this method along with further capabilities probes.
void	SetDepthAndSpacing (int depth, Vector3D spacing)
	Sets a scanning depth of the probe and the associated spacing.
std::map< int, Vector3D >	GetDepthsAndSpacing ()
	Gets all scanning depths and the associates spacings of the probe as an std::map with depth as key (represented by an int) and spacing as value (represented by a Vector3D)
void	SetDepth (int depth)
	Sets a scanning depth of the probe with the default spacing (1,1,1). Exact spacing needs to be calibrated.
void	RemoveDepth (int depthToRemove)
	Removes the given depth of the probe, if it exists.
void	SetSpacingForGivenDepth (int givenDepth, Vector3D spacing)
Vector3D	GetSpacingForGivenDepth (int givenDepth)
	Returns the spacing that is associated to the given depth of the probe. If spacing was not calibrated or if depth does not exist for this probe the default spacing (1,1,1) is returned.
bool	IsDepthAndSpacingEmpty ()
	Checks, whether the std::map m_DepthAndSpacings contains at least one depth element or not.
	itkGetMacro (Name, std::string)
	itkSetMacro (Name, std::string)
	itkGetMacro (CurrentDepth, double)
	itkSetMacro (CurrentDepth, double)

Protected Member Functions
	USTelemedProbe (Usgfw2Lib::IProbe *probe, Usgfw2Lib::IUsgDataView *dataView)
virtual	~USTelemedProbe ()
Protected Member Functions inherited from mitk::USProbe
	USProbe ()
	USProbe (std::string identifier)
	~USProbe () override

Protected Attributes
Usgfw2Lib::IProbe *	m_UsgProbe
Usgfw2Lib::IUsgDataView *	m_UsgDataView
Protected Attributes inherited from mitk::USProbe
std::string	m_Name
double	m_CurrentDepth
std::map< int, Vector3D >	m_DepthsAndSpacings
USProbeCropping	m_Cropping

Additional Inherited Members
Public Types inherited from mitk::USProbe
typedef struct mitk::USProbe::USProbeCropping_	USProbeCropping
	Struct to define a probe specific ultrasound image cropping.

Detailed Description

Specialized mitk::USProbe for handling Telemed API probe objects. It encapsulates a probe object from the Telemed API.

This class should only be instantiated by mitk::USTelemedProbesControls. Every other object can get instances of mitk::USTelemedProbe from there.

Definition at line 32 of file mitkUSTelemedProbe.h.

Constructor & Destructor Documentation

USTelemedProbe()

mitk::USTelemedProbe::USTelemedProbe ( Usgfw2Lib::IProbe * probe, Usgfw2Lib::IUsgDataView * dataView )

protected

Constructs mitk::USTelemedProbe object with given API objects.

Parameters

probe	API probe object which should be represented by the constructed object
dataView	API data view object conected to this probe object

Definition at line 16 of file mitkUSTelemedProbe.cpp.

~USTelemedProbe()

mitk::USTelemedProbe::~USTelemedProbe ( )

protectedvirtual

Definition at line 24 of file mitkUSTelemedProbe.cpp.

Member Function Documentation

GetUsgDataView()

Usgfw2Lib::IUsgDataView * mitk::USTelemedProbe::GetUsgDataView

(

)

Returns the Telemed API data view connected with this object. This method is just for being called by mitk::USTelemedProbesControls.

Definition at line 35 of file mitkUSTelemedProbe.cpp.

GetUsgProbe()

Usgfw2Lib::IProbe * mitk::USTelemedProbe::GetUsgProbe

(

)

Returns the Telemed API probe connected with this object. This method is just for being called by mitk::USTelemedProbesControls.

Definition at line 30 of file mitkUSTelemedProbe.cpp.

mitkClassMacro()

mitk::USTelemedProbe::mitkClassMacro	(	USTelemedProbe	,
		USProbe	)

mitkNewMacro2Param()

mitk::USTelemedProbe::mitkNewMacro2Param	(	Self	,
		Usgfw2Lib::IProbe *	,
		Usgfw2Lib::IUsgDataView *	)

Member Data Documentation

m_UsgDataView

Usgfw2Lib::IUsgDataView* mitk::USTelemedProbe::m_UsgDataView

protected

Definition at line 61 of file mitkUSTelemedProbe.h.

m_UsgProbe

Usgfw2Lib::IProbe* mitk::USTelemedProbe::m_UsgProbe

protected

Definition at line 60 of file mitkUSTelemedProbe.h.

---

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

• Modules/US/USHardwareTelemed/mitkUSTelemedProbe.h
• Modules/US/USHardwareTelemed/mitkUSTelemedProbe.cpp