UsTK : Ultrasound ToolKit  version 2.0.1 under development (2023-12-07)
usNeedleTipSymmetric Class Reference

#include <visp3/ustk_needle_modeling/usNeedleTipSymmetric.h>

+ Inheritance diagram for usNeedleTipSymmetric:

Public Member Functions

 usNeedleTipSymmetric ()
 
 usNeedleTipSymmetric (const usNeedleTipSymmetric &needle)
 
virtual ~usNeedleTipSymmetric ()
 
virtual usNeedleTipSymmetricoperator= (const usNeedleTipSymmetric &needle)
 
virtual usNeedleTipSymmetricclone () const
 
void setDiameter (double diameter)
 
double getDiameter () const
 
void setLength (double l)
 
double getLength () const
 
double getAngle () const
 
void setBasePose (const vpPoseVector &pose)
 
vpPoseVector getBasePose () const
 
void setWorldMbase (const vpHomogeneousMatrix &worldMbase)
 
vpHomogeneousMatrix getWorldMbase () const
 
void setBasePosition (const vpColVector &position)
 
vpColVector getBasePosition () const
 
vpPoseVector getTipPose () const
 
vpHomogeneousMatrix getWorldMtip () const
 
vpColVector getTipPosition () const
 
vpColVector getTipDirection () const
 
vpColVector getBaseAxisX () const
 
vpColVector getBaseAxisY () const
 
vpColVector getBaseAxisZ () const
 

Protected Attributes

double _diameter
 
double _length
 
vpPoseVector m_basePose
 
vpHomogeneousMatrix m_worldMbase
 
vpPoseVector m_tipPose
 
vpHomogeneousMatrix m_worldMtip
 

Friends

VISP_EXPORT std::ostream & operator<< (std::ostream &s, const usNeedleTipSymmetric &tip)
 
VISP_EXPORT std::istream & operator>> (std::istream &s, usNeedleTipSymmetric &tip)
 
VISP_EXPORT std::ostream & operator<<= (std::ostream &s, const usNeedleTipSymmetric &tip)
 
VISP_EXPORT std::istream & operator>>= (std::istream &s, usNeedleTipSymmetric &tip)
 

Detailed Description

Definition at line 40 of file usNeedleTipSymmetric.h.

Constructor & Destructor Documentation

◆ usNeedleTipSymmetric() [1/2]

usNeedleTipSymmetric::usNeedleTipSymmetric ( )

Constructors, destructors.

Definition at line 38 of file usNeedleTipSymmetric.cpp.

Referenced by clone().

◆ usNeedleTipSymmetric() [2/2]

usNeedleTipSymmetric::usNeedleTipSymmetric ( const usNeedleTipSymmetric needle)

Definition at line 40 of file usNeedleTipSymmetric.cpp.

◆ ~usNeedleTipSymmetric()

usNeedleTipSymmetric::~usNeedleTipSymmetric ( )
virtual

Definition at line 45 of file usNeedleTipSymmetric.cpp.

Member Function Documentation

◆ clone()

usNeedleTipSymmetric * usNeedleTipSymmetric::clone ( ) const
virtual

Reimplemented from usNeedleTip.

Definition at line 57 of file usNeedleTipSymmetric.cpp.

References usNeedleTipSymmetric().

◆ getAngle()

double usNeedleTipSymmetric::getAngle ( ) const

Definition at line 75 of file usNeedleTipSymmetric.cpp.

References _diameter, and _length.

◆ getBaseAxisX()

vpColVector usNeedleTip::getBaseAxisX ( ) const
inherited

Definition at line 105 of file usNeedleTip.cpp.

References usNeedleTip::m_worldMbase.

◆ getBaseAxisY()

vpColVector usNeedleTip::getBaseAxisY ( ) const
inherited

Definition at line 107 of file usNeedleTip.cpp.

References usNeedleTip::m_worldMbase.

Referenced by usNeedleModelingDisplayTools::display().

◆ getBaseAxisZ()

◆ getBasePose()

vpPoseVector usNeedleTip::getBasePose ( ) const
inherited

◆ getBasePosition()

◆ getDiameter()

double usNeedleTipSymmetric::getDiameter ( ) const

Definition at line 65 of file usNeedleTipSymmetric.cpp.

References _diameter.

Referenced by usNeedleModelingDisplayTools::display().

◆ getLength()

double usNeedleTipSymmetric::getLength ( ) const

Definition at line 73 of file usNeedleTipSymmetric.cpp.

References _length.

Referenced by usNeedleModelingDisplayTools::display().

◆ getTipDirection()

vpColVector usNeedleTip::getTipDirection ( ) const
inherited

◆ getTipPose()

vpPoseVector usNeedleTip::getTipPose ( ) const
inherited

Definition at line 97 of file usNeedleTip.cpp.

References usNeedleTip::m_tipPose.

◆ getTipPosition()

◆ getWorldMbase()

vpHomogeneousMatrix usNeedleTip::getWorldMbase ( ) const
inherited

Definition at line 76 of file usNeedleTip.cpp.

References usNeedleTip::m_worldMbase.

Referenced by usNeedleModelingDisplayTools::display().

◆ getWorldMtip()

vpHomogeneousMatrix usNeedleTip::getWorldMtip ( ) const
inherited

Definition at line 99 of file usNeedleTip.cpp.

References usNeedleTip::m_worldMtip.

◆ operator=()

usNeedleTipSymmetric & usNeedleTipSymmetric::operator= ( const usNeedleTipSymmetric needle)
virtual

Definition at line 47 of file usNeedleTipSymmetric.cpp.

References _diameter, _length, and usNeedleTip::operator=().

◆ setBasePose()

void usNeedleTip::setBasePose ( const vpPoseVector &  pose)
inherited

◆ setBasePosition()

void usNeedleTip::setBasePosition ( const vpColVector &  position)
inherited

Definition at line 78 of file usNeedleTip.cpp.

References usNeedleTip::m_basePose, and usNeedleTip::m_worldMbase.

◆ setDiameter()

void usNeedleTipSymmetric::setDiameter ( double  diameter)

Parameters setters and getters.

Definition at line 59 of file usNeedleTipSymmetric.cpp.

References _diameter.

Referenced by usNeedleInsertionModelRayleighRitzSpline::loadPreset().

◆ setLength()

void usNeedleTipSymmetric::setLength ( double  l)

Definition at line 67 of file usNeedleTipSymmetric.cpp.

References _length.

Referenced by usNeedleInsertionModelRayleighRitzSpline::loadPreset().

◆ setWorldMbase()

void usNeedleTip::setWorldMbase ( const vpHomogeneousMatrix &  worldMbase)
inherited

Definition at line 68 of file usNeedleTip.cpp.

References usNeedleTip::m_basePose, and usNeedleTip::m_worldMbase.

Friends And Related Function Documentation

◆ operator<<

VISP_EXPORT std::ostream& operator<< ( std::ostream &  s,
const usNeedleTipSymmetric tip 
)
friend

Data saving.

Text

Definition at line 77 of file usNeedleTipSymmetric.cpp.

◆ operator<<=

VISP_EXPORT std::ostream& operator<<= ( std::ostream &  s,
const usNeedleTipSymmetric tip 
)
friend

Binary.

Definition at line 105 of file usNeedleTipSymmetric.cpp.

◆ operator>>

VISP_EXPORT std::istream& operator>> ( std::istream &  s,
usNeedleTipSymmetric tip 
)
friend

Definition at line 89 of file usNeedleTipSymmetric.cpp.

◆ operator>>=

VISP_EXPORT std::istream& operator>>= ( std::istream &  s,
usNeedleTipSymmetric tip 
)
friend

Definition at line 117 of file usNeedleTipSymmetric.cpp.

Member Data Documentation

◆ _diameter

double usNeedleTipSymmetric::_diameter
protected

Definition at line 43 of file usNeedleTipSymmetric.h.

Referenced by getAngle(), getDiameter(), operator=(), and setDiameter().

◆ _length

double usNeedleTipSymmetric::_length
protected

Definition at line 44 of file usNeedleTipSymmetric.h.

Referenced by getAngle(), getLength(), operator=(), and setLength().

◆ m_basePose

◆ m_tipPose

vpPoseVector usNeedleTip::m_tipPose
protectedinherited

Definition at line 47 of file usNeedleTip.h.

Referenced by usNeedleTip::getTipPose(), and usNeedleTip::operator=().

◆ m_worldMbase

◆ m_worldMtip

vpHomogeneousMatrix usNeedleTip::m_worldMtip
protectedinherited