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

IKFast Inverse Kinematics Implmentation. More...

#include <ikfast_inv_kin.h>

Inheritance diagram for tesseract::kinematics::IKFastInvKin:

Public Types

using Ptr = std::shared_ptr<IKFastInvKin>
using ConstPtr = std::shared_ptr<const IKFastInvKin>
using UPtr = std::unique_ptr<IKFastInvKin>
using ConstUPtr = std::unique_ptr<const IKFastInvKin>
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

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

Static Public Member Functions

static std::vector< std::vector< double > > generateAllFreeJointStateCombinations (const std::vector< std::vector< double > > &free_joint_samples)
 Generates all possible combinations of joint states and stores it to the free_joint_states_ class member Example: Given 2 free joints, wanting to sample the first joint at 0, 1, and 2 and the second joint at 3 and 4 the input would be [[0, 1, 2][3,4]] and it would generate [[0,3][0,4][1,3][1,4][2,3][2,4]].

Protected Attributes

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_ { IKFAST_INV_KIN_CHAIN_SOLVER_NAME }
 Name of this solver.
std::vector< std::vector< double > > free_joint_states_

Detailed Description

IKFast Inverse Kinematics Implmentation.

This along with the ikfast_inv_kin.hpp is to be used with a generated ikfast to create a tesseract implementation. Once you have created your ikfast solver of your robot all you need is to create header similar to what is shown below:

Header File: fanuc_p50ib_15_inv_kinematics.h

#include <Eigen/Geometry> #include <vector> #include <tesseract/kinematics/ikfast/ikfast_inv_kin.h>

namespace fanuc_p50ib_15_ikfast_wrapper { class FanucP50iBInvKinematics : public tesseract::kinematics::IKFastInvKin { public: FanucP50iBInvKinematics(tesseract::common::LinkId base_link_id, tesseract::common::LinkId tip_link_id, std::vector<tesseract::common::JointId> joint_ids, std::string solver_name); };

Cpp File:

#include <tesseract/kinematics/ikfast/impl/ikfast_inv_kin.hpp> #include <fanuc_p50ib_15_ikfast_wrapper/impl/fanuc_p50ib_15_ikfast.hpp> #include <fanuc_p50ib_15_ikfast_wrapper/tesseract_fanuc_p50ib_kinematics.h>

namespace fanuc_p50ib_15_ikfast_wrapper { FanucP50iBInvKinematics::FanucP50iBInvKinematics(tesseract::common::LinkId base_link_id, tesseract::common::LinkId tip_link_id, std::vector<tesseract::common::JointId> joint_ids, std::string solver_name) : IKFastInvKin(std::move(base_link_id), std::move(tip_link_id), std::move(joint_ids), std::move(solver_name)) {} }

Constructor & Destructor Documentation

◆ IKFastInvKin()

tesseract::kinematics::IKFastInvKin::IKFastInvKin ( tesseract::common::LinkId base_link_id,
tesseract::common::LinkId tip_link_id,
std::vector< common::JointId > joint_ids,
std::string solver_name = IKFAST_INV_KIN_CHAIN_SOLVER_NAME,
std::vector< std::vector< double > > free_joint_states = {} )
inline

Construct IKFast Inverse 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
free_joint_statesThe free joint states

Member Function Documentation

◆ calcInvKin()

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

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::IKFastInvKin::numJoints ( ) const
inlineoverridevirtual

Number of joints in robot.

Returns
Number of joints in robot

Implements tesseract::kinematics::InverseKinematics.

◆ getJointIds()

std::vector< tesseract::common::JointId > tesseract::kinematics::IKFastInvKin::getJointIds ( ) const
inlineoverridevirtual

Get list of joint ids for kinematic object.

Returns
A vector of joint ids

Implements tesseract::kinematics::InverseKinematics.

◆ getBaseLinkId()

tesseract::common::LinkId tesseract::kinematics::IKFastInvKin::getBaseLinkId ( ) const
inlineoverridevirtual

Get the robot base link id.

Implements tesseract::kinematics::InverseKinematics.

◆ getWorkingFrame()

tesseract::common::LinkId tesseract::kinematics::IKFastInvKin::getWorkingFrame ( ) const
inlineoverridevirtual

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::IKFastInvKin::getTipLinkIds ( ) const
inlineoverridevirtual

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::IKFastInvKin::getSolverName ( ) const
inlineoverridevirtual

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

Implements tesseract::kinematics::InverseKinematics.

◆ clone()

InverseKinematics::UPtr tesseract::kinematics::IKFastInvKin::clone ( ) const
inlineoverridevirtual

Clone the forward kinematics object.

Implements tesseract::kinematics::InverseKinematics.

◆ generateAllFreeJointStateCombinations()

std::vector< std::vector< double > > tesseract::kinematics::IKFastInvKin::generateAllFreeJointStateCombinations ( const std::vector< std::vector< double > > & free_joint_samples)
inlinestatic

Generates all possible combinations of joint states and stores it to the free_joint_states_ class member Example: Given 2 free joints, wanting to sample the first joint at 0, 1, and 2 and the second joint at 3 and 4 the input would be [[0, 1, 2][3,4]] and it would generate [[0,3][0,4][1,3][1,4][2,3][2,4]].

Parameters
free_joint_samplesA vector of vectors in which the lower level vectors each represent all of a single joint's possible positions to be sampled
Returns

Member Data Documentation

◆ solver_name_

std::string tesseract::kinematics::IKFastInvKin::solver_name_ { IKFAST_INV_KIN_CHAIN_SOLVER_NAME }
protected

Name of this solver.

combinations of free joints to sample when computing IK Example: Given 3 free joints, a valid input would be [[0,0,0][0,0,1][-1,0,1][0,2,0]]