prior for an XYZ vertex (VertexPointXYZ) More...

#include <edge_xyz_prior.h>

Inheritance diagram for g2o::EdgeXYZPrior:

[legend]

Collaboration diagram for g2o::EdgeXYZPrior:

[legend]

Public Member Functions
EIGEN_MAKE_ALIGNED_OPERATOR_NEW	EdgeXYZPrior ()

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	linearizeOplus ()

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 *)

Public Member Functions inherited from g2o::BaseUnaryEdge< 3, Vector3, VertexPointXYZ >
	BaseUnaryEdge ()

Public Member Functions inherited from g2o::BaseFixedSizedEdge< D, E, VertexTypes >
template<int VertexN>
constexpr std::enable_if< VertexXnType< VertexN >::Dimension!=-1, int >::type	vertexDimension () const

template<int VertexN>
std::enable_if< VertexXnType< VertexN >::Dimension==-1, int >::type	vertexDimension () const

template<int VertexN>
const VertexXnType< VertexN > *	vertexXn () const

template<int VertexN>
VertexXnType< VertexN > *	vertexXn ()

	BaseFixedSizedEdge ()

template<typename... CtorArgs>
OptimizableGraph::Vertex *	createVertex (int i, CtorArgs... args)
	create an instance of the Nth VertexType

virtual void	resize (size_t size)

template<std::size_t... Ints>
bool	allVerticesFixedNs (std::index_sequence< Ints... >) const

virtual bool	allVerticesFixed () const

virtual void	linearizeOplus (JacobianWorkspace &jacobianWorkspace)

template<std::size_t... Ints>
void	linearizeOplus_allocate (JacobianWorkspace &jacobianWorkspace, std::index_sequence< Ints... >)

template<std::size_t... Ints>
void	linearizeOplusNs (std::index_sequence< Ints... >)

template<int N>
void	linearizeOplusN ()

template<int N>
const std::tuple_element< N, std::tuple< JacobianType< D, VertexTypes::Dimension >... > >::type &	jacobianOplusXn () const

template<int N>
std::tuple_element< N, std::tuple< JacobianType< D, VertexTypes::Dimension >... > >::type &	jacobianOplusXn ()

virtual void	constructQuadraticForm ()

template<std::size_t... Ints>
void	constructQuadraticFormNs (const InformationType &omega, const ErrorVector &weightedError, std::index_sequence< Ints... >)

template<int N>
void	constructQuadraticFormN (const InformationType &omega, const ErrorVector &weightedError)

template<int N, typename AtOType >
void	constructOffDiagonalQuadraticFormMs (const AtOType &, std::index_sequence<>)

template<int N, std::size_t... Ints, typename AtOType >
void	constructOffDiagonalQuadraticFormMs (const AtOType &AtO, std::index_sequence< Ints... >)

template<int N, int M, typename AtOType >
void	constructOffDiagonalQuadraticFormM (const AtOType &AtO)

virtual void	mapHessianMemory (double *d, int i, int j, bool rowMajor)

template<std::size_t... Ints>
bool	allVerticesFixedNs (std::index_sequence< Ints... >) const

template<std::size_t... Ints>
void	constructQuadraticFormNs (const InformationType &omega, const ErrorVector &weightedError, std::index_sequence< Ints... >)

template<int N, typename AtOType >
void	constructOffDiagonalQuadraticFormMs (const AtOType &, std::index_sequence<>)

template<int N, std::size_t... Ints, typename AtOType >
void	constructOffDiagonalQuadraticFormMs (const AtOType &AtO, std::index_sequence< Ints... >)

template<int N, int M, typename AtOType >
void	constructOffDiagonalQuadraticFormM (const AtOType &AtO)

template<int N>
void	constructQuadraticFormN (const InformationType &omega, const ErrorVector &weightedError)

template<std::size_t... Ints>
void	linearizeOplus_allocate (JacobianWorkspace &jacobianWorkspace, std::index_sequence< Ints... >)

template<int N>
void	linearizeOplusN ()

template<std::size_t... Ints>
void	linearizeOplusNs (std::index_sequence< Ints... >)

Public Member Functions inherited from g2o::BaseEdge< D, E >
	BaseEdge ()

BaseEdge &	operator= (const BaseEdge &)=delete

	BaseEdge (const BaseEdge &)=delete

virtual	~BaseEdge ()

virtual double	chi2 () const

virtual const double *	errorData () const
	returns the error vector cached after calling the computeError;

