Public Member Functions | Public Attributes | Static Public Attributes | List of all members
dynamicgraph::sot::FeatureVector3 Class Reference

Class that defines point-3d control feature. More...

#include <feature-vector3.hh>

Inheritance diagram for dynamicgraph::sot::FeatureVector3:
Inheritance graph
[legend]

Public Member Functions

virtual dynamicgraph::VectorcomputeError (dynamicgraph::Vector &res, sigtime_t time)
 
virtual dynamicgraph::MatrixcomputeJacobian (dynamicgraph::Matrix &res, sigtime_t time)
 
virtual void display (std::ostream &os) const
 
 FeatureVector3 (const std::string &name)
 
virtual const std::string & getClassName (void) const
 Returns the name class. More...
 
virtual size_typegetDimension (size_type &dim, sigtime_t time)
 Verbose method. More...
 
virtual ~FeatureVector3 (void)
 
- Public Member Functions inherited from dynamicgraph::sot::FeatureAbstract
 FeatureAbstract (const std::string &name)
 Default constructor: the name of the class should be given. More...
 
void featureRegistration (void)
 Register the feature in the stack of tasks. More...
 
void initCommands (void)
 
virtual ~FeatureAbstract (void)
 Default destructor. More...
 
size_type getDimension (sigtime_t time)
 Short method. More...
 
size_type getDimension (void) const
 Shortest method. More...
 
virtual dynamicgraph::VectorcomputeErrorDot (dynamicgraph::Vector &res, sigtime_t time)
 
virtual void setReference (FeatureAbstract *sdes)=0
 
virtual void unsetReference (void)
 
virtual const FeatureAbstractgetReferenceAbstract (void) const =0
 
virtual FeatureAbstractgetReferenceAbstract (void)=0
 
virtual bool isReferenceSet (void) const
 
virtual void addDependenciesFromReference (void)=0
 
virtual void removeDependenciesFromReference (void)=0
 
void setReferenceByName (const std::string &name)
 
std::string getReferenceByName (void) const
 
virtual std::ostream & writeGraph (std::ostream &os) const
 This method write a graph description on the file named FileName. More...
 
virtual SignalTimeDependent< dynamicgraph::Vector, sigtime_t > & getErrorDot ()
 
- Public Member Functions inherited from dynamicgraph::Entity
std::ostream & displaySignalList (std::ostream &os) const
 
 Entity (const std::string &name)
 
const std::string & getCommandList () const
 
virtual std::string getDocString () const
 
LoggerVerbosity getLoggerVerbosityLevel ()
 
LoggerVerbosity getLoggerVerbosityLevel ()
 
const std::string & getName () const
 
command::CommandgetNewStyleCommand (const std::string &cmdName)
 
CommandMap_t getNewStyleCommandMap ()
 
SignalBase< sigtime_t > & getSignal (const std::string &signalName)
 
const SignalBase< sigtime_t > & getSignal (const std::string &signalName) const
 
SignalMap getSignalMap () const
 
double getStreamPrintPeriod ()
 
double getStreamPrintPeriod ()
 
double getTimeSample ()
 
double getTimeSample ()
 
bool hasSignal (const std::string &signame) const
 
Loggerlogger ()
 
Loggerlogger ()
 
const Loggerlogger () const
 
const Loggerlogger () const
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 
bool setStreamPrintPeriod (double t)
 
bool setStreamPrintPeriod (double t)
 
bool setTimeSample (double t)
 
bool setTimeSample (double t)
 
virtual SignalBase< sigtime_t > * test ()
 
virtual void test2 (SignalBase< sigtime_t > *)
 
virtual std::ostream & writeCompletionList (std::ostream &os) const
 
virtual ~Entity ()
 

Public Attributes

dynamicgraph::SignalPtr< dynamicgraph::Matrix, sigtime_tarticularJacobianSIN
 
 DECLARE_NO_REFERENCE
 
