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

#include <mitkUSDiPhASProbe.h>

Inheritance diagram for mitk::USDiPhASProbe:

[legend]

Collaboration diagram for mitk::USDiPhASProbe:

[legend]

Public Member Functions
	mitkClassMacro (USDiPhASProbe, USProbe)

	mitkNewMacro1Param (Self, std::string)

Public Member Functions inherited from mitk::USProbe
	mitkClassMacroItkParent (USProbe, itk::Object)

Pointer	Clone () const

	mitkNewMacro1Param (Self, std::string)

void	SetProbeCropping (unsigned int top, unsigned int bottom, unsigned int left, unsigned int right)
	Sets the probe cropping. More...

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. More...

void	SetDepthAndSpacing (int depth, Vector3D spacing)
	Sets a scanning depth of the probe and the associated spacing. More...

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) More...

void	SetDepth (int depth)
	Sets a scanning depth of the probe with the default spacing (1,1,1). Exact spacing needs to be calibrated. More...

void	RemoveDepth (int depthToRemove)
	Removes the given depth of the probe, if it exists. More...

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. More...

bool	IsDepthAndSpacingEmpty ()
	Checks, whether the std::map m_DepthAndSpacings contains at least one depth element or not. More...

virtual std::string	GetName ()

virtual void	SetName (std::string _arg)

virtual double	GetCurrentDepth ()

virtual void	SetCurrentDepth (double _arg)

Protected Member Functions
	USDiPhASProbe (std::string ProbeName)

virtual	~USDiPhASProbe ()

Protected Member Functions inherited from mitk::USProbe
	USProbe ()

	USProbe (std::string identifier)

	~USProbe () override

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

Static Public Member Functions inherited from mitk::USProbe
static Pointer	New ()

Protected Attributes inherited from mitk::USProbe
std::string	m_Name

double	m_CurrentDepth

std::map< int, Vector3D >	m_DepthsAndSpacings

USProbeCropping	m_Cropping

Detailed Description

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

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

Definition at line 27 of file mitkUSDiPhASProbe.h.

Constructor & Destructor Documentation

◆ USDiPhASProbe()

mitk::USDiPhASProbe::USDiPhASProbe ( std::string ProbeName )

protected

Constructs mitk::USDiPhASProbe 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 mitkUSDiPhASProbe.cpp.

References mitk::USProbe::SetName().

◆ ~USDiPhASProbe()

mitk::USDiPhASProbe::~USDiPhASProbe ( )

protectedvirtual

Definition at line 21 of file mitkUSDiPhASProbe.cpp.

Member Function Documentation

◆ mitkClassMacro()

mitk::USDiPhASProbe::mitkClassMacro	(	USDiPhASProbe	,
		USProbe
	)

◆ mitkNewMacro1Param()

mitk::USDiPhASProbe::mitkNewMacro1Param	(	Self	,
		std::string
	)

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

Public Member Functions

Protected Member Functions