virtual double *	errorData ()

const ErrorVector &	error () const

ErrorVector &	error ()

EIGEN_STRONG_INLINE const InformationType &	information () const
	information matrix of the constraint

EIGEN_STRONG_INLINE InformationType &	information ()

void	setInformation (const InformationType &information)

virtual const double *	informationData () const

virtual double *	informationData ()

EIGEN_STRONG_INLINE const Measurement &	measurement () const
	accessor functions for the measurement represented by the edge

virtual void	setMeasurement (const Measurement &m)

virtual int	rank () const

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

template<int Dim = D>
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)

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)

Additional Inherited Members
Public Types inherited from g2o::BaseUnaryEdge< 3, Vector3, VertexPointXYZ >
using	VertexXiType = VertexPointXYZ

Public Types inherited from g2o::BaseFixedSizedEdge< D, E, VertexTypes >
template<int N, typename... Types>
using	NthType = typename std::tuple_element< N, std::tuple< Types... > >::type

template<int VertexN>
using	VertexXnType = NthType< VertexN, VertexTypes... >
	The type of the N-th vertex.

typedef BaseEdge< D, E >::Measurement	Measurement

typedef BaseEdge< D, E >::ErrorVector	ErrorVector

typedef BaseEdge< D, E >::InformationType	InformationType

template<int EdgeDimension, int VertexDimension>
using	JacobianType = typename Eigen::Matrix< double, EdgeDimension, VertexDimension, EdgeDimension==1 ? Eigen::RowMajor :Eigen::ColMajor >::AlignedMapType

template<int DN, int DM>
using	HessianBlockType = Eigen::Map< Eigen::Matrix< double, DN, DM, DN==1 ? Eigen::RowMajor :Eigen::ColMajor >, Eigen::Matrix< double, DN, DM, DN==1 ? Eigen::RowMajor :Eigen::ColMajor >::Flags &Eigen::PacketAccessBit ? Eigen::Aligned :Eigen::Unaligned >
	it requires quite some ugly code to get the type of hessians...

template<int K>
using	HessianBlockTypeK = HessianBlockType< VertexXnType< internal::index_to_pair(K).first >::Dimension, VertexXnType< internal::index_to_pair(K).second >::Dimension >

template<int K>
using	HessianBlockTypeKTransposed = HessianBlockType< VertexXnType< internal::index_to_pair(K).second >::Dimension, VertexXnType< internal::index_to_pair(K).first >::Dimension >

using	HessianTuple = typename HessianTupleType< std::make_index_sequence< _nr_of_vertex_pairs > >::type

using	HessianTupleTransposed = typename HessianTupleType< std::make_index_sequence< _nr_of_vertex_pairs > >::typeTransposed

using	HessianRowMajorStorage = std::array< bool, _nr_of_vertex_pairs >

Public Types inherited from g2o::BaseEdge< D, E >
typedef E	Measurement

typedef internal::BaseEdgeTraits< D >::ErrorVector	ErrorVector

typedef internal::BaseEdgeTraits< D >::InformationType	InformationType

Static Public Member Functions inherited from g2o::BaseFixedSizedEdge< D, E, VertexTypes >
template<int VertexN>
static constexpr int	VertexDimension ()
	Size of the N-th vertex at compile time.

Static Public Attributes inherited from g2o::BaseFixedSizedEdge< D, E, VertexTypes >
static const int	Dimension = BaseEdge<D, E>::Dimension

static const std::size_t	_nr_of_vertices = sizeof...(VertexTypes)

static const std::size_t	_nr_of_vertex_pairs

Static Public Attributes inherited from g2o::BaseEdge< D, E >
static constexpr int	Dimension = internal::BaseEdgeTraits<D>::Dimension

Protected Member Functions inherited from g2o::BaseEdge< D, E >
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 ()

virtual bool	resolveCaches ()

Protected Attributes inherited from g2o::BaseUnaryEdge< 3, Vector3, VertexPointXYZ >
BaseFixedSizedEdge< D, Vector3, VertexPointXYZ >::template JacobianType< D, VertexXi::Dimension > &	_jacobianOplusXi

Protected Attributes inherited from g2o::BaseFixedSizedEdge< D, E, VertexTypes >
HessianRowMajorStorage	_hessianRowMajor

HessianTuple	_hessianTuple

HessianTupleTransposed	_hessianTupleTransposed

