Medical Imaging Interaction Toolkit  2018.4.99-6a3ea89d
Medical Imaging Interaction Toolkit
mitk::USProbe Class Reference

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:
Collaboration diagram for mitk::USProbe:

Classes

struct  USProbeCropping_
 Struct to define a probe specific ultrasound image cropping. More...
 

Public Types

typedef struct mitk::USProbe::USProbeCropping_ USProbeCropping
 Struct to define a probe specific ultrasound image cropping. More...
 

Public Member Functions

 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, Vector3DGetDepthsAndSpacing ()
 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)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 USProbe ()
 
 USProbe (std::string identifier)
 
 ~USProbe () override
 

Protected Attributes

std::string m_Name
 
double m_CurrentDepth
 
std::map< int, Vector3Dm_DepthsAndSpacings
 
USProbeCropping m_Cropping
 

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 30 of file mitkUSProbe.h.

Member Typedef Documentation

◆ USProbeCropping

Struct to define a probe specific ultrasound image cropping.

Constructor & Destructor Documentation

◆ USProbe() [1/2]

mitk::USProbe::USProbe ( )
protected

Definition at line 16 of file mitkUSProbe.cpp.

◆ USProbe() [2/2]

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

Definition at line 20 of file mitkUSProbe.cpp.

◆ ~USProbe()

mitk::USProbe::~USProbe ( )
overrideprotected

Definition at line 25 of file mitkUSProbe.cpp.

Member Function Documentation

◆ Clone()

Pointer mitk::USProbe::Clone ( ) const

◆ GetCurrentDepth()

virtual double mitk::USProbe::GetCurrentDepth ( )
virtual

◆ GetDepthsAndSpacing()

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 53 of file mitkUSProbe.cpp.

References m_DepthsAndSpacings.

◆ GetName()

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

◆ GetProbeCropping()

mitk::USProbe::USProbeCropping mitk::USProbe::GetProbeCropping ( )

Definition at line 37 of file mitkUSProbe.cpp.

References m_Cropping.

◆ GetSpacingForGivenDepth()

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

Definition at line 80 of file mitkUSProbe.cpp.

References m_DepthsAndSpacings.

◆ IsDepthAndSpacingEmpty()

bool mitk::USProbe::IsDepthAndSpacingEmpty ( )

Checks, whether the std::map m_DepthAndSpacings contains at least one depth element or not.

Returns
True, if the the std::map m_DepthAndSpacings does not contain at least one depth element, else false.

Definition at line 99 of file mitkUSProbe.cpp.

References m_DepthsAndSpacings.

◆ IsEqualToProbe()

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 42 of file mitkUSProbe.cpp.

References m_Name.

◆ mitkClassMacroItkParent()

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

◆ mitkNewMacro1Param()

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

◆ New()

◆ RemoveDepth()

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

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

Definition at line 68 of file mitkUSProbe.cpp.

References m_DepthsAndSpacings.

◆ SetCurrentDepth()

virtual void mitk::USProbe::SetCurrentDepth ( double  _arg)
virtual

◆ SetDepth()

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

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

Definition at line 58 of file mitkUSProbe.cpp.

References m_DepthsAndSpacings.

◆ SetDepthAndSpacing()

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

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

Definition at line 48 of file mitkUSProbe.cpp.

References m_DepthsAndSpacings.

◆ SetName()

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

◆ SetProbeCropping()

void mitk::USProbe::SetProbeCropping ( unsigned int  top,
unsigned int  bottom,
unsigned int  left,
unsigned int  right 
)

◆ SetSpacingForGivenDepth()

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 73 of file mitkUSProbe.cpp.

References m_DepthsAndSpacings.

Member Data Documentation

◆ m_Cropping

USProbeCropping mitk::USProbe::m_Cropping
protected

Definition at line 123 of file mitkUSProbe.h.

Referenced by GetProbeCropping(), and SetProbeCropping().

◆ m_CurrentDepth

double mitk::USProbe::m_CurrentDepth
protected

Definition at line 118 of file mitkUSProbe.h.

◆ m_DepthsAndSpacings

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

◆ m_Name

std::string mitk::USProbe::m_Name
protected

Definition at line 117 of file mitkUSProbe.h.

Referenced by IsEqualToProbe().


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