mc_rtc  2.14.0
mc_tvm::PositionBasedVisServoFunction Struct Reference

#include <mc_tvm/PositionBasedVisServoFunction.h>

Inheritance diagram for mc_tvm::PositionBasedVisServoFunction:
Collaboration diagram for mc_tvm::PositionBasedVisServoFunction:

Public Member Functions

EIGEN_MAKE_ALIGNED_OPERATOR_NEW PositionBasedVisServoFunction (const mc_rbdyn::RobotFrame &frame)
 
void reset () noexcept
 
const sva::PTransformderror () const noexcept
 
void error (const sva::PTransformd &X_t_s) noexcept
 
const mc_rbdyn::RobotFrameframe () const noexcept
 
- Public Member Functions inherited from tvm::function::abstract::Function
virtual const Eigen::VectorXd & velocity () const
 
virtual const Eigen::VectorXd & normalAcceleration () const
 
virtual MatrixConstRef JDot (const Variable &x) const
 
- Public Member Functions inherited from tvm::internal::FirstOrderProvider
virtual const Eigen::VectorXd & value () const
 
virtual MatrixConstRefWithProperties jacobian (const Variable &x) const
 
bool linearIn (const Variable &x) const
 
const SpaceimageSpace () const
 
int size () const
 
int rSize () const
 
int tSize () const
 
const VariableVectorvariables () const
 
- Public Member Functions inherited from tvm::graph::internal::AbstractNode
bool isUpdateEnabled (EnumT e) const
 
virtual bool isUpdateStaticallyEnabled (int) const
 
virtual bool isUpdateCustomEnabled (int) const
 
virtual ~AbstractNode ()=default
 
void update (int i)
 
- Public Member Functions inherited from tvm::graph::internal::Inputs
virtual ~Inputs ()=default
 
void addInput (std::shared_ptr< T > source, EnumI i, Args... args)
 
void addInput (T &source, EnumI i, Args... args)
 
void removeInput (T *source)
 
void removeInput (T *source, Args... args)
 
Iterator getInput (T *source)
 
Iterator getInput (const std::shared_ptr< T > &source)
 
- Public Member Functions inherited from tvm::graph::abstract::Outputs
virtual ~Outputs ()=default
 
bool isOutputEnabled (EnumT e) const
 
bool isOutputEnabled (int i) const
 
virtual bool isOutputStaticallyEnabled (int) const
 
virtual bool isOutputCustomEnabled (int) const
 

Protected Member Functions

void updateValue ()
 
void updateVelocity ()
 
void updateJacobian ()
 
void updateNormalAcceleration ()
 
- Protected Member Functions inherited from tvm::function::abstract::Function
 Function (int m=0)
 
 Function (Space image)
 
void resizeCache () override
 
void resizeVelocityCache ()
 
void resizeNormalAccelerationCache ()
 
void resizeJDotCache ()
 
void addVariable_ (VariablePtr v) override
 
void removeVariable_ (VariablePtr v) override
 
- Protected Member Functions inherited from tvm::internal::FirstOrderProvider
 FirstOrderProvider (int m)
 
 FirstOrderProvider (Space image)
 
void resizeValueCache ()
 
void resizeJacobianCache ()
 
void addVariable (VariablePtr v, bool linear)
 
void removeVariable (VariablePtr v)
 
void addVariable (const VariableVector &v, bool linear)
 
void splitJacobian (const MatrixConstRef &J, const std::vector< VariablePtr > &vars, bool keepProperties=false)
 
void splitJacobian (const MatrixConstRef &J, const VariableVector &vars, bool keepProperties=false)
 
void resize (int m)
 
- Protected Member Functions inherited from Node< FirstOrderProvider >
void registerUpdates (EnumT u, void(U::*fn)(), Args... args)
 
void registerUpdates (EnumT u, void(U::*fn)())
 
void addOutputDependency (EnumO o, EnumU u)
 
void addOutputDependency (std::initializer_list< EnumO > os, EnumU u)
 
void addInternalDependency (EnumU1 uDependent, EnumU2 u)
 
void addInputDependency (EnumU u, std::shared_ptr< S > source, EnumO i, Args... args)
 
void addInputDependency (EnumU u, S &source, EnumO i, Args... args)
 
void addDirectDependency (EnumO o, std::shared_ptr< S > source, EnumI i)
 
void addDirectDependency (EnumO o, S &source, EnumI i)
 

Protected Attributes

mc_rbdyn::ConstRobotFramePtr frame_
 
mc_tvm::RobotFrametvm_frame_
 
sva::PTransformd X_t_s_
 
rbd::Jacobian frameJac_
 
double angle_
 
Eigen::Vector3d axis_
 
Eigen::Matrix< double, 6, 6 > L_pbvs_
 
Eigen::Matrix< double, 6, 1 > frameVelocity_
 
Eigen::Matrix3d omegaSkew_
 
Eigen::Matrix< double, 6, 6 > L_pbvs_dot_
 
Eigen::MatrixXd shortJacMat_
 
Eigen::MatrixXd jacMat_
 
- Protected Attributes inherited from tvm::function::abstract::Function
Eigen::VectorXd velocity_
 
Eigen::VectorXd normalAcceleration_
 
utils::internal::MapWithVariableAsKey< Eigen::MatrixXd, slice_jdotJDot_
 
- Protected Attributes inherited from tvm::internal::FirstOrderProvider
Eigen::VectorXd value_
 
utils::internal::MapWithVariableAsKey< MatrixWithProperties, slice_matrix, true > jacobian_
 
Space imageSpace_
 
VariableVector variables_
 
utils::internal::MapWithVariableAsKey< bool, slice_linearlinear_
 
- Protected Attributes inherited from tvm::graph::internal::AbstractNode
std::map< int, std::function< void(AbstractNode &)> > updates_
 
std::map< int, std::vector< int > > outputDependencies_
 
std::map< int, std::vector< int > > internalDependencies_
 
std::map< int, input_dependency_tinputDependencies_
 
std::map< int, std::pair< Outputs *, int > > directDependencies_
 
- Protected Attributes inherited from tvm::graph::abstract::Outputs
bool is_node_
 

Additional Inherited Members

- Public Types inherited from tvm::graph::internal::AbstractNode
enum  Update_
 
typedef AbstractNode UpdateParent
 
typedef AbstractNode UpdateBase
 
- Public Types inherited from tvm::graph::internal::Inputs
typedef std::unordered_map< abstract::Outputs *, std::set< int > > inputs_t
 
typedef std::unordered_set< std::shared_ptr< abstract::Outputs > > store_t
 
- Public Types inherited from tvm::graph::abstract::Outputs
enum  Output_
 
typedef Outputs OutputParent
 
typedef Outputs OutputBase
 
- Static Public Member Functions inherited from tvm::graph::internal::AbstractNode
static constexpr const char * UpdateName (Update_)
 
static constexpr bool UpdateStaticallyEnabled (EnumT)
 
- Static Public Member Functions inherited from tvm::graph::abstract::Outputs
static constexpr const char * OutputName (Output_)
 
static constexpr bool OutputStaticallyEnabled (EnumT)
 
- Static Public Attributes inherited from tvm::graph::internal::AbstractNode
static constexpr unsigned int UpdateSize
 
static constexpr auto UpdateBaseName
 
- Static Public Attributes inherited from tvm::graph::abstract::Outputs
static constexpr unsigned int OutputSize
 
static constexpr auto OutputBaseName
 
- Protected Types inherited from tvm::graph::internal::AbstractNode
typedef std::map< Outputs *, std::set< int > > input_dependency_t
 

Detailed Description

This class implements a position-based visual servoing function

This task value is to be updated by an external process (e.g. a vision algorithm)

See https://hal.inria.fr/hal-01421734/file/2016_ral_agaravante.pdf for details

Constructor & Destructor Documentation

◆ PositionBasedVisServoFunction()

EIGEN_MAKE_ALIGNED_OPERATOR_NEW mc_tvm::PositionBasedVisServoFunction::PositionBasedVisServoFunction ( const mc_rbdyn::RobotFrame frame)

Constructor

Parameters
frameControlled frame

Member Function Documentation

◆ error() [1/2]

const sva::PTransformd& mc_tvm::PositionBasedVisServoFunction::error ( ) const
inlinenoexcept

Access the current error

◆ error() [2/2]

void mc_tvm::PositionBasedVisServoFunction::error ( const sva::PTransformd X_t_s)
inlinenoexcept

Set the function error, i.e. the current position relative to the target position

◆ frame()

const mc_rbdyn::RobotFrame& mc_tvm::PositionBasedVisServoFunction::frame ( ) const
inlinenoexcept

Access the controlled frame

◆ reset()

void mc_tvm::PositionBasedVisServoFunction::reset ( )
inlinenoexcept

Reset the error

◆ updateJacobian()

void mc_tvm::PositionBasedVisServoFunction::updateJacobian ( )
protected

◆ updateNormalAcceleration()

void mc_tvm::PositionBasedVisServoFunction::updateNormalAcceleration ( )
protected

◆ updateValue()

void mc_tvm::PositionBasedVisServoFunction::updateValue ( )
protected

◆ updateVelocity()

void mc_tvm::PositionBasedVisServoFunction::updateVelocity ( )
protected

Member Data Documentation

◆ angle_

double mc_tvm::PositionBasedVisServoFunction::angle_
protected

◆ axis_

Eigen::Vector3d mc_tvm::PositionBasedVisServoFunction::axis_
protected

◆ frame_

mc_rbdyn::ConstRobotFramePtr mc_tvm::PositionBasedVisServoFunction::frame_
protected

◆ frameJac_

rbd::Jacobian mc_tvm::PositionBasedVisServoFunction::frameJac_
protected

◆ frameVelocity_

Eigen::Matrix<double, 6, 1> mc_tvm::PositionBasedVisServoFunction::frameVelocity_
protected

◆ jacMat_

Eigen::MatrixXd mc_tvm::PositionBasedVisServoFunction::jacMat_
protected

◆ L_pbvs_

Eigen::Matrix<double, 6, 6> mc_tvm::PositionBasedVisServoFunction::L_pbvs_
protected

◆ L_pbvs_dot_

Eigen::Matrix<double, 6, 6> mc_tvm::PositionBasedVisServoFunction::L_pbvs_dot_
protected

◆ omegaSkew_

Eigen::Matrix3d mc_tvm::PositionBasedVisServoFunction::omegaSkew_
protected

◆ shortJacMat_

Eigen::MatrixXd mc_tvm::PositionBasedVisServoFunction::shortJacMat_
protected

◆ tvm_frame_

mc_tvm::RobotFrame& mc_tvm::PositionBasedVisServoFunction::tvm_frame_
protected

◆ X_t_s_

sva::PTransformd mc_tvm::PositionBasedVisServoFunction::X_t_s_
protected

The documentation for this struct was generated from the following file: