Right now, the US Probe is only a fancy name for a string. Later, it could handle probe specific parameters like the current frequency etc. It is able to compare itself to other probes for device managment though. More...

#include <mitkUSProbe.h>

Inheritance diagram for mitk::USProbe:

[legend]

Collaboration diagram for mitk::USProbe:

[legend]

Public Member Functions
	mitkClassMacroItkParent (USProbe, itk::Object)

Pointer	Clone () const

	mitkNewMacro1Param (Self, std::string)

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,0). 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,0) is returned. More...

virtual std::string	GetName ()

virtual void	SetName (std::string _arg)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	USProbe ()

	USProbe (std::string identifier)

virtual	~USProbe ()

Protected Attributes
std::string	m_Name

std::map< int, Vector3D >	m_DepthsAndSpacings

Detailed Description

Right now, the US Probe is only a fancy name for a string. Later, it could handle probe specific parameters like the current frequency etc. It is able to compare itself to other probes for device managment though.

Documentation

Definition at line 34 of file mitkUSProbe.h.

Constructor & Destructor Documentation

mitk::USProbe::USProbe ( )

protected

Definition at line 20 of file mitkUSProbe.cpp.

mitk::USProbe::USProbe ( std::string identifier )

protected

Definition at line 24 of file mitkUSProbe.cpp.

mitk::USProbe::~USProbe ( )

protectedvirtual

Definition at line 29 of file mitkUSProbe.cpp.

Member Function Documentation

Pointer mitk::USProbe::Clone ( ) const

std::map< int, mitk::Vector3D > mitk::USProbe::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)

Definition at line 44 of file mitkUSProbe.cpp.

virtual std::string mitk::USProbe::GetName ( )

virtual

mitk::Vector3D mitk::USProbe::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,0) is returned.

Definition at line 71 of file mitkUSProbe.cpp.

bool mitk::USProbe::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.

Definition at line 33 of file mitkUSProbe.cpp.

mitk::USProbe::mitkClassMacroItkParent	(	USProbe	,
		itk::Object
	)

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

static Pointer mitk::USProbe::New ( )

static

Referenced by QmitkUSNewVideoDeviceWidget::AddProbesToDevice(), mitk::USTelemedProbesControls::CreateProbesSet(), QmitkUSNewVideoDeviceWidget::OnClickedDone(), and mitk::USDevicePersistence::StringToUSProbe().

void mitk::USProbe::RemoveDepth ( int depthToRemove )

Removes the given depth of the probe, if it exists.

Definition at line 59 of file mitkUSProbe.cpp.

void mitk::USProbe::SetDepth ( int depth )

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

Definition at line 49 of file mitkUSProbe.cpp.

void mitk::USProbe::SetDepthAndSpacing	(	int	depth,
		mitk::Vector3D	spacing
	)

Sets a scanning depth of the probe and the associated spacing.

Definition at line 39 of file mitkUSProbe.cpp.

virtual void mitk::USProbe::SetName ( std::string _arg )

virtual

Referenced by mitk::USTelemedProbe::USTelemedProbe().

void mitk::USProbe::SetSpacingForGivenDepth	(	int	givenDepth,
		Vector3D	spacing
	)

\ brief Sets the spacing associated to the given depth of the probe. Spacing needs to be calibrated.

Definition at line 64 of file mitkUSProbe.cpp.

Member Data Documentation

std::map<int, Vector3D> mitk::USProbe::m_DepthsAndSpacings

protected

Definition at line 93 of file mitkUSProbe.h.

std::string mitk::USProbe::m_Name

protected

Definition at line 90 of file mitkUSProbe.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation