Convenience wrapper around TreeIK for solving chains with a single tip frame. More...

#include <ik.h>

Inheritance diagram for se2ez::ChainIK:

Public Member Functions
	ChainIK (const RobotPtr &robot, const std::string &frame, unsigned int iterations=50, double eps=1e-4)
	Constructor. More...

virtual	~ChainIK ()
	Destructor. More...

	ChainIK (const ChainIK &)=delete

	ChainIK (ChainIK &&)=delete

bool	solve (StatePtr state, const Eigen::Isometry2d &frame, Request request=ALL)
	Solve an IK request. More...

Public Member Functions inherited from se2ez::TreeIK
	TreeIK (const RobotPtr &robot, const std::vector< std::string > &frames, unsigned int iterations=50, double eps=1e-4)
	Constructor. More...

	TreeIK (const TreeIK &)=delete

	TreeIK (TreeIK &&)=delete

bool	solve (StatePtr state, const tf::EigenMap< std::string, Eigen::Isometry2d > &frames, const std::map< std::string, Request > &request={})
	Solve an IK request. More...

void	setJointWeight (const std::string &frame, const Eigen::VectorXd &weights) override
	Sets the weights on a specific joint in the robot for IK solving. More...

void	setJointWeights (const Eigen::VectorXd &weights) override
	Sets the weights for all joints in the robot for IK solving. More...

void	setLambda (double lambda) override
	Sets lambda, damping constant in WDLS. More...

Public Member Functions inherited from se2ez::IKSolver
	IKSolver (const IKSolver &)=delete

	IKSolver (IKSolver &&)=delete

void	setRestarts (unsigned int restarts)
	Sets the number of random restarts to use when solving a request. More...

Private Attributes
const std::string	frame_
	Task frame. More...

Additional Inherited Members
Public Types inherited from se2ez::IKSolver
enum	Request { NONE = 0, X_AXIS = 1 << 0, Y_AXIS = 1 << 1, ROTATION = 1 << 2, POSITION = X_AXIS \| Y_AXIS, ALL = POSITION \| ROTATION }
	A bitmask specification of what task components should this IK request satisfy. More...

Protected Types inherited from se2ez::IKSolver
enum	Index { POS_X = 0, POS_Y = 1, POS_Z = 2, ROT_X = 3, ROT_Y = 4, ROT_Z = 5 }
	KDL specific indices for different components of the task matrix. More...

Protected Member Functions inherited from se2ez::TreeIK
bool	setTask (KDL::Frames &goals, const tf::EigenMap< std::string, Eigen::Isometry2d > &frames, const std::map< std::string, Request > &request)
	Sets current task matrix and goals according to request. More...

virtual bool	doIK (KDL::JntArray &in, KDL::JntArray &out, const KDL::Frames &goals)
	Actually solve an IK query. More...

Protected Member Functions inherited from se2ez::IKSolver
	IKSolver (const RobotPtr &robot, unsigned int frames)
	Constructor. Protected so only derived classes can create this. More...

void	setRequest (unsigned int task, Request request)
	Sets the task matrix values for a task at index task according to a request. More...

void	setTask (unsigned int task, Index index, bool active)
	Sets the specific index component of a task to active. More...

void	setRandom (KDL::JntArray &array) const
	Sets a KDL array to random values between joint limits. More...

Protected Attributes inherited from se2ez::TreeIK
const std::map< std::string, unsigned int >	frames_
	Mapping of task frame name to index. More...

const KDL::Tree	tree_
	KDL tree used for solving. More...

KDL::TreeFkSolverPos_recursive	fk_
	Forward kinematics solver. More...

KDL::TreeIkSolverVel_wdls	velIK_
	Inverse velocity solver. More...

KDL::TreeIkSolverPos_NR_JL	posIK_
	Inverse position solver. More...

std::mutex	mutex_
	Thread mutex. More...

Protected Attributes inherited from se2ez::IKSolver
const unsigned int	n_
	Number of joint variables. More...

const unsigned int	t_
	Number of tasks. More...

const RobotPtr	robot_
	Reference to robot. More...

const KDL::JntArray	min_
	Joint minimums. More...

const KDL::JntArray	max_
	Joint maximums. More...

KDL::MatrixXd	weights_
	Joint variable weights. More...

KDL::MatrixXd	tasks_
	Task weights. More...

double	lambda_ {0.01}
	Lambda, WDLS constant. More...

unsigned int	restarts_ {10}
	Number of random restarts. More...

Detailed Description

Convenience wrapper around TreeIK for solving chains with a single tip frame.

Definition at line 216 of file ik.h.

Constructor & Destructor Documentation

◆ ChainIK() [1/3]

ChainIK::ChainIK	(	const RobotPtr &	robot,
		const std::string &	frame,
		unsigned int	iterations = `50`,
		double	eps = `1e-4`
	)

Constructor.

Parameters

[in]	robot	Robot to construct IK solver for.
[in]	frame	Frame to use as task frame.
[in]	iterations	Maximum number of iterations to use in solver.
[in]	eps	Solution tolerance.

ChainIK

Definition at line 229 of file ik.cpp.

◆ ~ChainIK()

ChainIK::~ChainIK ( )

virtual

Destructor.

Definition at line 234 of file ik.cpp.

◆ ChainIK() [2/3]

se2ez::ChainIK::ChainIK ( const ChainIK & )

delete

◆ ChainIK() [3/3]

se2ez::ChainIK::ChainIK ( ChainIK && )

delete

Member Function Documentation

◆ solve()

bool ChainIK::solve	(	StatePtr	state,
		const Eigen::Isometry2d &	frame,
		Request	request = `ALL`
	)

Solve an IK request.

Parameters

[in,out]	state	State to set to result of IK query. Input value is used as first seed.
[in]	frame	Desired value to query.
[in]	request	Requested components. ALL by default.

Returns: True on success, false on failure.

Definition at line 238 of file ik.cpp.

Member Data Documentation

◆ frame_

const std::string se2ez::ChainIK::frame_

private

Task frame.

Definition at line 245 of file ik.h.

The documentation for this class was generated from the following files:

/home/zak/code/se2ez_work/include/se2ez/core/ik.h
/home/zak/code/se2ez_work/src/core/ik.cpp

Public Member Functions

Private Attributes

Additional Inherited Members