std::tuple< JacobianType< D, VertexTypes::Dimension >... >	_jacobianOplus

Protected Attributes inherited from g2o::BaseEdge< D, E >
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

Detailed Description

prior for an XYZ vertex (VertexPointXYZ)

Provides a prior for a 3d point vertex. The measurement is represented by a Vector3 with a corresponding 3x3 upper triangle covariance matrix (upper triangle only).

Definition at line 42 of file edge_xyz_prior.h.

Constructor & Destructor Documentation

◆ EdgeXYZPrior()

g2o::EdgeXYZPrior::EdgeXYZPrior ( )

Definition at line 34 of file edge_xyz_prior.cpp.

                           : BaseUnaryEdge<3, Vector3, VertexPointXYZ>() {
  information().setIdentity();
}

References g2o::BaseEdge< D, E >::information().

Member Function Documentation

◆ computeError()

void g2o::EdgeXYZPrior::computeError ( )

virtual

Implements g2o::OptimizableGraph::Edge.

Definition at line 48 of file edge_xyz_prior.cpp.

                                {
  const VertexPointXYZ* v = static_cast<const VertexPointXYZ*>(_vertices[0]);
  _error = v->estimate() - _measurement;
}

References g2o::BaseEdge< D, E >::_error, g2o::BaseEdge< D, E >::_measurement, g2o::HyperGraph::Edge::_vertices, and g2o::BaseVertex< D, T >::estimate().

◆ getMeasurementData()

virtual bool g2o::EdgeXYZPrior::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 61 of file edge_xyz_prior.h.

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

◆ initialEstimatePossible()

virtual double g2o::EdgeXYZPrior::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 71 of file edge_xyz_prior.h.

                                 {
    return 0;
  }

◆ linearizeOplus()

void g2o::EdgeXYZPrior::linearizeOplus ( )

virtual

Linearizes the oplus operator in the vertex, and stores the result in temporary variables _jacobianOplus

Reimplemented from g2o::BaseFixedSizedEdge< D, E, VertexTypes >.

Definition at line 53 of file edge_xyz_prior.cpp.

53{ _jacobianOplusXi = Matrix3::Identity(); }

g2o::BaseUnaryEdge< 3, Vector3, VertexPointXYZ >::_jacobianOplusXi

BaseFixedSizedEdge< D, Vector3, VertexPointXYZ >::template JacobianType< D, VertexXi::Dimension > & _jacobianOplusXi

Definition base_unary_edge.h:44

References g2o::BaseUnaryEdge< 3, Vector3, VertexPointXYZ >::_jacobianOplusXi.

◆ measurementDimension()

virtual int g2o::EdgeXYZPrior::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 67 of file edge_xyz_prior.h.

67{ return 3; }

◆ read()

bool g2o::EdgeXYZPrior::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 38 of file edge_xyz_prior.cpp.

                                      {
  internal::readVector(is, _measurement);
  return readInformationMatrix(is);
}

References g2o::BaseEdge< D, E >::_measurement, g2o::BaseEdge< D, E >::readInformationMatrix(), and g2o::internal::readVector().

◆ setMeasurementData()

virtual bool g2o::EdgeXYZPrior::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 55 of file edge_xyz_prior.h.

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

◆ setMeasurementFromState()

bool g2o::EdgeXYZPrior::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 55 of file edge_xyz_prior.cpp.

                                           {
  const VertexPointXYZ* v = static_cast<const VertexPointXYZ*>(_vertices[0]);
  _measurement = v->estimate();
  return true;
}

References g2o::BaseEdge< D, E >::_measurement, g2o::HyperGraph::Edge::_vertices, and g2o::BaseVertex< D, T >::estimate().

◆ write()

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

virtual

write the vertex to a stream

Implements g2o::OptimizableGraph::Edge.

Definition at line 43 of file edge_xyz_prior.cpp.

                                             {
  internal::writeVector(os, measurement());
  return writeInformationMatrix(os);
}

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

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

/build/reproducible-path/g2o-0~20230806/g2o/types/slam3d/edge_xyz_prior.h
/build/reproducible-path/g2o-0~20230806/g2o/types/slam3d/edge_xyz_prior.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EdgeXYZPrior()

Member Function Documentation

◆ computeError()

◆ getMeasurementData()

◆ initialEstimatePossible()

◆ linearizeOplus()

◆ measurementDimension()

◆ read()

◆ setMeasurementData()

◆ setMeasurementFromState()

◆ write()