Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
tesseract_kinematics::REPInvKin Class Reference

Robot With External Positioner Inverse kinematic implementation. More...

#include <rep_inv_kin.h>

Inheritance diagram for tesseract_kinematics::REPInvKin:
Inheritance graph
[legend]

Public Types

using ConstPtr = std::shared_ptr< const REPInvKin >
 
using ConstUPtr = std::unique_ptr< const REPInvKin >
 
using Ptr = std::shared_ptr< REPInvKin >
 
using UPtr = std::unique_ptr< REPInvKin >
 
- Public Types inherited from tesseract_kinematics::InverseKinematics
using ConstPtr = std::shared_ptr< const InverseKinematics >
 
using ConstUPtr = std::unique_ptr< const InverseKinematics >
 
using Ptr = std::shared_ptr< InverseKinematics >
 
using UPtr = std::unique_ptr< InverseKinematics >
 

Public Member Functions

IKSolutions calcInvKin (const tesseract_common::TransformMap &tip_link_poses, const Eigen::Ref< const Eigen::VectorXd > &seed) const override final
 Calculates joint solutions given a pose for each tip link. More...
 
InverseKinematics::UPtr clone () const override final
 Clone the forward kinematics object. More...
 
std::string getBaseLinkName () const override final
 Get the robot base link name. More...
 
std::vector< std::string > getJointNames () const override final
 Get list of joint names for kinematic object. More...
 
std::string getSolverName () const override final
 Get the name of the solver. Recommend using the name of the class. More...
 
std::vector< std::string > getTipLinkNames () const override final
 Get the names of the tip links of the kinematics group. More...
 
std::string getWorkingFrame () const override final
 Get the inverse kinematics working frame. More...
 
Eigen::Index numJoints () const override final
 Number of joints in robot. More...
 
REPInvKinoperator= (const REPInvKin &other)
 
REPInvKinoperator= (REPInvKin &&)=default
 
 REPInvKin (const REPInvKin &other)
 
 REPInvKin (const tesseract_scene_graph::SceneGraph &scene_graph, const tesseract_scene_graph::SceneState &scene_state, InverseKinematics::UPtr manipulator, double manipulator_reach, std::unique_ptr< ForwardKinematics > positioner, const Eigen::MatrixX2d &positioner_sample_range, const Eigen::VectorXd &positioner_sample_resolution, std::string solver_name=DEFAULT_REP_INV_KIN_SOLVER_NAME)
 Construct Inverse Kinematics for a robot on a positioner. More...
 
 REPInvKin (const tesseract_scene_graph::SceneGraph &scene_graph, const tesseract_scene_graph::SceneState &scene_state, InverseKinematics::UPtr manipulator, double manipulator_reach, std::unique_ptr< ForwardKinematics > positioner, const Eigen::VectorXd &positioner_sample_resolution, std::string solver_name=DEFAULT_REP_INV_KIN_SOLVER_NAME)
 Construct Inverse Kinematics for a robot on a positioner. More...
 
 REPInvKin (REPInvKin &&)=default
 
 ~REPInvKin () override=default
 
- Public Member Functions inherited from tesseract_kinematics::InverseKinematics
 InverseKinematics ()=default
 
 InverseKinematics (const InverseKinematics &)=default
 
 InverseKinematics (InverseKinematics &&)=default
 
InverseKinematicsoperator= (const InverseKinematics &)=default
 
InverseKinematicsoperator= (InverseKinematics &&)=default
 
virtual ~InverseKinematics ()
 

Private Member Functions

IKSolutions calcInvKinHelper (const tesseract_common::TransformMap &tip_link_poses, const Eigen::Ref< const Eigen::VectorXd > &seed) const
 calcFwdKin helper function More...
 
void ikAt (IKSolutions &solutions, const tesseract_common::TransformMap &tip_link_poses, Eigen::VectorXd &positioner_pose, const Eigen::Ref< const Eigen::VectorXd > &seed) const
 
