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>
|
| | 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) |
| |
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.
◆ USProbeCropping
Struct to define a probe specific ultrasound image cropping.
◆ USProbe() [1/2]
| mitk::USProbe::USProbe |
( |
| ) |
|
|
protected |
◆ USProbe() [2/2]
| mitk::USProbe::USProbe |
( |
std::string | identifier | ) |
|
|
protected |
◆ ~USProbe()
| mitk::USProbe::~USProbe |
( |
| ) |
|
|
overrideprotected |
◆ 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.
◆ GetProbeCropping()
◆ 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.
◆ 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.
◆ 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.
◆ itkCloneMacro()
| mitk::USProbe::itkCloneMacro |
( |
Self | | ) |
|
◆ itkFactorylessNewMacro()
| mitk::USProbe::itkFactorylessNewMacro |
( |
Self | | ) |
|
◆ itkGetMacro() [1/2]
| mitk::USProbe::itkGetMacro |
( |
CurrentDepth | , |
|
|
double | ) |
◆ itkGetMacro() [2/2]
| mitk::USProbe::itkGetMacro |
( |
Name | , |
|
|
std::string | ) |
◆ itkSetMacro() [1/2]
| mitk::USProbe::itkSetMacro |
( |
CurrentDepth | , |
|
|
double | ) |
◆ itkSetMacro() [2/2]
| mitk::USProbe::itkSetMacro |
( |
Name | , |
|
|
std::string | ) |
◆ mitkClassMacroItkParent()
| mitk::USProbe::mitkClassMacroItkParent |
( |
USProbe | , |
|
|
itk::Object | ) |
◆ 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.
◆ 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.
◆ SetDepthAndSpacing()
| void mitk::USProbe::SetDepthAndSpacing |
( |
int | depth, |
|
|
Vector3D | spacing ) |
Sets a scanning depth of the probe and the associated spacing.
Definition at line 48 of file mitkUSProbe.cpp.
◆ 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.
◆ m_Cropping
◆ m_CurrentDepth
| double mitk::USProbe::m_CurrentDepth |
|
protected |
◆ m_DepthsAndSpacings
| std::map<int, Vector3D> mitk::USProbe::m_DepthsAndSpacings |
|
protected |
◆ m_Name
| std::string mitk::USProbe::m_Name |
|
protected |
The documentation for this class was generated from the following files:
