UsTK : Ultrasound ToolKit  version 2.0.1 under development (2024-05-17)
usNeedleInsertionModelKinematic.h
1 /****************************************************************************
2  *
3  * This file is part of the ustk software.
4  * Copyright (C) 2016 - 2017 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * ("GPL") version 2 as published by the Free Software Foundation.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ustk with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * This software was developed at:
17  * Inria Rennes - Bretagne Atlantique
18  * Campus Universitaire de Beaulieu
19  * 35042 Rennes Cedex
20  * France
21  *
22  * If you have questions regarding the use of this file, please contact
23  * Inria at ustk@inria.fr
24  *
25  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
26  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
27  *
28  * Author:
29  * Jason Chevrie
30  *
31  *****************************************************************************/
32 
33 #ifndef __usNeedleInsertionModelKinematic_h
34 #define __usNeedleInsertionModelKinematic_h
35 
36 #include <visp3/core/vpPoseVector.h>
37 
38 #include <visp3/ustk_needle_modeling/usNeedleInsertionModelInterface.h>
39 #include <visp3/ustk_needle_modeling/usNeedleModelBaseTip.h>
40 
42 {
43 
44 protected:
46 
48 
49 public:
55  virtual usNeedleInsertionModelKinematic *clone() const; // Polymorph copy method
56 
58 
60 
61  void setNaturalCurvature(double naturalCurvature);
62  double getNaturalCurvature() const;
63 
65 
66  const usNeedleModelBaseTip &accessNeedle() const;
67  usNeedleModelBaseTip &accessNeedle();
68 
70 
72  bool moveBase(double vz, double wz, double time);
73  bool moveBase(double controlCurvature, double vz, double wz, double time);
74 
76  bool setBasePose(const vpPoseVector &pose);
77  vpPoseVector getBasePose() const;
78 };
79 
80 #endif // __usNeedleInsertionModelKinematic_h
bool moveBase(const vpColVector &v, double time)
virtual bool setBasePose(const vpPoseVector &pose)=0
The following methods should be redefined in the derived classes.
virtual vpPoseVector getBasePose() const =0
double m_naturalCurvature
needle curvature parameter