Offset edge. More...

#include <edge_se2_offset.h>

Inheritance diagram for g2o::EdgeSE2Offset:

[legend]

Collaboration diagram for g2o::EdgeSE2Offset:

[legend]

Public Member Functions
	EdgeSE2Offset ()
virtual bool	read (std::istream &is)
	read the vertex from a stream, i.e., the internal state of the vertex
virtual bool	write (std::ostream &os) const
	write the vertex to a stream
void	computeError ()
virtual void	setMeasurement (const SE2 &m)
virtual bool	setMeasurementData (const double *d)
virtual bool	getMeasurementData (double *d) const
virtual int	measurementDimension () const
virtual bool	setMeasurementFromState ()
virtual double	initialEstimatePossible (const OptimizableGraph::VertexSet &, OptimizableGraph::Vertex *)
virtual void	initialEstimate (const OptimizableGraph::VertexSet &from, OptimizableGraph::Vertex *to)
Public Member Functions inherited from g2o::BaseBinaryEdge< 3, SE2, VertexSE2, VertexSE2 >
	BaseBinaryEdge ()
Public Member Functions inherited from g2o::BaseFixedSizedEdge< D, SE2, VertexSE2, VertexSE2 >
bool	allVerticesFixedNs (std::index_sequence< Ints... >) const
void	constructQuadraticFormNs (const InformationType &omega, const ErrorVector &weightedError, std::index_sequence< Ints... >)
void	constructOffDiagonalQuadraticFormMs (const AtOType &, std::index_sequence<>)
void	constructOffDiagonalQuadraticFormMs (const AtOType &AtO, std::index_sequence< Ints... >)
void	constructOffDiagonalQuadraticFormM (const AtOType &AtO)
void	constructQuadraticFormN (const InformationType &omega, const ErrorVector &weightedError)
void	linearizeOplus_allocate (JacobianWorkspace &jacobianWorkspace, std::index_sequence< Ints... >)
void	linearizeOplusN ()
void	linearizeOplusNs (std::index_sequence< Ints... >)
constexpr std::enable_if< VertexXnType< VertexN >::Dimension!=-1, int >::type	vertexDimension () const
const VertexXnType< VertexN > *	vertexXn () const
	BaseFixedSizedEdge ()
OptimizableGraph::Vertex *	createVertex (int i, CtorArgs... args)
	create an instance of the Nth VertexType
virtual void	resize (size_t size)
virtual bool	allVerticesFixed () const
virtual void	linearizeOplus (JacobianWorkspace &jacobianWorkspace)
const std::tuple_element< N, std::tuple< JacobianType< D, VertexTypes::Dimension >... > >::type &	jacobianOplusXn () const
virtual void	constructQuadraticForm ()
virtual void	mapHessianMemory (double *d, int i, int j, bool rowMajor)
Public Member Functions inherited from g2o::BaseEdge< D, SE2 >
	BaseEdge ()
BaseEdge &	operator= (const BaseEdge &)=delete
virtual	~BaseEdge ()
virtual double	chi2 () const
virtual const double *	errorData () const
	returns the error vector cached after calling the computeError;
const ErrorVector &	error () const
EIGEN_STRONG_INLINE const InformationType &	information () const
	information matrix of the constraint
void	setInformation (const InformationType &information)
virtual const double *	informationData () const
EIGEN_STRONG_INLINE const Measurement &	measurement () const
	accessor functions for the measurement represented by the edge
virtual int	rank () const
std::enable_if< Dim==-1, void >::type	setDimension (int dim)
Public Member Functions inherited from g2o::OptimizableGraph::Edge
	Edge ()
virtual	~Edge ()
RobustKernel *	robustKernel () const
	if NOT NULL, error of this edge will be robustifed with the kernel
void	setRobustKernel (RobustKernel *ptr)
virtual double *	errorData ()=0
virtual double *	informationData ()=0
int	level () const
	returns the level of the edge
void	setLevel (int l)
	sets the level of the edge
int	dimension () const
	returns the dimensions of the error function
	G2O_ATTRIBUTE_DEPRECATED (virtual Vertex *createFrom())
	G2O_ATTRIBUTE_DEPRECATED (virtual Vertex *createTo())