void init (const tesseract_scene_graph::SceneGraph &scene_graph, const tesseract_scene_graph::SceneState &scene_state, InverseKinematics::UPtr manipulator, double manipulator_reach, std::unique_ptr< ForwardKinematics > positioner, const Eigen::MatrixX2d &poitioner_sample_range, const Eigen::VectorXd &positioner_sample_resolution, std::string solver_name=DEFAULT_REP_INV_KIN_SOLVER_NAME)
 
void nested_ik (IKSolutions &solutions, int loop_level, const std::vector< Eigen::VectorXd > &dof_range, const tesseract_common::TransformMap &tip_link_poses, Eigen::VectorXd &positioner_pose, const Eigen::Ref< const Eigen::VectorXd > &seed) const
 

Private Attributes

Eigen::Index dof_ { -1 }
 
std::vector< Eigen::VectorXd > dof_range_
 
std::vector< std::string > joint_names_
 
Eigen::Isometry3d manip_base_to_positioner_base_
 
InverseKinematics::UPtr manip_inv_kin_
 
double manip_reach_ { 0 }
 
std::string manip_tip_link_
 
std::unique_ptr< ForwardKinematicspositioner_fwd_kin_
 
std::string solver_name_ { DEFAULT_REP_INV_KIN_SOLVER_NAME }
 Name of this solver. More...
 
std::string working_frame_
 

Detailed Description

Robot With External Positioner Inverse kinematic implementation.

In this kinematic arrangement the base link is the tip link of the external positioner and the tip link is the tip link of the manipulator. Therefore all provided target poses are expected to the tip link of the positioner.

Definition at line 49 of file rep_inv_kin.h.

Member Typedef Documentation

◆ ConstPtr

using tesseract_kinematics::REPInvKin::ConstPtr = std::shared_ptr<const REPInvKin>

Definition at line 57 of file rep_inv_kin.h.

◆ ConstUPtr

using tesseract_kinematics::REPInvKin::ConstUPtr = std::unique_ptr<const REPInvKin>

Definition at line 59 of file rep_inv_kin.h.

◆ Ptr

Definition at line 56 of file rep_inv_kin.h.

◆ UPtr

Definition at line 58 of file rep_inv_kin.h.

Constructor & Destructor Documentation

◆ ~REPInvKin()

tesseract_kinematics::REPInvKin::~REPInvKin ( )
overridedefault

◆ REPInvKin() [1/4]

tesseract_kinematics::REPInvKin::REPInvKin ( const REPInvKin other)

Definition at line 158 of file rep_inv_kin.cpp.

◆ REPInvKin() [2/4]

tesseract_kinematics::REPInvKin::REPInvKin ( REPInvKin &&  )
default

◆ REPInvKin() [3/4]

tesseract_kinematics::REPInvKin::REPInvKin ( const tesseract_scene_graph::SceneGraph scene_graph,
const tesseract_scene_graph::SceneState scene_state,
InverseKinematics::UPtr  manipulator,
double  manipulator_reach,
std::unique_ptr< ForwardKinematics positioner,
const Eigen::VectorXd &  positioner_sample_resolution,
std::string  solver_name = DEFAULT_REP_INV_KIN_SOLVER_NAME 
)

Construct Inverse Kinematics for a robot on a positioner.

Parameters
scene_graphThe Tesseract Scene Graph
scene_stateThe Tesseract Scene State
manipulator
manipulator_reach
positioner
positioner_sample_resolution
solver_nameThe name given to the solver. This is exposed so you may have same solver with different

Definition at line 38 of file rep_inv_kin.cpp.

◆ REPInvKin() [4/4]

tesseract_kinematics::REPInvKin::REPInvKin ( const tesseract_scene_graph::SceneGraph scene_graph,
const tesseract_scene_graph::SceneState scene_state,
InverseKinematics::UPtr  manipulator,
double  manipulator_reach,
std::unique_ptr< ForwardKinematics positioner,
const Eigen::MatrixX2d &  positioner_sample_range,
const Eigen::VectorXd &  positioner_sample_resolution,
std::string  solver_name = DEFAULT_REP_INV_KIN_SOLVER_NAME 
)