SignalTimeDependent< dynamicgraph::Vector, sigtime_terrorSOUT
 This signal returns the error between the desired value and the current value : $ E(t) = {\bf s}(t) - {\bf s}^*(t)$. More...
 
SignalTimeDependent< dynamicgraph::Matrix, sigtime_tjacobianSOUT
 Jacobian of the error wrt the robot state: $ J = \frac{\partial {\bf s}}{\partial {\bf q}}$. More...
 
dynamicgraph::SignalPtr< dynamicgraph::Vector, sigtime_tpositionRefSIN
 
dynamicgraph::SignalPtr< MatrixHomogeneous, sigtime_tpositionSIN
 
SignalPtr< Flags, sigtime_tselectionSIN
 This vector specifies which dimension are used to perform the computation. For instance let us assume that the feature is a 3D point. If only the Y-axis should be used for computing error, activation and Jacobian, then the vector to specify is $ [ 0 1 0] $. More...
 
dynamicgraph::SignalPtr< dynamicgraph::Vector, sigtime_tvectorSIN
 
- Public Attributes inherited from dynamicgraph::sot::FeatureAbstract
SignalPtr< Flags, sigtime_tselectionSIN
 This vector specifies which dimension are used to perform the computation. For instance let us assume that the feature is a 3D point. If only the Y-axis should be used for computing error, activation and Jacobian, then the vector to specify is $ [ 0 1 0] $. More...
 
SignalPtr< dynamicgraph::Vector, sigtime_terrordotSIN
 Derivative of the reference value. More...
 
SignalTimeDependent< dynamicgraph::Vector, sigtime_terrorSOUT
 This signal returns the error between the desired value and the current value : $ E(t) = {\bf s}(t) - {\bf s}^*(t)$. More...
 
SignalTimeDependent< dynamicgraph::Vector, sigtime_terrordotSOUT
 Derivative of the error with respect to time: $ \frac{\partial e}{\partial t} = - \frac{d{\bf s}^*}{dt} $. More...
 
SignalTimeDependent< dynamicgraph::Matrix, sigtime_tjacobianSOUT
 Jacobian of the error wrt the robot state: $ J = \frac{\partial {\bf s}}{\partial {\bf q}}$. More...
 
SignalTimeDependent< size_type, sigtime_tdimensionSOUT
 Returns the dimension of the feature as an output signal. More...
 

Static Public Attributes

static const std::string CLASS_NAME
 
- Static Public Attributes inherited from dynamicgraph::sot::FeatureAbstract
static const std::string CLASS_NAME = "FeatureAbstract"
 Store the name of the class. More...
 

Additional Inherited Members

- Public Types inherited from dynamicgraph::Entity
typedef std::map< const std::string, command::Command * > CommandMap_t
 
typedef std::map< std::string, SignalBase< sigtime_t > * > SignalMap
 
- Protected Member Functions inherited from dynamicgraph::Entity
void addCommand (const std::string &name, command::Command *command)
 
void entityDeregistration ()
 
void entityRegistration ()
 
void signalDeregistration (const std::string &name)
 
void signalRegistration (const SignalArray< sigtime_t > &signals)
 
- Protected Attributes inherited from dynamicgraph::Entity
CommandMap_t commandMap
 
Logger logger_
 
std::string name
 
SignalMap signalMap
 

Detailed Description

Class that defines point-3d control feature.

Definition at line 47 of file feature-vector3.hh.

Constructor & Destructor Documentation

◆ FeatureVector3()

FeatureVector3::FeatureVector3 ( const std::string &  name)

Definition at line 33 of file feature-vector3.cpp.

◆ ~FeatureVector3()

virtual dynamicgraph::sot::FeatureVector3::~FeatureVector3 ( void  )
inlinevirtual

Definition at line 68 of file feature-vector3.hh.

Member Function Documentation

◆ computeError()

Vector & FeatureVector3::computeError ( dynamicgraph::Vector res,
sigtime_t  time 
)
virtual