virtual Vertex *	createVertex (int)
long long	internalId () const
	the internal ID of the edge
OptimizableGraph *	graph ()
const OptimizableGraph *	graph () const
bool	setParameterId (int argNum, int paramId)
const Parameter *	parameter (int argNo) const
size_t	numParameters () const
void	resizeParameters (size_t newSize)
Public Member Functions inherited from g2o::HyperGraph::Edge
	Edge (int id=InvalidId)
	creates and empty edge with no vertices
const VertexContainer &	vertices () const
VertexContainer &	vertices ()
const Vertex *	vertex (size_t i) const
Vertex *	vertex (size_t i)
void	setVertex (size_t i, Vertex *v)
int	id () const
void	setId (int id)
virtual HyperGraphElementType	elementType () const
int	numUndefinedVertices () const
Public Member Functions inherited from g2o::HyperGraph::HyperGraphElement
virtual	~HyperGraphElement ()
Public Member Functions inherited from g2o::HyperGraph::DataContainer
	DataContainer ()
virtual	~DataContainer ()
const Data *	userData () const
	the user data associated with this vertex
Data *	userData ()
void	setUserData (Data *obs)
void	addUserData (Data *obs)

Public Attributes
	EIGEN_MAKE_ALIGNED_OPERATOR_NEW

Protected Member Functions
virtual bool	resolveCaches ()
Protected Member Functions inherited from g2o::BaseEdge< D, SE2 >
InformationType	robustInformation (const Vector3 &rho) const
bool	writeInformationMatrix (std::ostream &os) const
	write the upper trinagular part of the information matrix into the stream
bool	readInformationMatrix (std::istream &is)
bool	writeParamIds (std::ostream &os) const
	write the param IDs that are potentially used by the edge
bool	readParamIds (std::istream &is)
	reads the param IDs from the stream
Protected Member Functions inherited from g2o::OptimizableGraph::Edge
template<typename ParameterType>
bool	installParameter (ParameterType *&p, size_t argNo, int paramId=-1)
template<typename CacheType>
void	resolveCache (CacheType &cache, OptimizableGraph::Vertex , const std::string &_type, const ParameterVector &parameters)
bool	resolveParameters ()

Protected Attributes
SE2	_inverseMeasurement
ParameterSE2Offset *	_offsetFrom
ParameterSE2Offset *	_offsetTo
CacheSE2Offset *	_cacheFrom
CacheSE2Offset *	_cacheTo
Protected Attributes inherited from g2o::BaseBinaryEdge< 3, SE2, VertexSE2, VertexSE2 >
BaseFixedSizedEdge< D, SE2, VertexSE2, VertexSE2 >::template JacobianType< D, VertexSE2::Dimension > &	_jacobianOplusXi
BaseFixedSizedEdge< D, SE2, VertexSE2, VertexSE2 >::template JacobianType< D, VertexSE2::Dimension > &	_jacobianOplusXj
Protected Attributes inherited from g2o::BaseFixedSizedEdge< D, SE2, VertexSE2, VertexSE2 >
HessianRowMajorStorage	_hessianRowMajor
HessianTuple	_hessianTuple
HessianTupleTransposed	_hessianTupleTransposed
std::tuple< JacobianType< D, VertexTypes::Dimension >... >	_jacobianOplus
Protected Attributes inherited from g2o::BaseEdge< D, SE2 >
Measurement	_measurement
	the measurement of the edge
InformationType	_information
ErrorVector	_error
Protected Attributes inherited from g2o::OptimizableGraph::Edge
int	_dimension
int	_level
RobustKernel *	_robustKernel
long long	_internalId
std::vector< int >	_cacheIds
std::vector< std::string >	_parameterTypes
std::vector< Parameter ** >	_parameters
std::vector< int >	_parameterIds
Protected Attributes inherited from g2o::HyperGraph::Edge
VertexContainer	_vertices
int	_id
	unique id
Protected Attributes inherited from g2o::HyperGraph::DataContainer
Data *	_userData

