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

Forward kinematics functions. More...

#include <forward_kinematics.h>

Inheritance diagram for tesseract::kinematics::ForwardKinematics:

Public Types

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

Public Member Functions

 ForwardKinematics (const ForwardKinematics &)=default
ForwardKinematics & operator= (const ForwardKinematics &)=default
 ForwardKinematics (ForwardKinematics &&)=default
ForwardKinematics & operator= (ForwardKinematics &&)=default
tesseract::common::LinkIdTransformMap calcFwdKin (const Eigen::Ref< const Eigen::VectorXd > &joint_angles) const
 Calculates the transform for each tip link in the kinematic group.
Eigen::MatrixXd calcJacobian (const Eigen::Ref< const Eigen::VectorXd > &joint_angles, const tesseract::common::LinkId &link_id) const
 Calculates the Jacobian matrix for a given joint state in the reference frame of the specified link.
virtual void calcFwdKin (tesseract::common::LinkIdTransformMap &transforms, const Eigen::Ref< const Eigen::VectorXd > &joint_angles) const =0
 Calculates the transform for each tip link in the kinematic group.
virtual void calcJacobian (Eigen::Ref< Eigen::MatrixXd > jacobian, const Eigen::Ref< const Eigen::VectorXd > &joint_angles, const tesseract::common::LinkId &link_id) const =0
 Calculates the Jacobian matrix for a given joint state in the reference frame of the specified link.
virtual tesseract::common::LinkId getBaseLinkId () const =0
 Get the robot base link id.
virtual std::vector< tesseract::common::JointId > getJointIds () const =0
 Get list of joint ids for kinematic object.
virtual std::vector< tesseract::common::LinkId > getTipLinkIds () const =0
 Get list of tip link ids for kinematic object.
virtual Eigen::Index numJoints () const =0
 Number of joints in robot.
virtual std::string getSolverName () const =0
 Get the name of the solver. Recommend using the name of the class.
virtual ForwardKinematics::UPtr clone () const =0
 Clone the forward kinematics object.

Detailed Description

Forward kinematics functions.

Member Function Documentation

◆ calcFwdKin() [1/2]

tesseract::common::LinkIdTransformMap tesseract::kinematics::ForwardKinematics::calcFwdKin ( const Eigen::Ref< const Eigen::VectorXd > & joint_angles) const

Calculates the transform for each tip link in the kinematic group.

This should return a transform for every link listed in getTipLinkIds() Throws an exception on failures (including uninitialized)

Parameters
joint_anglesVector of joint angles (size must match number of joints in robot chain)
Returns
A map of link IDs to transforms

◆ calcJacobian() [1/2]

Eigen::MatrixXd tesseract::kinematics::ForwardKinematics::calcJacobian ( const Eigen::Ref< const Eigen::VectorXd > & joint_angles,
const tesseract::common::LinkId & link_id ) const

Calculates the Jacobian matrix for a given joint state in the reference frame of the specified link.

This should be able to return a jacobian given any link listed in getTipLinkIds() Throws an exception on failures (including uninitialized)

Parameters
joint_anglesInput vector of joint angles
link_idThe link id to calculate jacobian
Returns
The jacobian at the provided link

◆ calcFwdKin() [2/2]

virtual void tesseract::kinematics::ForwardKinematics::calcFwdKin ( tesseract::common::LinkIdTransformMap & transforms,
const Eigen::Ref< const Eigen::VectorXd > & joint_angles ) const
pure virtual

Calculates the transform for each tip link in the kinematic group.

This should return a transform for every link listed in getTipLinkIds() Throws an exception on failures (including uninitialized)

Parameters
transforms(out)The object to populate with transforms
joint_anglesVector of joint angles (size must match number of joints in robot chain)

Implemented in tesseract::kinematics::KDLFwdKinChain.

◆ calcJacobian() [2/2]

virtual void tesseract::kinematics::ForwardKinematics::calcJacobian ( Eigen::Ref< Eigen::MatrixXd > jacobian,
const Eigen::Ref< const Eigen::VectorXd > & joint_angles,
const tesseract::common::LinkId & link_id ) const
pure virtual

Calculates the Jacobian matrix for a given joint state in the reference frame of the specified link.

This should be able to return a jacobian given any link listed in getTipLinkIds() Throws an exception on failures (including uninitialized)

Parameters
jacobian[out]The object to populate (assumes already the correct size)
joint_anglesInput vector of joint angles
link_idThe link id to calculate jacobian
Returns
The jacobian at the provided link

Implemented in tesseract::kinematics::KDLFwdKinChain.

◆ getBaseLinkId()

virtual tesseract::common::LinkId tesseract::kinematics::ForwardKinematics::getBaseLinkId ( ) const
pure virtual

Get the robot base link id.

Implemented in tesseract::kinematics::KDLFwdKinChain.

◆ getJointIds()

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

Get list of joint ids for kinematic object.

Returns
A vector of joint ids

Implemented in tesseract::kinematics::KDLFwdKinChain.

◆ getTipLinkIds()

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

Get list of tip link ids for kinematic object.

Returns
A vector of link ids

Implemented in tesseract::kinematics::KDLFwdKinChain.

◆ numJoints()

virtual Eigen::Index tesseract::kinematics::ForwardKinematics::numJoints ( ) const
pure virtual

Number of joints in robot.

Returns
Number of joints in robot

Implemented in tesseract::kinematics::KDLFwdKinChain.

◆ getSolverName()

virtual std::string tesseract::kinematics::ForwardKinematics::getSolverName ( ) const
pure virtual

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

Implemented in tesseract::kinematics::KDLFwdKinChain.

◆ clone()

virtual ForwardKinematics::UPtr tesseract::kinematics::ForwardKinematics::clone ( ) const
pure virtual

Clone the forward kinematics object.

Implemented in tesseract::kinematics::KDLFwdKinChain.