Tesseract 0.28.4
Loading...
Searching...
No Matches
tesseract::kinematics::OPWInvKin Class Reference

OPW Inverse Kinematics Implementation. More...

#include <opw_inv_kin.h>

Inheritance diagram for tesseract::kinematics::OPWInvKin:

Public Types

using Ptr = std::shared_ptr<OPWInvKin>
using ConstPtr = std::shared_ptr<const OPWInvKin>
using UPtr = std::unique_ptr<OPWInvKin>
using ConstUPtr = std::unique_ptr<const OPWInvKin>
Public Types inherited from tesseract::kinematics::InverseKinematics
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

 OPWInvKin (const OPWInvKin &other)
OPWInvKin & operator= (const OPWInvKin &other)
 OPWInvKin (OPWInvKin &&)=default
OPWInvKin & operator= (OPWInvKin &&)=default
 OPWInvKin (opw_kinematics::Parameters< double > params, tesseract::common::LinkId base_link_id, tesseract::common::LinkId tip_link_id, std::vector< common::JointId > joint_ids, std::string solver_name=OPW_INV_KIN_CHAIN_SOLVER_NAME)
 Construct OPW Inverse Kinematics.
void calcInvKin (IKSolutions &solutions, const tesseract::common::LinkIdTransformMap &tip_link_poses, const Eigen::Ref< const Eigen::VectorXd > &seed) const override final
 Calculates joint solutions given a pose for each tip link.
Eigen::Index numJoints () const override final
 Number of joints in robot.
std::vector< tesseract::common::JointId > getJointIds () const override final
 Get list of joint ids for kinematic object.
tesseract::common::LinkId getBaseLinkId () const override final
 Get the robot base link id.
tesseract::common::LinkId getWorkingFrame () const override final
 Get the inverse kinematics working frame.
std::vector< tesseract::common::LinkId > getTipLinkIds () const override final
 Get the ids of the tip links of the kinematics group.
std::string getSolverName () const override final
 Get the name of the solver. Recommend using the name of the class.
InverseKinematics::UPtr clone () const override final
 Clone the forward kinematics object.
Public Member Functions inherited from tesseract::kinematics::InverseKinematics
 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.

Protected Attributes

opw_kinematics::Parameters< double > params_
 The opw kinematics parameters.
tesseract::common::LinkId base_link_id_
 First link in the kinematic object.
tesseract::common::LinkId tip_link_id_
 Last link in the kinematic object.
std::vector< tesseract::common::JointId > joint_ids_
 Joints of the kinematic object.
std::string solver_name_ { OPW_INV_KIN_CHAIN_SOLVER_NAME }
 Name of this solver.

Detailed Description

OPW Inverse Kinematics Implementation.

Constructor & Destructor Documentation

◆ OPWInvKin()

tesseract::kinematics::OPWInvKin::OPWInvKin ( opw_kinematics::Parameters< double > params,
tesseract::common::LinkId base_link_id,
tesseract::common::LinkId tip_link_id,
std::vector< common::JointId > joint_ids,
std::string solver_name = OPW_INV_KIN_CHAIN_SOLVER_NAME )

Construct OPW Inverse Kinematics.

Parameters
paramsOPW kinematics parameters
base_link_idThe id of the base link for the kinematic chain
tip_link_idThe id of the tip link for the kinematic chain
joint_idsThe joint ids for the kinematic chain
solver_nameThe solver name of the kinematic chain

Member Function Documentation

◆ calcInvKin()

void tesseract::kinematics::OPWInvKin::calcInvKin ( IKSolutions & solutions,
const tesseract::common::LinkIdTransformMap & 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
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)

Implements tesseract::kinematics::InverseKinematics.

◆ numJoints()

Eigen::Index tesseract::kinematics::OPWInvKin::numJoints ( ) const
finaloverridevirtual

Number of joints in robot.

Returns
Number of joints in robot

Implements tesseract::kinematics::InverseKinematics.

◆ getJointIds()

std::vector< tesseract::common::JointId > tesseract::kinematics::OPWInvKin::getJointIds ( ) const
finaloverridevirtual

Get list of joint ids for kinematic object.

Returns
A vector of joint ids

Implements tesseract::kinematics::InverseKinematics.

◆ getBaseLinkId()

tesseract::common::LinkId tesseract::kinematics::OPWInvKin::getBaseLinkId ( ) const
finaloverridevirtual

Get the robot base link id.

Implements tesseract::kinematics::InverseKinematics.

◆ getWorkingFrame()

tesseract::common::LinkId tesseract::kinematics::OPWInvKin::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.

◆ getTipLinkIds()

std::vector< tesseract::common::LinkId > tesseract::kinematics::OPWInvKin::getTipLinkIds ( ) const
finaloverridevirtual

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.

Implements tesseract::kinematics::InverseKinematics.

◆ getSolverName()

std::string tesseract::kinematics::OPWInvKin::getSolverName ( ) const
finaloverridevirtual

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

Implements tesseract::kinematics::InverseKinematics.

◆ clone()

InverseKinematics::UPtr tesseract::kinematics::OPWInvKin::clone ( ) const
finaloverridevirtual

Clone the forward kinematics object.

Implements tesseract::kinematics::InverseKinematics.