Additional Inherited Members
Public Types inherited from g2o::BaseBinaryEdge< 3, SE2, VertexSE2, VertexSE2 >
using	VertexXiType
using	VertexXjType
Public Types inherited from g2o::BaseFixedSizedEdge< D, SE2, VertexSE2, VertexSE2 >
using	NthType
using	VertexXnType
	The type of the N-th vertex.
typedef BaseEdge< D, SE2 >::Measurement	Measurement
typedef BaseEdge< D, SE2 >::ErrorVector	ErrorVector
typedef BaseEdge< D, SE2 >::InformationType	InformationType
using	JacobianType
using	HessianBlockType
	it requires quite some ugly code to get the type of hessians...
using	HessianBlockTypeK
using	HessianBlockTypeKTransposed
using	HessianTuple
using	HessianTupleTransposed
using	HessianRowMajorStorage
Public Types inherited from g2o::BaseEdge< D, SE2 >
typedef SE2	Measurement
typedef internal::BaseEdgeTraits< D >::ErrorVector	ErrorVector
typedef internal::BaseEdgeTraits< D >::InformationType	InformationType
Static Public Member Functions inherited from g2o::BaseFixedSizedEdge< D, SE2, VertexSE2, VertexSE2 >
static constexpr int	VertexDimension ()
	Size of the N-th vertex at compile time.
Static Public Attributes inherited from g2o::BaseFixedSizedEdge< D, SE2, VertexSE2, VertexSE2 >
static const int	Dimension
static const std::size_t	_nr_of_vertices
static const std::size_t	_nr_of_vertex_pairs
Static Public Attributes inherited from g2o::BaseEdge< D, SE2 >
static constexpr int	Dimension

Detailed Description

Offset edge.

Definition at line 43 of file edge_se2_offset.h.

Constructor & Destructor Documentation

◆ EdgeSE2Offset()

g2o::EdgeSE2Offset::EdgeSE2Offset ( )

Definition at line 37 of file edge_se2_offset.cpp.

    : BaseBinaryEdge<3, SE2, VertexSE2, VertexSE2>() {
  information().setIdentity();
  _offsetFrom = 0;
  _offsetTo = 0;
  _cacheFrom = 0;
  _cacheTo = 0;
  resizeParameters(2);
  installParameter(_offsetFrom, 0);
  installParameter(_offsetTo, 1);
}

References _cacheFrom, _cacheTo, _offsetFrom, _offsetTo, g2o::BaseBinaryEdge< 3, SE2, VertexSE2, VertexSE2 >::BaseBinaryEdge(), g2o::BaseEdge< D, SE2 >::information(), g2o::OptimizableGraph::Edge::installParameter(), and g2o::OptimizableGraph::Edge::resizeParameters().

Member Function Documentation

◆ computeError()

void g2o::EdgeSE2Offset::computeError ( )

virtual

Implements g2o::OptimizableGraph::Edge.

Definition at line 86 of file edge_se2_offset.cpp.

                                 {
  SE2 delta = _inverseMeasurement * _cacheFrom->w2n() * _cacheTo->n2w();
  _error.head<2>() = delta.translation();
  _error(2) = delta.rotation().angle();
}

References _cacheFrom, _cacheTo, g2o::BaseEdge< D, SE2 >::_error, _inverseMeasurement, g2o::SE2::rotation(), and g2o::SE2::translation().

◆ getMeasurementData()

virtual bool g2o::EdgeSE2Offset::getMeasurementData ( double * m ) const

inlinevirtual

writes the measurement to an array of double

Returns: true on success

Reimplemented from g2o::OptimizableGraph::Edge.

Definition at line 68 of file edge_se2_offset.h.

                                                   {
    Eigen::Map<Vector3> v(d);
    v = _measurement.toVector();
    return true;
  }

References g2o::BaseEdge< D, SE2 >::_measurement.

◆ initialEstimate()

void g2o::EdgeSE2Offset::initialEstimate	(	const OptimizableGraph::VertexSet &	,
		OptimizableGraph::Vertex *	)

virtual

set the estimate of the to vertex, based on the estimate of the from vertices in the edge.

Reimplemented from g2o::BaseEdge< D, SE2 >.

