Class that defines 2D visualPoint visual feature. More...

#include <feature-visual-point.hh>

Inheritance diagram for dynamicgraph::sot::FeatureVisualPoint:

[legend]

Public Member Functions
virtual dynamicgraph::Vector &	computeError (dynamicgraph::Vector &res, sigtime_t time)

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

	DECLARE_REFERENCE_FUNCTIONS (FeatureVisualPoint)

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

	FeatureVisualPoint (const std::string &name)

virtual const std::string &	getClassName (void) const
	Returns the name class. More...

virtual size_type &	getDimension (size_type &dim, sigtime_t time)
	Verbose method. More...

virtual	~FeatureVisualPoint (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::Vector &	computeErrorDot (dynamicgraph::Vector &res, sigtime_t time)

virtual void	setReference (FeatureAbstract *sdes)=0

virtual void	unsetReference (void)

virtual const FeatureAbstract *	getReferenceAbstract (void) const =0

virtual FeatureAbstract *	getReferenceAbstract (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::Command *	getNewStyleCommand (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

Logger &	logger ()

Logger &	logger ()

const Logger &	logger () const

const Logger &	logger () 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 Member Functions inherited from dynamicgraph::sot::FeatureReferenceHelper< FeatureVisualPoint >
	FeatureReferenceHelper (void)

FeatureVisualPoint *	getReference (void)

const FeatureVisualPoint *	getReference (void) const

bool	isReferenceSet (void) const

void	setReference (FeatureAbstract *sdes)

void	unsetReference (void)

Static Public Member Functions
static Flags	selectX (void)

static Flags	selectY (void)

Public Attributes
dynamicgraph::SignalPtr< dynamicgraph::Matrix, sigtime_t >	articularJacobianSIN

SignalTimeDependent< dynamicgraph::Vector, sigtime_t >	errorSOUT
	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_t >	jacobianSOUT
	Jacobian of the error wrt the robot state: $J = \frac{\partial {\bf s}}{\partial {\bf q}}$ . More...

SignalPtr< Flags, sigtime_t >	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 . More...

dynamicgraph::SignalPtr< dynamicgraph::Vector, sigtime_t >	xySIN

dynamicgraph::SignalPtr< double, sigtime_t >	ZSIN

Public Attributes inherited from dynamicgraph::sot::FeatureAbstract
SignalPtr< Flags, sigtime_t >	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 . More...

SignalPtr< dynamicgraph::Vector, sigtime_t >	errordotSIN
	Derivative of the reference value. More...

SignalTimeDependent< dynamicgraph::Vector, sigtime_t >	errorSOUT
	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_t >	errordotSOUT
	Derivative of the error with respect to time: $\frac{\partial e}{\partial t} = - \frac{d{\bf s}^*}{dt}$ . More...

SignalTimeDependent< dynamicgraph::Matrix, sigtime_t >	jacobianSOUT
	Jacobian of the error wrt the robot state: $J = \frac{\partial {\bf s}}{\partial {\bf q}}$ . More...

SignalTimeDependent< size_type, sigtime_t >	dimensionSOUT
	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...

Protected Attributes
dynamicgraph::Matrix	L

Protected Attributes inherited from dynamicgraph::Entity
CommandMap_t	commandMap

Logger	logger_

std::string	name

SignalMap	signalMap

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)

Detailed Description

Class that defines 2D visualPoint visual feature.

Definition at line 46 of file feature-visual-point.hh.

Constructor & Destructor Documentation

◆ FeatureVisualPoint()

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

Definition at line 29 of file feature-visual-point.cpp.

◆ ~FeatureVisualPoint()

virtual dynamicgraph::sot::FeatureVisualPoint::~FeatureVisualPoint ( void )

inlinevirtual

Definition at line 72 of file feature-visual-point.hh.

Member Function Documentation

◆ computeError()

Vector & FeatureVisualPoint::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 140 of file feature-visual-point.cpp.

◆ computeJacobian()

Matrix & FeatureVisualPoint::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 78 of file feature-visual-point.cpp.

◆ DECLARE_REFERENCE_FUNCTIONS()

dynamicgraph::sot::FeatureVisualPoint::DECLARE_REFERENCE_FUNCTIONS ( FeatureVisualPoint )

◆ display()

void FeatureVisualPoint::display ( std::ostream & os ) const

virtual

Reimplemented from dynamicgraph::Entity.

Definition at line 162 of file feature-visual-point.cpp.

◆ getClassName()

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

inlinevirtual

Returns the name class.

Reimplemented from dynamicgraph::sot::FeatureAbstract.

Definition at line 51 of file feature-visual-point.hh.

◆ getDimension()

size_type & FeatureVisualPoint::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 62 of file feature-visual-point.cpp.

◆ selectX()

static Flags dynamicgraph::sot::FeatureVisualPoint::selectX ( void )

inlinestatic

Static Feature selection.

Definition at line 82 of file feature-visual-point.hh.

◆ selectY()

static Flags dynamicgraph::sot::FeatureVisualPoint::selectY ( void )

inlinestatic

Definition at line 83 of file feature-visual-point.hh.

Member Data Documentation

◆ articularJacobianSIN

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

Definition at line 62 of file feature-visual-point.hh.

◆ CLASS_NAME

const std::string dynamicgraph::sot::FeatureVisualPoint::CLASS_NAME

static

Definition at line 50 of file feature-visual-point.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.

◆ L

dynamicgraph::Matrix dynamicgraph::sot::FeatureVisualPoint::L

protected

Definition at line 54 of file feature-visual-point.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.

◆ xySIN

dynamicgraph::SignalPtr<dynamicgraph::Vector, sigtime_t> dynamicgraph::sot::FeatureVisualPoint::xySIN

Definition at line 58 of file feature-visual-point.hh.

◆ ZSIN

dynamicgraph::SignalPtr<double, sigtime_t> dynamicgraph::sot::FeatureVisualPoint::ZSIN

FeatureVisualPoint depth (required to compute the interaction matrix) default Z = 1m.

Definition at line 61 of file feature-visual-point.hh.

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FeatureVisualPoint()

◆ ~FeatureVisualPoint()

Member Function Documentation

◆ computeError()

◆ computeJacobian()

◆ DECLARE_REFERENCE_FUNCTIONS()

◆ display()

◆ getClassName()

◆ getDimension()

◆ selectX()

◆ selectY()

Member Data Documentation

◆ articularJacobianSIN

◆ CLASS_NAME

◆ errorSOUT

◆ jacobianSOUT

◆ L

◆ selectionSIN

◆ xySIN

◆ ZSIN