Tesseract 0.28.4
Loading...
Searching...
No Matches
tesseract::kinematics::KinematicGroup Class Reference
Inheritance diagram for tesseract::kinematics::KinematicGroup:

Public Types

using Ptr = std::shared_ptr<KinematicGroup>
using ConstPtr = std::shared_ptr<const KinematicGroup>
using UPtr = std::unique_ptr<KinematicGroup>
using ConstUPtr = std::unique_ptr<const KinematicGroup>
Public Types inherited from tesseract::kinematics::JointGroup
using Ptr = std::shared_ptr<JointGroup>
using ConstPtr = std::shared_ptr<const JointGroup>
using UPtr = std::unique_ptr<JointGroup>
using ConstUPtr = std::unique_ptr<const JointGroup>

Public Member Functions

 KinematicGroup (const KinematicGroup &other)
KinematicGroup & operator= (const KinematicGroup &other)
 KinematicGroup (KinematicGroup &&)=default
KinematicGroup & operator= (KinematicGroup &&)=default
 KinematicGroup (std::string name, const std::vector< tesseract::common::JointId > &joint_ids, std::unique_ptr< InverseKinematics > inv_kin, const tesseract::scene_graph::SceneGraph &scene_graph, const tesseract::scene_graph::SceneState &scene_state)
 Create a kinematics group with inverse kinematics.
IKSolutions calcInvKin (const KinGroupIKInputs &tip_link_poses, const Eigen::Ref< const Eigen::VectorXd > &seed) const
 Calculates joint solutions given a pose.
IKSolutions calcInvKin (const KinGroupIKInput &tip_link_pose, const Eigen::Ref< const Eigen::VectorXd > &seed) const
 Calculates joint solutions given a pose.
void calcInvKin (IKSolutions &solutions, const KinGroupIKInputs &tip_link_poses, const Eigen::Ref< const Eigen::VectorXd > &seed) const
 Calculates joint solutions given a pose.
void calcInvKin (IKSolutions &solutions, const KinGroupIKInput &tip_link_pose, const Eigen::Ref< const Eigen::VectorXd > &seed) const
 Calculates joint solutions given a pose.
std::vector< tesseract::common::LinkId > getAllValidWorkingFrames () const
 Returns all possible working frames in which goal poses can be defined.
std::vector< tesseract::common::LinkId > getAllPossibleTipLinkIds () const
 Get all possible tip link IDs.
const InverseKinematics & getInverseKinematics () const
 Get the inverse kinematics sovler.
Public Member Functions inherited from tesseract::kinematics::JointGroup
 JointGroup (const JointGroup &other)
JointGroup & operator= (const JointGroup &other)
 JointGroup (JointGroup &&)=default
JointGroup & operator= (JointGroup &&)=default
 JointGroup (std::string name, std::vector< tesseract::common::JointId > joint_ids, const tesseract::scene_graph::SceneGraph &scene_graph, const tesseract::scene_graph::SceneState &scene_state)
 Create a kinematics group without inverse kinematics for the provided joint ids.
tesseract::common::LinkIdTransformMap calcFwdKin (const Eigen::Ref< const Eigen::VectorXd > &joint_angles) const
 Calculates tool pose of robot chain.
void calcFwdKin (tesseract::common::LinkIdTransformMap &transforms, const Eigen::Ref< const Eigen::VectorXd > &joint_angles) const
 Calculates tool pose of robot chain.
Eigen::MatrixXd calcJacobian (const Eigen::Ref< const Eigen::VectorXd > &joint_angles, const tesseract::common::LinkId &link_id) const
 Calculates jacobian of robot given joint angles.
Eigen::MatrixXd calcJacobian (const Eigen::Ref< const Eigen::VectorXd > &joint_angles, const tesseract::common::LinkId &link_id, const Eigen::Vector3d &link_point) const
 Calculates jacobian of robot given joint angles.
Eigen::MatrixXd calcJacobian (const Eigen::Ref< const Eigen::VectorXd > &joint_angles, const tesseract::common::LinkId &base_link_id, const tesseract::common::LinkId &link_id) const
 Calculates jacobian of robot given joint angles.
Eigen::MatrixXd calcJacobian (const Eigen::Ref< const Eigen::VectorXd > &joint_angles, const tesseract::common::LinkId &base_link_id, const tesseract::common::LinkId &link_id, const Eigen::Vector3d &link_point) const
 Calculates jacobian of robot given joint angles.
const std::vector< tesseract::common::JointId > & getJointIds () const
 Get list of joint ids for kinematic object.
const std::vector< tesseract::common::LinkId > & getLinkIds () const
 Get list of all link ids (with and without geometry) for kinematic object.
const std::vector< tesseract::common::LinkId > & getActiveLinkIds () const
 Get list of active link ids (with and without geometry) for kinematic object.
const std::vector< tesseract::common::LinkId > & getStaticLinkIds () const
 Get list of static link ids (with and without geometry) for kinematic object.
bool isActiveLinkId (const tesseract::common::LinkId &link_id) const
 Check if link is an active link.
bool hasLinkId (const tesseract::common::LinkId &link_id) const
 Check if link id exists.
tesseract::common::KinematicLimits getLimits () const
 Get the kinematic limits (joint, velocity, acceleration, etc.).
void setLimits (const tesseract::common::KinematicLimits &limits)
 Setter for kinematic limits (joint, velocity, acceleration, etc.).
std::vector< Eigen::Index > getRedundancyCapableJointIndices () const
 Get vector indicating which joints are capable of producing redundant solutions.
Eigen::Index numJoints () const
 Number of joints in robot.
tesseract::common::LinkId getBaseLinkId () const
 Get the robot base link ID.
std::string getName () const
 Name of the manipulator.