Definition at line 98 of file edge_se2_offset.cpp.

                                                               {
  VertexSE2* from = static_cast<VertexSE2*>(_vertices[0]);
  VertexSE2* to = static_cast<VertexSE2*>(_vertices[1]);
 
  SE2 virtualMeasurement = _cacheFrom->offsetParam()->offset() * measurement() *
                           _cacheTo->offsetParam()->offset().inverse();
 
  if (from_.count(from) > 0)
    to->setEstimate(from->estimate() * virtualMeasurement);
  else
    from->setEstimate(to->estimate() * virtualMeasurement.inverse());
}

References _cacheFrom, _cacheTo, g2o::HyperGraph::Edge::_vertices, g2o::BaseVertex< D, T >::estimate(), g2o::SE2::inverse(), g2o::BaseEdge< D, SE2 >::measurement(), and g2o::BaseVertex< D, T >::setEstimate().

◆ initialEstimatePossible()

virtual double g2o::EdgeSE2Offset::initialEstimatePossible	(	const OptimizableGraph::VertexSet &	from,
		OptimizableGraph::Vertex *	to )

inlinevirtual

override in your class if it's possible to initialize the vertices in certain combinations. The return value may correspond to the cost for initiliaizng the vertex but should be positive if the initialization is possible and negative if not possible.

Reimplemented from g2o::OptimizableGraph::Edge.

Definition at line 78 of file edge_se2_offset.h.

                                 {
    return 1.;
  }

◆ measurementDimension()

virtual int g2o::EdgeSE2Offset::measurementDimension ( ) const

inlinevirtual

returns the dimension of the measurement in the extended representation which is used by get/setMeasurement;

Reimplemented from g2o::OptimizableGraph::Edge.

Definition at line 74 of file edge_se2_offset.h.

74{ return 3; }

◆ read()

bool g2o::EdgeSE2Offset::read ( std::istream & is )

virtual

read the vertex from a stream, i.e., the internal state of the vertex

Implements g2o::OptimizableGraph::Edge.

Definition at line 62 of file edge_se2_offset.cpp.

                                       {
  int pidFrom, pidTo;
  is >> pidFrom >> pidTo;
  if (!setParameterId(0, pidFrom)) return false;
  if (!setParameterId(1, pidTo)) return false;
 
  Vector3 meas;
  internal::readVector(is, meas);
  setMeasurement(SE2(meas));
  if (is.bad()) return false;
  readInformationMatrix(is);
  if (is.bad()) {
    //  we overwrite the information matrix with the Identity
    information().setIdentity();
  }
  return true;
}

References g2o::BaseEdge< D, SE2 >::information(), g2o::BaseEdge< D, SE2 >::readInformationMatrix(), g2o::internal::readVector(), setMeasurement(), and g2o::OptimizableGraph::Edge::setParameterId().

◆ resolveCaches()

bool g2o::EdgeSE2Offset::resolveCaches ( )

protectedvirtual

Reimplemented from g2o::OptimizableGraph::Edge.

Definition at line 49 of file edge_se2_offset.cpp.

                                  {
  assert(_offsetFrom && _offsetTo);
 
  ParameterVector pv(1);
  pv[0] = _offsetFrom;
  resolveCache(_cacheFrom, (OptimizableGraph::Vertex*)_vertices[0],
               "CACHE_SE2_OFFSET", pv);
  pv[0] = _offsetTo;
  resolveCache(_cacheTo, (OptimizableGraph::Vertex*)_vertices[1],
               "CACHE_SE2_OFFSET", pv);
  return (_cacheFrom && _cacheTo);
}

References _cacheFrom, _cacheTo, _offsetFrom, _offsetTo, g2o::HyperGraph::Edge::_vertices, and g2o::OptimizableGraph::Edge::resolveCache().

◆ setMeasurement()

virtual void g2o::EdgeSE2Offset::setMeasurement ( const SE2 & m )

inlinevirtual

Reimplemented from g2o::BaseEdge< D, SE2 >.

Definition at line 56 of file edge_se2_offset.h.

                                            {
    _measurement = m;
    _inverseMeasurement = m.inverse();
  }

References _inverseMeasurement, g2o::BaseEdge< D, SE2 >::_measurement, and g2o::SE2::inverse().