Construct Inverse Kinematics for a robot on a positioner.

Parameters
scene_graphThe Tesseract Scene Graph
manipulator
manipulator_reach
positioner
positioner_sample_range
positioner_sample_resolution
solver_nameThe name given to the solver. This is exposed so you may have same solver with different sampling resolutions

Definition at line 73 of file rep_inv_kin.cpp.

Member Function Documentation

◆ calcInvKin()

IKSolutions tesseract_kinematics::REPInvKin::calcInvKin ( const tesseract_common::TransformMap tip_link_poses,
const Eigen::Ref< const Eigen::VectorXd > &  seed 
) const
finaloverridevirtual

Calculates joint solutions given a pose for each tip link.

This interface supports IK for both kinematic chains that have a single tool tip link and kinematic chains that have multiple tip links. For example, consider a robot with external part positioner: a pose can be specified to be relative to the tip link of the robot or the tip link of the positioner is to support a pose relative to a active link. For example a robot with an external positioner where the pose is relative to the tip link of the positioner.

Note
Redundant joint solutions can be provided by the utility function getRedundantSolutions
Parameters
tip_link_posesA map of poses corresponding to each tip link provided in getTipLinkNames and relative to the working frame of the kinematics group for which to solve inverse kinematics
seedVector of seed joint angles (size must match number of joints in kinematic object)
Returns
A vector of solutions, If empty it failed to find a solution (including uninitialized)

Implements tesseract_kinematics::InverseKinematics.

Definition at line 235 of file rep_inv_kin.cpp.

◆ calcInvKinHelper()

IKSolutions tesseract_kinematics::REPInvKin::calcInvKinHelper ( const tesseract_common::TransformMap tip_link_poses,
const Eigen::Ref< const Eigen::VectorXd > &  seed 
) const
private

calcFwdKin helper function

Definition at line 175 of file rep_inv_kin.cpp.

◆ clone()

InverseKinematics::UPtr tesseract_kinematics::REPInvKin::clone ( ) const
finaloverridevirtual

Clone the forward kinematics object.

Implements tesseract_kinematics::InverseKinematics.

Definition at line 156 of file rep_inv_kin.cpp.

◆ getBaseLinkName()

std::string tesseract_kinematics::REPInvKin::getBaseLinkName ( ) const
finaloverridevirtual

Get the robot base link name.

Implements tesseract_kinematics::InverseKinematics.

Definition at line 249 of file rep_inv_kin.cpp.

◆ getJointNames()

std::vector< std::string > tesseract_kinematics::REPInvKin::getJointNames ( ) const
finaloverridevirtual

Get list of joint names for kinematic object.

Returns
A vector of joint names, joint_list_

Implements tesseract_kinematics::InverseKinematics.

Definition at line 245 of file rep_inv_kin.cpp.

◆ getSolverName()

std::string tesseract_kinematics::REPInvKin::getSolverName ( ) const
finaloverridevirtual

Get the name of the solver. Recommend using the name of the class.

Implements tesseract_kinematics::InverseKinematics.

Definition at line 255 of file rep_inv_kin.cpp.

◆ getTipLinkNames()

std::vector< std::string > tesseract_kinematics::REPInvKin::getTipLinkNames ( ) const
finaloverridevirtual

Get the names of the tip links of the kinematics group.

In the case of a kinematic chain, this returns one tip link; in the case of a kinematic tree this returns the tip link for each branch of the tree.

Implements tesseract_kinematics::InverseKinematics.

Definition at line 253 of file rep_inv_kin.cpp.

◆ getWorkingFrame()

std::string tesseract_kinematics::REPInvKin::getWorkingFrame ( ) const
finaloverridevirtual

Get the inverse kinematics working frame.

This is the frame of reference in which all poses given to the calcInvKin function should be defined

Implements tesseract_kinematics::InverseKinematics.

Definition at line 251 of file rep_inv_kin.cpp.

◆ ikAt()

void tesseract_kinematics::REPInvKin::ikAt ( IKSolutions solutions,
const tesseract_common::TransformMap tip_link_poses,
Eigen::VectorXd &  positioner_pose,
const Eigen::Ref< const Eigen::VectorXd > &  seed 
) const
private

Definition at line 204 of file rep_inv_kin.cpp.

◆ init()

void tesseract_kinematics::REPInvKin::init ( const tesseract_scene_graph::SceneGraph scene_graph,
const tesseract_scene_graph::SceneState scene_state,
InverseKinematics::UPtr  manipulator,
double  manipulator_reach,
std::unique_ptr< ForwardKinematics positioner,
const Eigen::MatrixX2d &  poitioner_sample_range,
const Eigen::VectorXd &  positioner_sample_resolution,
std::string  solver_name = DEFAULT_REP_INV_KIN_SOLVER_NAME 
)
private

Definition at line 92 of file rep_inv_kin.cpp.

◆ nested_ik()

void tesseract_kinematics::REPInvKin::nested_ik ( IKSolutions solutions,
int  loop_level,
const std::vector< Eigen::VectorXd > &  dof_range,
const tesseract_common::TransformMap tip_link_poses,
Eigen::VectorXd &  positioner_pose,
const Eigen::Ref< const Eigen::VectorXd > &  seed 
) const
private

Definition at line 184 of file rep_inv_kin.cpp.

◆ numJoints()

Eigen::Index tesseract_kinematics::REPInvKin::numJoints ( ) const
finaloverridevirtual

Number of joints in robot.

Returns
Number of joints in robot

Implements tesseract_kinematics::InverseKinematics.

Definition at line 247 of file rep_inv_kin.cpp.

◆ operator=() [1/2]

REPInvKin & tesseract_kinematics::REPInvKin::operator= ( const REPInvKin other)

Definition at line 160 of file rep_inv_kin.cpp.

◆ operator=() [2/2]

REPInvKin& tesseract_kinematics::REPInvKin::operator= ( REPInvKin &&  )
default

Member Data Documentation

◆ dof_

Eigen::Index tesseract_kinematics::REPInvKin::dof_ { -1 }
private

Definition at line 124 of file rep_inv_kin.h.

◆ dof_range_

std::vector<Eigen::VectorXd> tesseract_kinematics::REPInvKin::dof_range_
private

Definition at line 125 of file rep_inv_kin.h.

◆ joint_names_

std::vector<std::string> tesseract_kinematics::REPInvKin::joint_names_
private

Definition at line 117 of file rep_inv_kin.h.

◆ manip_base_to_positioner_base_

Eigen::Isometry3d tesseract_kinematics::REPInvKin::manip_base_to_positioner_base_
private

Definition at line 123 of file rep_inv_kin.h.

◆ manip_inv_kin_

InverseKinematics::UPtr tesseract_kinematics::REPInvKin::manip_inv_kin_
private

Definition at line 118 of file rep_inv_kin.h.

◆ manip_reach_

double tesseract_kinematics::REPInvKin::manip_reach_ { 0 }
private

Definition at line 122 of file rep_inv_kin.h.

◆ manip_tip_link_

std::string tesseract_kinematics::REPInvKin::manip_tip_link_
private

Definition at line 121 of file rep_inv_kin.h.

◆ positioner_fwd_kin_

std::unique_ptr<ForwardKinematics> tesseract_kinematics::REPInvKin::positioner_fwd_kin_
private

Definition at line 119 of file rep_inv_kin.h.

◆ solver_name_

std::string tesseract_kinematics::REPInvKin::solver_name_ { DEFAULT_REP_INV_KIN_SOLVER_NAME }
private

Name of this solver.

Definition at line 126 of file rep_inv_kin.h.

◆ working_frame_

std::string tesseract_kinematics::REPInvKin::working_frame_
private

Definition at line 120 of file rep_inv_kin.h.


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


tesseract_kinematics
Author(s): Levi Armstrong
autogenerated on Sun May 18 2025 03:02:14