bool checkJoints (const Eigen::Ref< const Eigen::VectorXd > &vec) const
 Check for consistency in # and limits of joints.

Additional Inherited Members

Protected Attributes inherited from tesseract::kinematics::JointGroup
std::string name_
tesseract::scene_graph::SceneState state_
std::unique_ptr< tesseract::scene_graph::StateSolver > state_solver_
std::vector< tesseract::common::LinkId > link_ids_
std::vector< tesseract::common::JointId > joint_ids_
std::unordered_set< tesseract::common::LinkId > link_id_set_
std::vector< tesseract::common::LinkId > active_link_ids_
std::unordered_set< tesseract::common::LinkId > active_link_ids_set_
std::vector< tesseract::common::LinkId > static_link_ids_
tesseract::common::LinkIdTransformMap static_link_transforms_
tesseract::common::KinematicLimits limits_
std::vector< Eigen::Index > redundancy_indices_
std::vector< Eigen::Index > jacobian_map_

Constructor & Destructor Documentation

◆ KinematicGroup()

tesseract::kinematics::KinematicGroup::KinematicGroup ( std::string name,
const std::vector< tesseract::common::JointId > & joint_ids,
std::unique_ptr< InverseKinematics > inv_kin,
const tesseract::scene_graph::SceneGraph & scene_graph,
const tesseract::scene_graph::SceneState & scene_state )

Create a kinematics group with inverse kinematics.

Parameters
nameThe name of the kinematic group
inv_kinThe inverse kinematics object to create kinematic group from
scene_graphThe scene graph
scene_stateThe scene state

Member Function Documentation

◆ calcInvKin() [1/4]

IKSolutions tesseract::kinematics::KinematicGroup::calcInvKin ( const KinGroupIKInputs & tip_link_poses,
const Eigen::Ref< const Eigen::VectorXd > & seed ) const

Calculates joint solutions given a pose.

If redundant solutions are needed see utility function getRedundantSolutions.

Parameters
tip_link_posesThe input information to solve inverse kinematics for. There must be an input for each link provided in getAllPossibleTipLinkIds
seedVector of seed joint angles (size must match number of joints in robot chain)
Returns
A vector of solutions, If empty it failed to find a solution (including uninitialized)

◆ calcInvKin() [2/4]

IKSolutions tesseract::kinematics::KinematicGroup::calcInvKin ( const KinGroupIKInput & tip_link_pose,
const Eigen::Ref< const Eigen::VectorXd > & seed ) const

Calculates joint solutions given a pose.

If redundant solutions are needed see utility function getRedundantSolutions.

Parameters
tip_link_poseThe input information to solve inverse kinematics for. This is a convenience function for when only one tip link exists
seedVector of seed joint angles (size must match number of joints in robot chain)
Returns
A vector of solutions, If empty it failed to find a solution (including uninitialized)

◆ calcInvKin() [3/4]

void tesseract::kinematics::KinematicGroup::calcInvKin ( IKSolutions & solutions,
const KinGroupIKInputs & tip_link_poses,
const Eigen::Ref< const Eigen::VectorXd > & seed ) const

Calculates joint solutions given a pose.

If redundant solutions are needed see utility function getRedundantSolutions.

Parameters
solutionsThe object to populated with solutions
tip_link_posesThe input information to solve inverse kinematics for. There must be an input for each link provided in getAllPossibleTipLinkIds
seedVector of seed joint angles (size must match number of joints in robot chain)
Returns
A vector of solutions, If empty it failed to find a solution (including uninitialized)

◆ calcInvKin() [4/4]

void tesseract::kinematics::KinematicGroup::calcInvKin ( IKSolutions & solutions,
const KinGroupIKInput & tip_link_pose,
const Eigen::Ref< const Eigen::VectorXd > & seed ) const

Calculates joint solutions given a pose.

If redundant solutions are needed see utility function getRedundantSolutions.

Parameters
solutionsThe object to populated with solutions
tip_link_poseThe input information to solve inverse kinematics for. This is a convenience function for when only one tip link exists
seedVector of seed joint angles (size must match number of joints in robot chain)
Returns
A vector of solutions, If empty it failed to find a solution (including uninitialized)

◆ getAllValidWorkingFrames()

std::vector< tesseract::common::LinkId > tesseract::kinematics::KinematicGroup::getAllValidWorkingFrames ( ) const

Returns all possible working frames in which goal poses can be defined.

The inverse kinematics solver requires that all poses be defined relative to a single working frame. However if this working frame is static, a pose can be defined in another static frame in the environment and transformed into the IK solver working frame. Similarly if the working frame is an active link (e.g. attached to a part positioner), a target pose can also be defined relative to any child link of the working frame and transformed into the IK solver working frame. This function identifies all of these other possible working frames and performs the appropriate transformations internally when solving IK.

◆ getAllPossibleTipLinkIds()

std::vector< tesseract::common::LinkId > tesseract::kinematics::KinematicGroup::getAllPossibleTipLinkIds ( ) const

Get all possible tip link IDs.

The inverse kinematics solver requires that all poses be solved for a set of tip link frames that terminate a kinematic chain or tree. In the case of some closed-form IK solvers, this tip link must the tool flange of the robot rather than another preferred link. If the desired tip link is a statically connected child of the required IK solver tip link, then the target IK pose can be transformed into a target pose for the IK solver tip link. This function identifies all possible tip links that can be used for IK (i.e. static child links of the IK solver tip link(s)) and internally performs the appropriate transformations when solving IK

◆ getInverseKinematics()

const InverseKinematics & tesseract::kinematics::KinematicGroup::getInverseKinematics ( ) const

Get the inverse kinematics sovler.

Returns
The inverse kinematics solver