Referenced by read(), and setMeasurementFromState().

◆ setMeasurementData()

virtual bool g2o::EdgeSE2Offset::setMeasurementData ( const double * m )

inlinevirtual

sets the measurement from an array of double

Returns: true on success

Reimplemented from g2o::OptimizableGraph::Edge.

Definition at line 61 of file edge_se2_offset.h.

                                                   {
    Eigen::Map<const Vector3> v(d);
    _measurement.fromVector(v);
    _inverseMeasurement = _measurement.inverse();
    return true;
  }

References _inverseMeasurement, and g2o::BaseEdge< D, SE2 >::_measurement.

◆ setMeasurementFromState()

bool g2o::EdgeSE2Offset::setMeasurementFromState ( )

virtual

sets the estimate to have a zero error, based on the current value of the state variables returns false if not supported.

Reimplemented from g2o::OptimizableGraph::Edge.

Definition at line 92 of file edge_se2_offset.cpp.

                                            {
  SE2 delta = _cacheFrom->w2n() * _cacheTo->n2w();
  setMeasurement(delta);
  return true;
}

References _cacheFrom, _cacheTo, and setMeasurement().

◆ write()

bool g2o::EdgeSE2Offset::write ( std::ostream & os ) const

virtual

write the vertex to a stream

Implements g2o::OptimizableGraph::Edge.

Definition at line 80 of file edge_se2_offset.cpp.

                                              {
  os << _offsetFrom->id() << " " << _offsetTo->id() << " ";
  internal::writeVector(os, measurement().toVector());
  return writeInformationMatrix(os);
}

References _offsetFrom, _offsetTo, g2o::BaseEdge< D, SE2 >::measurement(), g2o::BaseEdge< D, SE2 >::writeInformationMatrix(), and g2o::internal::writeVector().

Member Data Documentation

◆ _cacheFrom

CacheSE2Offset* g2o::EdgeSE2Offset::_cacheFrom

protected

Definition at line 91 of file edge_se2_offset.h.

Referenced by computeError(), EdgeSE2Offset(), initialEstimate(), resolveCaches(), and setMeasurementFromState().

◆ _cacheTo

CacheSE2Offset * g2o::EdgeSE2Offset::_cacheTo

protected

Definition at line 91 of file edge_se2_offset.h.

Referenced by computeError(), EdgeSE2Offset(), initialEstimate(), resolveCaches(), and setMeasurementFromState().

◆ _inverseMeasurement

SE2 g2o::EdgeSE2Offset::_inverseMeasurement

protected

Definition at line 88 of file edge_se2_offset.h.

Referenced by computeError(), setMeasurement(), and setMeasurementData().

◆ _offsetFrom

ParameterSE2Offset* g2o::EdgeSE2Offset::_offsetFrom

protected

Definition at line 90 of file edge_se2_offset.h.

Referenced by EdgeSE2Offset(), resolveCaches(), and write().

◆ _offsetTo

ParameterSE2Offset * g2o::EdgeSE2Offset::_offsetTo

protected

Definition at line 90 of file edge_se2_offset.h.

Referenced by EdgeSE2Offset(), resolveCaches(), and write().

◆ EIGEN_MAKE_ALIGNED_OPERATOR_NEW

g2o::EdgeSE2Offset::EIGEN_MAKE_ALIGNED_OPERATOR_NEW

Definition at line 46 of file edge_se2_offset.h.

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

/build/reproducible-path/g2o-0~20230806/g2o/types/slam2d/edge_se2_offset.h
/build/reproducible-path/g2o-0~20230806/g2o/types/slam2d/edge_se2_offset.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EdgeSE2Offset()

Member Function Documentation

◆ computeError()

◆ getMeasurementData()

◆ initialEstimate()

◆ initialEstimatePossible()

◆ measurementDimension()

◆ read()

◆ resolveCaches()

◆ setMeasurement()

◆ setMeasurementData()

◆ setMeasurementFromState()

◆ write()

Member Data Documentation

◆ _cacheFrom

◆ _cacheTo

◆ _inverseMeasurement

◆ _offsetFrom

◆ _offsetTo

◆ EIGEN_MAKE_ALIGNED_OPERATOR_NEW