Tesseract 0.28.4
Loading...
Searching...
No Matches
tesseract::kinematics::InverseKinematics Class Referenceabstract

Inverse kinematics functions. More...

#include <inverse_kinematics.h>

Inheritance diagram for tesseract::kinematics::InverseKinematics:

Public Types

using Ptr = std::shared_ptr<InverseKinematics>
using ConstPtr = std::shared_ptr<const InverseKinematics>
using UPtr = std::unique_ptr<InverseKinematics>
using ConstUPtr = std::unique_ptr<const InverseKinematics>

Public Member Functions

 InverseKinematics (const InverseKinematics &)=default
InverseKinematics & operator= (const InverseKinematics &)=default
 InverseKinematics (InverseKinematics &&)=default
InverseKinematics & operator= (InverseKinematics &&)=default
IKSolutions calcInvKin (const tesseract::common::LinkIdTransformMap &tip_link_poses, const Eigen::Ref< const Eigen::VectorXd > &seed) const
 Calculates joint solutions given a pose for each tip link.
virtual void calcInvKin (IKSolutions &solutions, const tesseract::common::LinkIdTransformMap &tip_link_poses, const Eigen::Ref< const Eigen::VectorXd > &seed) const =0
 Calculates joint solutions given a pose for each tip link.
virtual std::vector< tesseract::common::JointId > getJointIds () const =0
 Get list of joint ids for kinematic object.
virtual Eigen::Index numJoints () const =0
 Number of joints in robot.
virtual tesseract::common::LinkId getBaseLinkId () const =0
 Get the robot base link id.
virtual tesseract::common::LinkId getWorkingFrame () const =0
 Get the inverse kinematics working frame.
virtual std::vector< tesseract::common::LinkId > getTipLinkIds () const =0
 Get the ids of the tip links of the kinematics group.
virtual std::string getSolverName () const =0
 Get the name of the solver. Recommend using the name of the class.
virtual InverseKinematics::UPtr clone () const =0
 Clone the forward kinematics object.

Detailed Description

Inverse kinematics functions.

Member Function Documentation

◆ calcInvKin() [1/2]

IKSolutions tesseract::kinematics::InverseKinematics::calcInvKin ( const tesseract::common::LinkIdTransformMap & tip_link_poses,
const Eigen::Ref< const Eigen::VectorXd > & seed ) const

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 getTipLinkIds 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)

◆ calcInvKin() [2/2]

virtual void tesseract::kinematics::InverseKinematics::calcInvKin ( IKSolutions & solutions,
const tesseract::common::LinkIdTransformMap & tip_link_poses,
const Eigen::Ref< const Eigen::VectorXd > & seed ) const
pure virtual

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
solutionsThe object to store the calculated solutions
tip_link_posesA map of poses corresponding to each tip link provided in getTipLinkIds 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)

Implemented in tesseract::kinematics::IKFastInvKin, tesseract::kinematics::KDLInvKinChainLMA, tesseract::kinematics::KDLInvKinChainNR, tesseract::kinematics::KDLInvKinChainNR_JL, tesseract::kinematics::OPWInvKin, tesseract::kinematics::REPInvKin, tesseract::kinematics::ROPInvKin, tesseract::kinematics::RTPInvKin, and tesseract::kinematics::URInvKin.

◆ getJointIds()

virtual std::vector< tesseract::common::JointId > tesseract::kinematics::InverseKinematics::getJointIds ( ) const
pure virtual

◆ numJoints()

◆ getBaseLinkId()

◆ getWorkingFrame()

virtual tesseract::common::LinkId tesseract::kinematics::InverseKinematics::getWorkingFrame ( ) const
pure virtual

◆ getTipLinkIds()

virtual std::vector< tesseract::common::LinkId > tesseract::kinematics::InverseKinematics::getTipLinkIds ( ) const
pure virtual

Get the ids 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.

Implemented in tesseract::kinematics::IKFastInvKin, tesseract::kinematics::KDLInvKinChainLMA, tesseract::kinematics::KDLInvKinChainNR, tesseract::kinematics::KDLInvKinChainNR_JL, tesseract::kinematics::OPWInvKin, tesseract::kinematics::REPInvKin, tesseract::kinematics::ROPInvKin, tesseract::kinematics::RTPInvKin, and tesseract::kinematics::URInvKin.

◆ getSolverName()

◆ clone()