Compute the error between two visual features from a subset a the possible features.

Implements dynamicgraph::sot::FeatureAbstract.

Definition at line 107 of file feature-vector3.cpp.

◆ computeJacobian()

Matrix & FeatureVector3::computeJacobian ( dynamicgraph::Matrix res,
sigtime_t  time 
)
virtual

Compute the interaction matrix from a subset of the possible features.

Implements dynamicgraph::sot::FeatureAbstract.

Definition at line 68 of file feature-vector3.cpp.

◆ display()

void FeatureVector3::display ( std::ostream &  os) const
virtual

Reimplemented from dynamicgraph::Entity.

Definition at line 128 of file feature-vector3.cpp.

◆ getClassName()

virtual const std::string& dynamicgraph::sot::FeatureVector3::getClassName ( void  ) const
inlinevirtual

Returns the name class.

Reimplemented from dynamicgraph::sot::FeatureAbstract.

Definition at line 50 of file feature-vector3.hh.

◆ getDimension()

size_type & FeatureVector3::getDimension ( size_type res,
sigtime_t  time 
)
virtual

Verbose method.

res: The integer in which the dimension will be return.
time: The time at which the feature should be considered.
Returns
Dimension of the feature.
Note
Be careful with features changing their dimension according to time.

Implements dynamicgraph::sot::FeatureAbstract.

Definition at line 58 of file feature-vector3.cpp.

Member Data Documentation

◆ articularJacobianSIN

dynamicgraph::SignalPtr<dynamicgraph::Matrix, sigtime_t> dynamicgraph::sot::FeatureVector3::articularJacobianSIN

Definition at line 59 of file feature-vector3.hh.

◆ CLASS_NAME

const std::string dynamicgraph::sot::FeatureVector3::CLASS_NAME
static

Definition at line 49 of file feature-vector3.hh.

◆ DECLARE_NO_REFERENCE

dynamicgraph::sot::FeatureVector3::DECLARE_NO_REFERENCE

Definition at line 52 of file feature-vector3.hh.

◆ errorSOUT

SignalTimeDependent<dynamicgraph::Vector, sigtime_t> dynamicgraph::sot::FeatureAbstract::errorSOUT

This signal returns the error between the desired value and the current value : $ E(t) = {\bf s}(t) - {\bf s}^*(t)$.

Definition at line 185 of file feature-abstract.hh.

◆ jacobianSOUT

SignalTimeDependent<dynamicgraph::Matrix, sigtime_t> dynamicgraph::sot::FeatureAbstract::jacobianSOUT

Jacobian of the error wrt the robot state: $ J = \frac{\partial {\bf s}}{\partial {\bf q}}$.

Definition at line 193 of file feature-abstract.hh.

◆ positionRefSIN

dynamicgraph::SignalPtr<dynamicgraph::Vector, sigtime_t> dynamicgraph::sot::FeatureVector3::positionRefSIN

Definition at line 60 of file feature-vector3.hh.

◆ positionSIN

dynamicgraph::SignalPtr<MatrixHomogeneous, sigtime_t> dynamicgraph::sot::FeatureVector3::positionSIN

Definition at line 58 of file feature-vector3.hh.

◆ selectionSIN

SignalPtr<Flags, sigtime_t> dynamicgraph::sot::FeatureAbstract::selectionSIN

This vector specifies which dimension are used to perform the computation. For instance let us assume that the feature is a 3D point. If only the Y-axis should be used for computing error, activation and Jacobian, then the vector to specify is $ [ 0 1 0] $.

Definition at line 173 of file feature-abstract.hh.

◆ vectorSIN

dynamicgraph::SignalPtr<dynamicgraph::Vector, sigtime_t> dynamicgraph::sot::FeatureVector3::vectorSIN

Definition at line 57 of file feature-vector3.hh.


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


sot-core
Author(s): Olivier Stasse, ostasse@laas.fr
autogenerated on Tue Oct 24 2023 02:26:32